com.amazonaws.services.s3.model

Class BucketAccelerateConfiguration

java.lang.Object

com.amazonaws.services.s3.model.BucketAccelerateConfiguration

All Implemented Interfaces:

S3RequesterChargedResult, Serializable

public class BucketAccelerateConfiguration
extends Object
implements Serializable, S3RequesterChargedResult

Represents the accelerate configuration for a bucket.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BucketAccelerateConfiguration(BucketAccelerateStatus status) Creates a new bucket accelerate configuration object with the specified status.
BucketAccelerateConfiguration(String status) Creates a new bucket accelerate configuration object with the specified status.

Method Summary

Modifier and Type	Method and Description
String	getStatus()
boolean	isAccelerateEnabled() A convenience method that returns whether the bucket is enabled accelerate mode.
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setRequesterCharged(boolean isRequesterCharged) Used for conducting this operation from a Requester Pays Bucket.
void	setStatus(BucketAccelerateStatus status) Sets the desired bucket accelerate status for this configuration object.
void	setStatus(String status) Sets the desired bucket accelerate status for this configuration object.
BucketAccelerateConfiguration	withStatus(BucketAccelerateStatus status)
BucketAccelerateConfiguration	withStatus(String status) Fluent setter method for setStatus(String)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketAccelerateConfiguration

public BucketAccelerateConfiguration(String status)

Creates a new bucket accelerate configuration object with the specified status.

Parameters:

status - The desired bucket accelerate status for the new configuration object. See BucketAccelerateStatus for a list of valid values.

BucketAccelerateConfiguration

public BucketAccelerateConfiguration(BucketAccelerateStatus status)

Creates a new bucket accelerate configuration object with the specified status.

Parameters:

status - The desired bucket accelerate status for the new configuration object. See BucketAccelerateStatus for a list of valid values.

Method Detail

getStatus

public String getStatus()

Returns:

The current status of the accelerate configuration for this bucket, or null if the bucket has never been enabled or suspended accelerate configuration.

setStatus

public void setStatus(String status)

Sets the desired bucket accelerate status for this configuration object.

Parameters:

status - The desired bucket accelerate status for this configuration object. See BucketAccelerateStatus for a list of valid values.

setStatus

public void setStatus(BucketAccelerateStatus status)

Sets the desired bucket accelerate status for this configuration object.

Parameters:

status - The desired bucket accelerate status for this configuration object. See BucketAccelerateStatus for a list of valid values.

withStatus

public BucketAccelerateConfiguration withStatus(String status)

Fluent setter method for setStatus(String)

Returns:

This BucketAccelerateConfiguration object so that additional method calls may be chained together.

See Also:

setStatus(String)

withStatus

public BucketAccelerateConfiguration withStatus(BucketAccelerateStatus status)

isAccelerateEnabled

public boolean isAccelerateEnabled()

A convenience method that returns whether the bucket is enabled accelerate mode.

Returns:

True if the accelerate configuration has the BucketAccelerateStatus.Enabled status.

isRequesterCharged

public boolean isRequesterCharged()

Description copied from interface: S3RequesterChargedResult

Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.

If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket

Specified by:

isRequesterCharged in interface S3RequesterChargedResult

Returns:

true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

setRequesterCharged

public void setRequesterCharged(boolean isRequesterCharged)

Description copied from interface: S3RequesterChargedResult

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for conducting the operation from the bucket.

If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Specified by:

setRequesterCharged in interface S3RequesterChargedResult

Parameters:

isRequesterCharged - Indicates requester is charged for this operation.