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

Class DeleteLegalHoldRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class DeleteLegalHoldRequest
extends AmazonWebServiceRequest
implements Serializable

Request object containing all the options for deleting a legal hold from an object.

See Also:

Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket containing the reference to the object to delete a legal hold from.
String	getKey() Gets the key, the name of the reference to the object to delete a legal hold from.
String	getLegalHoldId() Returns the legal hold id to be deleted.
void	setBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to delete a legal hold from.
void	setKey(String key) Sets the key, the name of the reference to the object to delete a legal hold from.
void	setLegalHoldId(String legalHoldId) Sets the legal hold id to be deleted.
DeleteLegalHoldRequest	withBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to delete a legal hold from, and returns a reference to this object(DeleteLegalHoldRequest) for method chaining.
DeleteLegalHoldRequest	withKey(String key) Sets the key, the name of the reference to the object to delete a legal hold from.
DeleteLegalHoldRequest	withLegalHoldId(String legalHoldId) Sets the legal hold id to be deleted 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

DeleteLegalHoldRequest

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

Constructs a new DeleteLegalHoldRequest.

Parameters:

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

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

legalHoldId - The id of the legal hold to delete.

Method Detail

getBucketName

public String getBucketName()

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

See Also:

DeleteLegalHoldRequest.setBucketName(String), DeleteLegalHoldRequest.withBucketName(String)

withBucketName

public DeleteLegalHoldRequest withBucketName(String bucketName)

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

See Also:

DeleteLegalHoldRequest.setBucketName(String), DeleteLegalHoldRequest.getBucketName()

setBucketName

public void setBucketName(String bucketName)

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

See Also:

DeleteLegalHoldRequest.getBucketName(), DeleteLegalHoldRequest.withBucketName(String)

getKey

public String getKey()

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

See Also:

DeleteLegalHoldRequest.setKey(String), DeleteLegalHoldRequest.withKey(String)

setKey

public void setKey(String key)

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

See Also:

DeleteLegalHoldRequest.getKey(), DeleteLegalHoldRequest.withKey(String)

withKey

public DeleteLegalHoldRequest withKey(String key)

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

See Also:

DeleteLegalHoldRequest.getKey(), DeleteLegalHoldRequest.setKey(String)

getLegalHoldId

public String getLegalHoldId()

Returns the legal hold id to be deleted.

setLegalHoldId

public void setLegalHoldId(String legalHoldId)

Sets the legal hold id to be deleted.

withLegalHoldId

public DeleteLegalHoldRequest withLegalHoldId(String legalHoldId)

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