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

Class GetBucketMetricsConfigurationRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class GetBucketMetricsConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Request object to retrieve metrics configuration from a bucket.

See Also:

Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
GetBucketMetricsConfigurationRequest()
GetBucketMetricsConfigurationRequest(String bucketName, String id)

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket containing the metrics configuration to retrieve.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
String	getId() Returns the ID used to identify the metrics configuration.
void	setBucketName(String bucketName) Sets the name of the bucket containing the metrics configuration to retrieve.
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
void	setId(String id) Sets the ID used to identify the metrics configuration.
GetBucketMetricsConfigurationRequest	withBucketName(String bucketName) Sets the name of the bucket containing the metrics configuration to retrieve and returns this object for method chaining.
GetBucketMetricsConfigurationRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
GetBucketMetricsConfigurationRequest	withId(String id) Sets the ID used to identify the metrics configuration and returns GetBucketMetricsConfigurationRequest 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

GetBucketMetricsConfigurationRequest

public GetBucketMetricsConfigurationRequest()

GetBucketMetricsConfigurationRequest

public GetBucketMetricsConfigurationRequest(String bucketName,
                                            String id)

Method Detail

getExpectedBucketOwner

public String getExpectedBucketOwner()

Description copied from interface: ExpectedBucketOwnerRequest

Returns he account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

getExpectedBucketOwner in interface ExpectedBucketOwnerRequest

withExpectedBucketOwner

public GetBucketMetricsConfigurationRequest withExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

withExpectedBucketOwner in interface ExpectedBucketOwnerRequest

setExpectedBucketOwner

public void setExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

setExpectedBucketOwner in interface ExpectedBucketOwnerRequest

getBucketName

public String getBucketName()

Returns the name of the bucket containing the metrics configuration to retrieve.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket containing the metrics configuration to retrieve.

withBucketName

public GetBucketMetricsConfigurationRequest withBucketName(String bucketName)

Sets the name of the bucket containing the metrics configuration to retrieve and returns this object for method chaining.

getId

public String getId()

Returns the ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

setId

public void setId(String id)

Sets the ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

withId

public GetBucketMetricsConfigurationRequest withId(String id)

Sets the ID used to identify the metrics configuration and returns GetBucketMetricsConfigurationRequest object for method chaining. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.