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

Class ListBucketReplicationFailuresResult

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class ListBucketReplicationFailuresResult
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
ListBucketReplicationFailuresResult() Creates a new ListBucketReplicationFailuresResult.
ListBucketReplicationFailuresResult(String bucketName) Creates a new ListBucketReplicationFailuresResult.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of Amazon S3 bucket.
List<ContentList>	getContents() Returns the list of ContentList objects representing failed replications.
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.
boolean	getIsTruncated() Get whether or not the results are truncated.
Integer	getKeyCount() KeyCount is the number of keys returned with this request.
Integer	getMaxKeys() Gets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
String	getNextContinuationToken() Gets the optional next continuation token.
void	setBucketName(String bucketName) Sets the name of Amazon S3 bucket has the bucket replication failures.
void	setContents(List<ContentList> contents) Sets the list of ContentList objects representing failed replications.
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	setIsTruncated(Boolean isTruncated)
void	setKeyCount(Integer keyCount) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
void	setMaxKeys(Integer maxKeys) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
void	setNextContinuationToken(String nextContinuationToken) Sets the optional next continuation token.
String	toString()
ListBucketReplicationFailuresResult	withBucketName(String bucketName) Sets the name of Amazon S3 bucket that has the bucket replication failures.
ListBucketReplicationFailuresResult	withContent(ContentList content) Adds a ContentList item to the list.
ListBucketReplicationFailuresResult	withContinuationToken(String continuationToken) Sets the optional continuation token.
ListBucketReplicationFailuresResult	withEncodingType(String encodingType) Sets the optional encodingType parameter indicating the encoding method to be applied on the response.
ListBucketReplicationFailuresResult	withFirstSyncAttemptedBefore(String firstSyncAttemptedBefore) Sets the optional parameter indicating where you want Amazon S3 to start the object listing from.
ListBucketReplicationFailuresResult	withIsTruncated(Boolean isTruncated)
ListBucketReplicationFailuresResult	withMaxKeys(Integer maxKeys) Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response.
ListBucketReplicationFailuresResult	withNextContinuationToken(String nextContinuationToken) Sets the optional next continuation token.
ListBucketReplicationFailuresResult	withSetKeyCount(Integer keyCount) 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

ListBucketReplicationFailuresResult

public ListBucketReplicationFailuresResult()

Creates a new ListBucketReplicationFailuresResult.

ListBucketReplicationFailuresResult

public ListBucketReplicationFailuresResult(String bucketName)

Creates a new ListBucketReplicationFailuresResult.

Parameters:

name - The name of Amazon S3 bucket to which has the bucket replication failures..

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 has the bucket replication failures.

Parameters:

name - The name of Amazon S3 bucket to which has the bucket replication failures.

withBucketName

public ListBucketReplicationFailuresResult withBucketName(String bucketName)

Sets the name of Amazon S3 bucket that has the bucket replication failures.

Parameters:

name - The name of Amazon S3 bucket to which has the bucket replication failures.

Returns:

The updated ListBucketReplicationFailuresResult 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 ListBucketReplicationFailuresResult 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:

getIsTruncated

public boolean getIsTruncated()

Get whether or not the results are truncated.

setIsTruncated

public void setIsTruncated(Boolean isTruncated)

Parameters:

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

withIsTruncated

public ListBucketReplicationFailuresResult withIsTruncated(Boolean isTruncated)

Parameters:

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

Returns:

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 ListBucketReplicationFailuresResult withMaxKeys(Integer maxKeys)

Sets the optional maxKeys parameter indicating the maximum number of keys to include in the response. Returns this ListBucketReplicationFailuresResult, 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 ListBucketReplicationFailuresResult, 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 ListBucketReplicationFailuresResult 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 ListBucketReplicationFailuresResult, 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 ListBucketReplicationFailuresResult 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 ListBucketReplicationFailuresResult, 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".

getKeyCount

public Integer getKeyCount()

KeyCount is the number of keys returned with this request. It will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

Returns:

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

setKeyCount

public void setKeyCount(Integer keyCount)

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

Parameters:

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

withSetKeyCount

public ListBucketReplicationFailuresResult withSetKeyCount(Integer keyCount)

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

Parameters:

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

Returns:

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

getNextContinuationToken

public String getNextContinuationToken()

Gets the optional next continuation token.

Returns:

setNextContinuationToken

public void setNextContinuationToken(String nextContinuationToken)

Sets the optional next continuation token.

Parameters:

nextContinuationToken -

withNextContinuationToken

public ListBucketReplicationFailuresResult withNextContinuationToken(String nextContinuationToken)

Sets the optional next continuation token.

Parameters:

nextContinuationToken -

Returns:

getContents

public List<ContentList> getContents()

Returns the list of ContentList objects representing failed replications.

setContents

public void setContents(List<ContentList> contents)

Sets the list of ContentList objects representing failed replications.

withContent

public ListBucketReplicationFailuresResult withContent(ContentList content)

Adds a ContentList item to the list.

toString

public String toString()

Overrides:

toString in class Object