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

Class ListBucketReplicationFailuresRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class ListBucketReplicationFailuresRequest
extends AmazonWebServiceRequest
implements Serializable

See Also:

Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
ListBucketReplicationFailuresRequest() Creates a new ListBucketReplicationFailuresRequest.
ListBucketReplicationFailuresRequest(String bucketName) Creates a new ListBucketReplicationFailuresRequest.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of Amazon S3 bucket.
String	getContinuationToken() Gets the optional continuation token.
String	getEncodingType() Gets the optional encodingType parameter indicating the encoding method to be applied on the response.
String	getFirstSyncAttemptedBefore() Returns optional parameter indicating where you want Amazon S3 to start the object listing from.
Integer	getMaxKeys() Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
void	setBucketName(String bucketName) Sets the name of Amazon S3 bucket for replication configuration.
void	setContinuationToken(String continuationToken) Sets the optional continuation token.
void	setEncodingType(String encodingType) Sets the optional encodingType parameter indicating the encoding method to be applied on the response.
void	setFirstSyncAttemptedBefore(String firstSyncAttemptedBefore) Sets the optional parameter indicating where you want Amazon S3 to start the object listing from.
void	setMaxKeys(Integer maxKeys) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
String	toString()
ListBucketReplicationFailuresRequest	withBucketName(String bucketName) Sets the name of Amazon S3 bucket for replication configuration.
ListBucketReplicationFailuresRequest	withContinuationToken(String continuationToken) Sets the optional continuation token.
ListBucketReplicationFailuresRequest	withEncodingType(String encodingType) Sets the optional encodingType parameter indicating the encoding method to be applied on the response.
ListBucketReplicationFailuresRequest	withFirstSyncAttemptedBefore(String firstSyncAttemptedBefore) Sets the optional parameter indicating where you want Amazon S3 to start the object listing from.
ListBucketReplicationFailuresRequest	withMaxKeys(Integer maxKeys) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.

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, wait, wait, wait

Constructor Detail

ListBucketReplicationFailuresRequest

public ListBucketReplicationFailuresRequest()

Creates a new ListBucketReplicationFailuresRequest.

ListBucketReplicationFailuresRequest

public ListBucketReplicationFailuresRequest(String bucketName)

Creates a new ListBucketReplicationFailuresRequest.

Parameters:

bucketName - The name of Amazon S3 bucket to which the replication configuration is set.

Method Detail

getBucketName

public String getBucketName()

Returns the name of Amazon S3 bucket.

setBucketName

public void setBucketName(String bucketName)

Sets the name of Amazon S3 bucket for replication configuration.

Parameters:

bucketName - The name of Amazon S3 bucket to which the replication configuration is set.

withBucketName

public ListBucketReplicationFailuresRequest withBucketName(String bucketName)

Sets the name of Amazon S3 bucket for replication configuration. Returns the updated object. .

Parameters:

bucketName - The name of Amazon S3 bucket to which the replication configuration is set.

Returns:

The updated ListBucketReplicationFailuresRequest object.

getContinuationToken

public String getContinuationToken()

Gets the optional continuation token. Continuation token allows a list to be continued from a specific point. ContinuationToken is provided in truncated list results.

Returns:

The optional continuation token associated with this request.

setContinuationToken

public void setContinuationToken(String continuationToken)

Sets the optional continuation token. Continuation token allows a list to be continued from a specific point. ContinuationToken is provided in truncated list results.

Parameters:

continuationToken - The optional continuation token to associate with this request.

withContinuationToken

public ListBucketReplicationFailuresRequest withContinuationToken(String continuationToken)

Sets the optional continuation token. Continuation token allows a list to be continued from a specific point. ContinuationToken is provided in truncated list results.

Parameters:

continuationToken - The optional continuation token to associate with this request.

Returns:

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

getMaxKeys

public Integer getMaxKeys()

Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response. COS S3 might return fewer keys than specified, but will never return more.

Returns:

The optional parameter indicating the maximum number of keys to include in the response.

setMaxKeys

public void setMaxKeys(Integer maxKeys)

Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.

Parameters:

maxKeys - The optional parameter indicating the maximum number of keys to include in the response.

withMaxKeys

public ListBucketReplicationFailuresRequest withMaxKeys(Integer maxKeys)

Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response. Returns this ListBucketReplicationFailuresRequest, enabling additional method calls to be chained together.

Parameters:

maxKeys - The optional parameter indicating the maximum number of keys to include in the response.

Returns:

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

getFirstSyncAttemptedBefore

public String getFirstSyncAttemptedBefore()

Returns optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.

Returns:

the optional firstSyncAttemptedBefore parameter

setFirstSyncAttemptedBefore

public void setFirstSyncAttemptedBefore(String firstSyncAttemptedBefore)

Sets the optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.

Parameters:

firstSyncAttemptedBefore - The optional firstSyncAttemptedBefore parameter. This can be any key in the bucket.

withFirstSyncAttemptedBefore

public ListBucketReplicationFailuresRequest withFirstSyncAttemptedBefore(String firstSyncAttemptedBefore)

Sets the optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.

Parameters:

firstSyncAttemptedBefore - The optional firstSyncAttemptedBefore parameter. This can be any key in the bucket.

Returns:

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

getEncodingType

public String getEncodingType()

Gets the optional encodingType parameter indicating the encoding method to be applied on the response.

Returns:

The encoding method to be applied on the response.

setEncodingType

public void setEncodingType(String encodingType)

Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Parameters:

encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".

withEncodingType

public ListBucketReplicationFailuresRequest withEncodingType(String encodingType)

Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Returns this ListBucketReplicationFailuresRequest, enabling additional method calls to be chained together.

Parameters:

encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".

toString

public String toString()

Overrides:

toString in class Object