com.ibm.cloud.objectstorage.services.s3.model

Class ReplicationRule

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.ReplicationRule

All Implemented Interfaces:

Serializable

public class ReplicationRule
extends Object
implements Serializable

Rule that specifies the replication configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReplicationRule()

Method Summary

Modifier and Type	Method and Description
DeleteMarkerReplication	getDeleteMarkerReplication() Returns the status of delete marker replication of current rule.
ReplicationDestinationConfig	getDestinationConfig() Returns the destination configuration for the replication rule.
ReplicationFilter	getFilter() Returns a ReplicationFilter that is used to identify objects that a CRR Rule applies to.
String	getPrefix() Returns the prefix associated with the replication rule.
Integer	getPriority() Returns the priority of current rule.
String	getStatus() Returns the status of the replication rule.
void	setDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication) Sets the status of delete marker replication of the current rule.
void	setDestinationConfig(ReplicationDestinationConfig destinationConfig) Sets the destination configuration for the replication rule.
void	setFilter(ReplicationFilter filter) Sets the ReplicationFilter that is used to identify objects that a CRR Rule applies to.
void	setPrefix(String prefix) Sets the Amazon S3 Object prefix for the replication rule.
void	setPriority(Integer priority) Set the priority of current rule.
void	setStatus(ReplicationRuleStatus status) Sets the status of this replication rule.
void	setStatus(String status) Sets the status of this replication rule.
String	toString() Fluent method to set the ExistingObjectReplication that is indicate if existing objects are replicated in Replication configuration V2.
ReplicationRule	withDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication) Fluent method to set the DeleteMarkerReplication that is indicate if delete markers have or don't have to be replicated in Replication configuration V2.
ReplicationRule	withDestinationConfig(ReplicationDestinationConfig destinationConfig) Sets the destination configuration for the replication rule.Returns the updated object.
ReplicationRule	withFilter(ReplicationFilter filter) Fluent method to set the ReplicationFilter that is used to identify objects that a CRR Rule applies to.
ReplicationRule	withPrefix(String prefix) Sets the Amazon S3 Object prefix for the replication rule.
ReplicationRule	withPriority(Integer priority) Set the priority of current rule.
ReplicationRule	withStatus(ReplicationRuleStatus status) Sets the status of this replication rule.
ReplicationRule	withStatus(String status) Sets the status of this replication rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplicationRule

public ReplicationRule()

Method Detail

getPriority

public Integer getPriority()

Returns the priority of current rule.

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon Simple Storage Service Developer Guide.

Returns:

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon Simple Storage Service Developer Guide.

setPriority

public void setPriority(Integer priority)

Set the priority of current rule.

Priority must be unique in a configuration (you cannot have two different rules with the same priority). attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon Simple Storage Service Developer Guide.

Parameters:

priority - int

withPriority

public ReplicationRule withPriority(Integer priority)

Set the priority of current rule.

Priority must be unique in a configuration (you cannot have two different rules with the same priority). attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon Simple Storage Service Developer Guide.

Parameters:

priority - int

Returns:

This object for method chaining.

getDeleteMarkerReplication

public DeleteMarkerReplication getDeleteMarkerReplication()

Returns the status of delete marker replication of current rule.

setDeleteMarkerReplication

public void setDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)

Sets the status of delete marker replication of the current rule.

Parameters:

deleteMarkerReplication - Status of delete markers replication.

withDeleteMarkerReplication

public ReplicationRule withDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)

Fluent method to set the DeleteMarkerReplication that is indicate if delete markers have or don't have to be replicated in Replication configuration V2.

Parameters:

deleteMarkerReplication - Status of delete markers replication.

Returns:

This object for method chaining.

getPrefix

public String getPrefix()

Returns the prefix associated with the replication rule.

setPrefix

public void setPrefix(String prefix)

Sets the Amazon S3 Object prefix for the replication rule.

Throws:

IllegalArgumentException - if the prefix is null.

withPrefix

public ReplicationRule withPrefix(String prefix)

Sets the Amazon S3 Object prefix for the replication rule. Returns the updated object.

Returns:

the updated ReplicationRule object.

Throws:

IllegalArgumentException - if the prefix is null.

getFilter

public ReplicationFilter getFilter()

Returns a ReplicationFilter that is used to identify objects that a CRR Rule applies to.

setFilter

public void setFilter(ReplicationFilter filter)

Sets the ReplicationFilter that is used to identify objects that a CRR Rule applies to. A rule cannot have both ReplicationFilter and the deprecated ReplicationRule.prefix.

Parameters:

filter - ReplicationFilter

withFilter

public ReplicationRule withFilter(ReplicationFilter filter)

Fluent method to set the ReplicationFilter that is used to identify objects that a CRR Rule applies to. A rule cannot have both ReplicationFilter and the deprecated ReplicationRule.prefix.

Parameters:

filter - ReplicationFilter

Returns:

This object for method chaining.

getStatus

public String getStatus()

Returns the status of the replication rule.

setStatus

public void setStatus(String status)

Sets the status of this replication rule. Valid values are Enabled, Disabled. The rule will be applied only if the status is Enabled.

Parameters:

status - the status of the replication rule.

withStatus

public ReplicationRule withStatus(String status)

Sets the status of this replication rule. Valid values are Enabled, Disabled. The rule will be applied only if the status is Enabled.

Parameters:

status - the status of replication rule.

Returns:

the updated ReplicationRule object.

setStatus

public void setStatus(ReplicationRuleStatus status)

Sets the status of this replication rule. Valid values are Enabled, Disabled. The rule will be applied only if the status is Enabled.

Parameters:

status - the status of the replication rule.

withStatus

public ReplicationRule withStatus(ReplicationRuleStatus status)

Sets the status of this replication rule. Valid values are Enabled, Disabled. The rule will be applied only if the status is Enabled.

Parameters:

status - the status of replication rule.

Returns:

the updated ReplicationRule object.

getDestinationConfig

public ReplicationDestinationConfig getDestinationConfig()

Returns the destination configuration for the replication rule.

setDestinationConfig

public void setDestinationConfig(ReplicationDestinationConfig destinationConfig)

Sets the destination configuration for the replication rule.

Throws:

IllegalArgumentException - if the destinationConfig is null.

withDestinationConfig

public ReplicationRule withDestinationConfig(ReplicationDestinationConfig destinationConfig)

Sets the destination configuration for the replication rule.Returns the updated object.

Returns:

the updated ReplicationRule object.

Throws:

IllegalArgumentException - if the destinationConfig is null.

toString

public String toString()

Fluent method to set the ExistingObjectReplication that is indicate if existing objects are replicated in Replication configuration V2.

Overrides:

toString in class Object

Parameters:

existingObjectReplication - Status of existing object replication.

Returns:

This object for method chaining.