@Generated(value="software.amazon.awssdk:codegen") public final class PutObjectAclRequest extends S3Request implements ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutObjectAclRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AccessControlPolicy |
accessControlPolicy()
Contains the elements that set the ACL permissions for an object per grantee.
|
ObjectCannedACL |
acl()
The canned ACL to apply to the object.
|
String |
aclAsString()
The canned ACL to apply to the object.
|
String |
bucket()
The bucket name that contains the object to which you want to attach the ACL.
|
static PutObjectAclRequest.Builder |
builder() |
String |
contentMD5()
The base64-encoded 128-bit MD5 digest of the data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
String |
grantFullControl()
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
|
String |
grantRead()
Allows grantee to list the objects in the bucket.
|
String |
grantReadACP()
Allows grantee to read the bucket ACL.
|
String |
grantWrite()
Allows grantee to create, overwrite, and delete any object in the bucket.
|
String |
grantWriteACP()
Allows grantee to write the ACL for the applicable bucket.
|
int |
hashCode() |
String |
key()
Key for which the PUT action was initiated.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutObjectAclRequest.Builder> |
serializableBuilderClass() |
PutObjectAclRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
VersionId used to reference a specific version of the object.
|
overrideConfiguration
copy
public final ObjectCannedACL acl()
The canned ACL to apply to the object. For more information, see Canned ACL.
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclAsString()
.
ObjectCannedACL
public final String aclAsString()
The canned ACL to apply to the object. For more information, see Canned ACL.
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclAsString()
.
ObjectCannedACL
public final AccessControlPolicy accessControlPolicy()
Contains the elements that set the ACL permissions for an object per grantee.
public final String bucket()
The bucket name that contains the object to which you want to attach the ACL.
When using this action 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 action with an access point through the AWS 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 S3 User Guide.
When using this action 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 action with an access point through the AWS 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 S3 User Guide.
public final String contentMD5()
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
public final String grantFullControl()
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantRead()
Allows grantee to list the objects in the bucket.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantReadACP()
Allows grantee to read the bucket ACL.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantWrite()
Allows grantee to create, overwrite, and delete any object in the bucket.
public final String grantWriteACP()
Allows grantee to write the ACL for the applicable bucket.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String key()
Key for which the PUT action was initiated.
When using this action 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 action with an access point through the AWS 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 S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
When using this action 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 action with an access point through the AWS 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 S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
public final RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String versionId()
VersionId used to reference a specific version of the object.
public final String expectedBucketOwner()
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail
with an HTTP 403 (Access Denied)
error.
403 (Access Denied)
error.public PutObjectAclRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
toBuilder
in class S3Request
public static PutObjectAclRequest.Builder builder()
public static Class<? extends PutObjectAclRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.