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

Class SetBucketCrossOriginConfigurationRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class SetBucketCrossOriginConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable

Contains options for setting the cross origin configuration for a bucket.

See Also:

SetBucketCrossOriginConfigurationRequest(String, BucketCrossOriginConfiguration), Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
SetBucketCrossOriginConfigurationRequest(String bucketName, BucketCrossOriginConfiguration crossOriginConfiguration) Constructs a new SetBucketCrossOriginConfigurationRequest to set the bucket cross origin configuration of the specified bucket.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Gets the name of the bucket whose cross origin configuration is being set.
BucketCrossOriginConfiguration	getCrossOriginConfiguration() Gets the new cross origin configuration for the specified bucket.
void	setBucketName(String bucketName) Sets the name of the bucket whose cross origin configuration is being set.
void	setCrossOriginConfiguration(BucketCrossOriginConfiguration crossOriginConfiguration) Sets the new cross origin configuration for the specified bucket.
SetBucketCrossOriginConfigurationRequest	withBucketName(String bucketName) Sets the name of the bucket whose cross origin configuration is being set, and returns this object so that additional method calls may be chained together.
SetBucketCrossOriginConfigurationRequest	withCrossOriginConfiguration(BucketCrossOriginConfiguration crossOriginConfiguration) Sets the new cross origin configuration for the specified bucket and returns this object, enabling additional method calls to 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

SetBucketCrossOriginConfigurationRequest

public SetBucketCrossOriginConfigurationRequest(String bucketName,
                                                BucketCrossOriginConfiguration crossOriginConfiguration)

Constructs a new SetBucketCrossOriginConfigurationRequest to set the bucket cross origin configuration of the specified bucket.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucketName - The name of the bucket, or access point ARN, for which to set the cross origin configuration.

crossOriginConfiguration - The new cross origin configuration for this bucket, which completely replaces any existing configuration.

Method Detail

getBucketName

public String getBucketName()

Gets the name of the bucket whose cross origin configuration is being set.

Returns:

The name of the bucket whose cross origin configuration is being set.

See Also:

SetBucketCrossOriginConfigurationRequest.setBucketName(String)

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket whose cross origin configuration is being set.

Parameters:

bucketName - The name of the bucket, or access point ARN, whose cross origin configuration is being set.

See Also:

SetBucketCrossOriginConfigurationRequest.getBucketName()

withBucketName

public SetBucketCrossOriginConfigurationRequest withBucketName(String bucketName)

Sets the name of the bucket whose cross origin configuration is being set, and returns this object so that additional method calls may be chained together.

Parameters:

bucketName - The name of the bucket, or access point ARN, whose cross origin configuration is being set.

Returns:

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

See Also:

SetBucketCrossOriginConfigurationRequest.setBucketName(String)

getCrossOriginConfiguration

public BucketCrossOriginConfiguration getCrossOriginConfiguration()

Gets the new cross origin configuration for the specified bucket.

Returns:

The new cross origin configuration for the specified bucket.

See Also:

SetBucketCrossOriginConfigurationRequest.setCrossOriginConfiguration(BucketCrossOriginConfiguration), SetBucketCrossOriginConfigurationRequest.withCrossOriginConfiguration(BucketCrossOriginConfiguration)

setCrossOriginConfiguration

public void setCrossOriginConfiguration(BucketCrossOriginConfiguration crossOriginConfiguration)

Sets the new cross origin configuration for the specified bucket.

Parameters:

crossOriginConfiguration - The new cross origin configuration for the specified bucket.

See Also:

SetBucketCrossOriginConfigurationRequest.getCrossOriginConfiguration(), SetBucketCrossOriginConfigurationRequest.withCrossOriginConfiguration(BucketCrossOriginConfiguration)

withCrossOriginConfiguration

public SetBucketCrossOriginConfigurationRequest withCrossOriginConfiguration(BucketCrossOriginConfiguration crossOriginConfiguration)

Sets the new cross origin configuration for the specified bucket and returns this object, enabling additional method calls to be chained together.

Parameters:

crossOriginConfiguration - The new cross origin configuration for the specified bucket.

Returns:

This SetBucketCrossOriginConfigurationRequest object, enabling that additional method calls may be chained together.

See Also:

SetBucketCrossOriginConfigurationRequest.getCrossOriginConfiguration()