com.amazonaws.services.s3control.model

Class S3Retention

java.lang.Object

com.amazonaws.services.s3control.model.S3Retention

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3Retention
extends Object
implements Serializable, Cloneable

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3Retention()

Method Summary

Modifier and Type	Method and Description
S3Retention	clone()
boolean	equals(Object obj)
String	getMode() The Object Lock retention mode to be applied to all objects in the Batch Operations job.
Date	getRetainUntilDate() The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
int	hashCode()
void	setMode(String mode) The Object Lock retention mode to be applied to all objects in the Batch Operations job.
void	setRetainUntilDate(Date retainUntilDate) The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
String	toString() Returns a string representation of this object.
S3Retention	withMode(S3ObjectLockRetentionMode mode) The Object Lock retention mode to be applied to all objects in the Batch Operations job.
S3Retention	withMode(String mode) The Object Lock retention mode to be applied to all objects in the Batch Operations job.
S3Retention	withRetainUntilDate(Date retainUntilDate) The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

S3Retention

public S3Retention()

Method Detail

setRetainUntilDate

public void setRetainUntilDate(Date retainUntilDate)

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Parameters:

retainUntilDate - The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

getRetainUntilDate

public Date getRetainUntilDate()

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Returns:

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

withRetainUntilDate

public S3Retention withRetainUntilDate(Date retainUntilDate)

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Parameters:

retainUntilDate - The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMode

public void setMode(String mode)

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Parameters:

mode - The Object Lock retention mode to be applied to all objects in the Batch Operations job.

See Also:

S3ObjectLockRetentionMode

getMode

public String getMode()

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Returns:

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

See Also:

S3ObjectLockRetentionMode

withMode

public S3Retention withMode(String mode)

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Parameters:

mode - The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

S3ObjectLockRetentionMode

withMode

public S3Retention withMode(S3ObjectLockRetentionMode mode)

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Parameters:

mode - The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

S3ObjectLockRetentionMode

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public S3Retention clone()

Overrides:

clone in class Object