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

Class AddLegalHoldRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class AddLegalHoldRequest
extends AmazonWebServiceRequest
implements Serializable

Request object containing all the options for adding a legal hold to an object.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AddLegalHoldRequest(String bucketName, String key, String legalHoldId) Constructs a new AddLegalHoldRequest.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket containing the reference to the object to add a legal hold to.
String	getKey() Gets the key, the name of the reference to the object to add a legal hold to.
String	getLegalHoldId() Returns the legal hold id to be added.
void	setBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to add a legal hold to.
void	setKey(String key) Sets the key, the name of the reference to the object to add a legal hold to.
void	setLegalHoldId(String legalHoldId) Sets the legal hold id to be added.
AddLegalHoldRequest	withBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to add a legal hold to, and returns a reference to this object(AddLegalHoldRequest) for method chaining.
AddLegalHoldRequest	withKey(String key) Sets the key, the name of the reference to the object to add a legal hold to.
AddLegalHoldRequest	withLegalHoldId(String legalHoldId) Sets the legal hold id to be added and returns a reference to this object for method chaining.

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

AddLegalHoldRequest

public AddLegalHoldRequest(String bucketName,
                           String key,
                           String legalHoldId)

Constructs a new AddLegalHoldRequest.

Parameters:

bucketName - The name of the bucket containing the reference to the object to add a legal hold to.

key - The key, the name of the reference to the object to add a legal hold to.

legalHoldId - The id of the legal hold to add.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket containing the reference to the object to add a legal hold to.

See Also:

AddLegalHoldRequest.setBucketName(String), AddLegalHoldRequest.withBucketName(String)

withBucketName

public AddLegalHoldRequest withBucketName(String bucketName)

Sets the name of the bucket containing the reference to the object to add a legal hold to, and returns a reference to this object(AddLegalHoldRequest) for method chaining.

See Also:

AddLegalHoldRequest.setBucketName(String), AddLegalHoldRequest.getBucketName()

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket containing the reference to the object to add a legal hold to.

See Also:

AddLegalHoldRequest.getBucketName(), AddLegalHoldRequest.withBucketName(String)

getKey

public String getKey()

Gets the key, the name of the reference to the object to add a legal hold to.

See Also:

AddLegalHoldRequest.setKey(String), AddLegalHoldRequest.withKey(String)

setKey

public void setKey(String key)

Sets the key, the name of the reference to the object to add a legal hold to.

See Also:

AddLegalHoldRequest.getKey(), AddLegalHoldRequest.withKey(String)

withKey

public AddLegalHoldRequest withKey(String key)

Sets the key, the name of the reference to the object to add a legal hold to. Returns a reference to this object(AddLegalHoldRequest) for method chaining.

See Also:

AddLegalHoldRequest.getKey(), AddLegalHoldRequest.setKey(String)

getLegalHoldId

public String getLegalHoldId()

Returns the legal hold id to be added.

setLegalHoldId

public void setLegalHoldId(String legalHoldId)

Sets the legal hold id to be added.

withLegalHoldId

public AddLegalHoldRequest withLegalHoldId(String legalHoldId)

Sets the legal hold id to be added and returns a reference to this object for method chaining.