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

Class ListLegalHoldsRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, WormMirrorDestinationProvider, Serializable, Cloneable

public class ListLegalHoldsRequest
extends AmazonWebServiceRequest
implements WormMirrorDestinationProvider, Serializable

Request object containing all the options for requesting an object's legal holds.

See Also:

Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
ListLegalHoldsRequest(String bucketName, String key) Constructs a new ListLegalHoldsRequest object.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket which contains the specified object.
String	getKey() Returns the name of the object to perform the list against.
String	getWormMirrorDestination() Returns the optional mirror-destination value for WORM mirroring
void	setWormMirrorDestination(String wormMirrorDestination) Sets the optional mirror-destination value for WORM mirroring
ListLegalHoldsRequest	withWormMirrorDestination(String wormMirrorDestination) Sets the optional mirror-destination value for WORM mirroring and returns the updated ListLegalHoldsRequest so that additional method calls may be chained together.

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

ListLegalHoldsRequest

public ListLegalHoldsRequest(String bucketName,
                             String key)

Constructs a new ListLegalHoldsRequest object.

Parameters:

bucketName - The name of the bucket which contains the specified object.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket which contains the specified object.

Returns:

The name of the bucket which contains the specified object.

getKey

public String getKey()

Returns the name of the object to perform the list against.

Returns:

The name of the object to perform the list against.

getWormMirrorDestination

public String getWormMirrorDestination()

Returns the optional mirror-destination value for WORM mirroring

Specified by:

getWormMirrorDestination in interface WormMirrorDestinationProvider

Returns:

The optional mirror-destination value

setWormMirrorDestination

public void setWormMirrorDestination(String wormMirrorDestination)

Sets the optional mirror-destination value for WORM mirroring

Specified by:

setWormMirrorDestination in interface WormMirrorDestinationProvider

Parameters:

wormMirrorDestination - The optional mirror-destination value for WORM mirroring

withWormMirrorDestination

public ListLegalHoldsRequest withWormMirrorDestination(String wormMirrorDestination)

Sets the optional mirror-destination value for WORM mirroring and returns the updated ListLegalHoldsRequest so that additional method calls may be chained together.

Parameters:

wormMirrorDestination - The optional mirror-destination value for WORM mirroring

Returns:

This ListLegalHoldsRequest, enabling additional method calls to be chained together.