com.baidubce.services.bos.model

Class SetObjectAclRequest

java.lang.Object

com.baidubce.model.AbstractBceRequest

com.baidubce.services.bos.model.GenericBucketRequest

com.baidubce.services.bos.model.GenericObjectRequest

com.baidubce.services.bos.model.SetObjectAclRequest

public class SetObjectAclRequest
extends GenericObjectRequest

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

Constructor Summary

Constructors

Constructor and Description
SetObjectAclRequest() Constructs a void Constructor for SetObjectAclRequest.
SetObjectAclRequest(String bucketName, String key, CannedAccessControlList cannedAcl) Constructs a new SetObjectAclRequest object, ready to set the specified, canned ACL on the specified bucket/object when this request is executed.
SetObjectAclRequest(String bucketName, String key, List<Grant> accessControlList) Constructs a new SetObjectAclRequest object, ready to set the specified ACL on the specified bucket/object when this request is executed.
SetObjectAclRequest(String bucketName, String key, String jsonObjectAcl) Constructs a new SetObjectAclRequest object, ready to set the specified jsonObjectAcl on the specified bucket/object when this request is executed.

Method Summary

Modifier and Type	Method and Description
List<Grant>	getAccessControlList() Gets the accessControlList of Object Acl.
CannedAccessControlList	getCannedAcl() Gets the cannedAcl of Object Acl.
String	getJsonObjectAcl() Gets the json format of Object Acl.
String	getxBceGrantFullControl() Gets the xBceGrantFullControl of Object Acl.
String	getxBceGrantRead() Gets the xBceGrantRead of Object Acl.
void	setAccessControlList(List<Grant> accessControlList) Sets the accessControlList of Object Acl.
void	setCannedAcl(CannedAccessControlList cannedAcl) Sets the cannedAcl of Object Acl.
void	setJsonObjectAcl(String jsonObjectAcl) Sets the json format of Object Acl.
void	setxBceGrantFullControl(String xBceGrantFullControl) Sets the xBceGrantFullControl of Object Acl.
void	setxBceGrantRead(String xBceGrantRead) Sets the xBceGrantRead of Object Acl.
SetObjectAclRequest	withBucketName(String bucketName)
SetObjectAclRequest	withKey(String key)
SetObjectAclRequest	withRequestCredentials(BceCredentials credentials)

Methods inherited from class com.baidubce.services.bos.model.GenericObjectRequest

getKey, setKey

Methods inherited from class com.baidubce.services.bos.model.GenericBucketRequest

getBucketName, setBucketName

Methods inherited from class com.baidubce.model.AbstractBceRequest

getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

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

Constructor Detail

SetObjectAclRequest

public SetObjectAclRequest()

Constructs a void Constructor for SetObjectAclRequest.

SetObjectAclRequest

public SetObjectAclRequest(String bucketName,
                           String key,
                           String jsonObjectAcl)

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

Parameters:

bucketName - The name of the bucket whose Object will be set Acl by this request.

key - The name of the Object whose ACL will be set by this request.

jsonObjectAcl - The json style of acl to apply to the specified object when this request is executed.

SetObjectAclRequest

public SetObjectAclRequest(String bucketName,
                           String key,
                           List<Grant> accessControlList)

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

Parameters:

bucketName - The name of the bucket whose Object acl will be set by this request.

key - The name of the Object whose ACL will be set by this request.

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

SetObjectAclRequest

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

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

Parameters:

bucketName - The name of the bucket whose Object acl will be set by this request.

key - The name of the Object whose ACL will be set by this request.

cannedAcl - The Canned Access Control List to apply to the specified, bucket/object when this request is executed.

Method Detail

withRequestCredentials

public SetObjectAclRequest withRequestCredentials(BceCredentials credentials)

Specified by:

withRequestCredentials in class AbstractBceRequest

withBucketName

public SetObjectAclRequest withBucketName(String bucketName)

Specified by:

withBucketName in class GenericBucketRequest

withKey

public SetObjectAclRequest withKey(String key)

Specified by:

withKey in class GenericObjectRequest

getJsonObjectAcl

public String getJsonObjectAcl()

Gets the json format of Object Acl.

Returns:

the json format of Object Acl.

setJsonObjectAcl

public void setJsonObjectAcl(String jsonObjectAcl)

Sets the json format of Object Acl.

Parameters:

jsonObjectAcl - The json format of Object Acl.

getAccessControlList

public List<Grant> getAccessControlList()

Gets the accessControlList of Object Acl.

Returns:

the accessControlList of Object Acl.

setAccessControlList

public void setAccessControlList(List<Grant> accessControlList)

Sets the accessControlList of Object Acl.

Parameters:

accessControlList - The accessControlList of Object Acl.

getCannedAcl

public CannedAccessControlList getCannedAcl()

Gets the cannedAcl of Object Acl.

Returns:

the cannedAcl of Object Acl.

setCannedAcl

public void setCannedAcl(CannedAccessControlList cannedAcl)

Sets the cannedAcl of Object Acl.

Parameters:

cannedAcl - The cannedAcl of Object Acl.

getxBceGrantRead

public String getxBceGrantRead()

Gets the xBceGrantRead of Object Acl.

Returns:

the xBceGrantRead of Object Acl.

setxBceGrantRead

public void setxBceGrantRead(String xBceGrantRead)

Sets the xBceGrantRead of Object Acl.

Parameters:

xBceGrantRead - The xBceGrantRead of Object Acl.

getxBceGrantFullControl

public String getxBceGrantFullControl()

Gets the xBceGrantFullControl of Object Acl.

Returns:

the xBceGrantFullControl of Object Acl.

setxBceGrantFullControl

public void setxBceGrantFullControl(String xBceGrantFullControl)

Sets the xBceGrantFullControl of Object Acl.

Parameters:

xBceGrantFullControl - The xBceGrantRead of Object Acl.