com.amazonaws.services.s3.model

Class SetObjectAclRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.SetObjectAclRequest

All Implemented Interfaces:

ReadLimitInfo, Cloneable

public class SetObjectAclRequest
extends AmazonWebServiceRequest

Request object containing all the options for setting a object's Access Control List (ACL).

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetObjectAclRequest(String bucketName, String key, AccessControlList acl) Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.
SetObjectAclRequest(String bucketName, String key, CannedAccessControlList acl) Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.
SetObjectAclRequest(String bucketName, String key, String versionId, AccessControlList acl) Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.
SetObjectAclRequest(String bucketName, String key, String versionId, CannedAccessControlList acl) Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.

Method Summary

Methods

Modifier and Type	Method and Description
AccessControlList	getAcl() Returns the custom ACL to be applied to the specified object when this request is executed.
String	getBucketName() Returns the name of the bucket containing the object whose ACL is being set.
CannedAccessControlList	getCannedAcl() Returns the canned ACL to be applied to the specified object when this request is executed.
String	getKey() Returns the name of the object whose ACL is being set.
String	getVersionId() Returns the version ID of the object version whose ACL is being set.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SetObjectAclRequest

public SetObjectAclRequest(String bucketName,
                   String key,
                   AccessControlList acl)

Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.

Parameters:

bucketName - The name of the bucket containing the object whose ACL is being set.

key - The name of the object whose ACL is being set.

acl - The custom Access Control List containing the access rules to apply to the specified bucket when this request is executed.

SetObjectAclRequest

public SetObjectAclRequest(String bucketName,
                   String key,
                   CannedAccessControlList acl)

Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.

Parameters:

bucketName - The name of the bucket containing the object whose ACL is being set.

key - The name of the object whose ACL is being set.

acl - The Canned Access Control List to apply to the specified bucket when this request is executed.

SetObjectAclRequest

public SetObjectAclRequest(String bucketName,
                   String key,
                   String versionId,
                   AccessControlList acl)

Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.

Parameters:

bucketName - The name of the bucket containing the object whose ACL is being set.

key - The name of the object whose ACL is being set.

versionId - The version ID of the object version whose ACL is being set.

acl - The custom Access Control List containing the access rules to apply to the specified bucket when this request is executed.

SetObjectAclRequest

public SetObjectAclRequest(String bucketName,
                   String key,
                   String versionId,
                   CannedAccessControlList acl)

Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified object when this request is executed.

Parameters:

bucketName - The name of the bucket containing the object whose ACL is being set.

key - The name of the object whose ACL is being set.

versionId - The version ID of the object version whose ACL is being set.

acl - The Canned Access Control List to apply to the specified bucket when this request is executed.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket containing the object whose ACL is being set.

Returns:

The name of the bucket containing the object whose ACL is being set.

getKey

public String getKey()

Returns the name of the object whose ACL is being set.

Returns:

The name of the object whose ACL is being set.

getVersionId

public String getVersionId()

Returns the version ID of the object version whose ACL is being set.

Returns:

The version ID of the object version whose ACL is being set.

getAcl

public AccessControlList getAcl()

Returns the custom ACL to be applied to the specified object when this request is executed. A request can use either a custom ACL or a canned ACL, but not both.

Returns:

The custom ACL to be applied to the specified bucket when this request is executed, or null if the request is to be executed with a canned ACL.

getCannedAcl

public CannedAccessControlList getCannedAcl()

Returns the canned ACL to be applied to the specified object when this request is executed. A request can use either a custom ACL or a canned ACL, but not both.

Returns:

The canned ACL to be applied to the specified bucket when this request is executed, or null if the request is to be executed with a custom ACL.