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

Class SetBucketPolicyRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class SetBucketPolicyRequest
extends AmazonWebServiceRequest
implements Serializable

Sets the policy associated with the specified bucket. Only the owner of the bucket can set a bucket policy. If a policy already exists for the specified bucket, the new policy replaces the existing policy.

Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources. Only one policy can be specified per-bucket.

See the Amazon S3 User Guide for more information on forming bucket polices.

See Also:

AmazonS3#setBucketPolicy(SetBucketPolicyRequest), Serialized Form

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
SetBucketPolicyRequest()
SetBucketPolicyRequest(String bucketName, String policyText) Creates a new request object, ready to be executed to set an Amazon S3 bucket's policy.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the Amazon S3 bucket whose policy is being set.
String	getPolicyText() Returns the policy to apply to the specified bucket.
void	setBucketName(String bucketName) Sets the name of the Amazon S3 bucket whose policy is being set.
void	setPolicyText(String policyText) Sets the policy to apply to the specified bucket.
SetBucketPolicyRequest	withBucketName(String bucketName) Sets the name of the Amazon S3 bucket whose policy is being set, and returns the updated request object so that additional method calls can be chained together.
SetBucketPolicyRequest	withPolicyText(String policyText) Sets the policy to apply to the specified bucket, and returns the updated request object so that additional method calls can 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

SetBucketPolicyRequest

public SetBucketPolicyRequest()

SetBucketPolicyRequest

public SetBucketPolicyRequest(String bucketName,
                              String policyText)

Creates a new request object, ready to be executed to set an Amazon S3 bucket's policy.

Parameters:

bucketName - The name of the Amazon S3 bucket whose policy is being set.

policyText - The policy to apply to the specified bucket.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the Amazon S3 bucket whose policy is being set.

Returns:

The name of the Amazon S3 bucket whose policy is being set.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the Amazon S3 bucket whose policy is being set.

Parameters:

bucketName - The name of the Amazon S3 bucket whose policy is being set.

withBucketName

public SetBucketPolicyRequest withBucketName(String bucketName)

Sets the name of the Amazon S3 bucket whose policy is being set, and returns the updated request object so that additional method calls can be chained together.

Parameters:

bucketName - The name of the Amazon S3 bucket whose policy is being set.

Returns:

The updated request object so that additional method calls can be chained together.

getPolicyText

public String getPolicyText()

Returns the policy to apply to the specified bucket.

Returns:

The policy to apply to the specified bucket.

setPolicyText

public void setPolicyText(String policyText)

Sets the policy to apply to the specified bucket.

Parameters:

policyText - The policy to apply to the specified bucket.

withPolicyText

public SetBucketPolicyRequest withPolicyText(String policyText)

Sets the policy to apply to the specified bucket, and returns the updated request object so that additional method calls can be chained together.

Parameters:

policyText - The policy to apply to the specified bucket.

Returns:

The updated request object, so that additional method calls can be chained together.