Class PutObjectAclRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutObjectAclRequest.Builder,
PutObjectAclRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessControlPolicy
Contains the elements that set the ACL permissions for an object per grantee.final ObjectCannedACL
acl()
The canned ACL to apply to the object.final String
The canned ACL to apply to the object.final String
bucket()
The bucket name that contains the object to which you want to attach the ACL.static PutObjectAclRequest.Builder
builder()
final ChecksumAlgorithm
Indicates the algorithm used to create the checksum for the object when you use the SDK.final String
Indicates the algorithm used to create the checksum for the object when you use the SDK.final String
The base64-encoded 128-bit MD5 digest of the data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The account ID of the expected bucket owner.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.final String
Allows grantee to list the objects in the bucket.final String
Allows grantee to read the bucket ACL.final String
Allows grantee to create new objects in the bucket.final String
Allows grantee to write the ACL for the applicable bucket.final int
hashCode()
final String
key()
Key for which the PUT action was initiated.final RequestPayer
Returns the value of the RequestPayer property for this object.final String
Returns the value of the RequestPayer property for this object.static Class
<? extends PutObjectAclRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Version ID used to reference a specific version of the object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaclAsString()
.- Returns:
- The canned ACL to apply to the object. For more information, see Canned ACL.
- See Also:
-
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 returnObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaclAsString()
.- Returns:
- The canned ACL to apply to the object. For more information, see Canned ACL.
- See Also:
-
accessControlPolicy
Contains the elements that set the ACL permissions for an object per grantee.
- Returns:
- Contains the elements that set the ACL permissions for an object per grantee.
-
bucket
The bucket name that contains the object to which you want to attach the ACL.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 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 S3 User Guide.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.- Returns:
- The bucket name that contains the object to which you want to attach the ACL.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 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 S3 User Guide.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
-
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 Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
- Returns:
- 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 Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
-
checksumAlgorithm
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will
not provide any additional functionality if you don't use the SDK. When you send this header, there must
be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter. - See Also:
-
checksumAlgorithmAsString
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will
not provide any additional functionality if you don't use the SDK. When you send this header, there must
be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter. - See Also:
-
grantFullControl
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for Amazon S3 on Outposts.
-
grantRead
Allows grantee to list the objects in the bucket.
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee to list the objects in the bucket.
This functionality is not supported for Amazon S3 on Outposts.
-
grantReadACP
Allows grantee to read the bucket ACL.
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee to read the bucket ACL.
This functionality is not supported for Amazon S3 on Outposts.
-
grantWrite
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
- Returns:
- Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
-
grantWriteACP
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for Amazon S3 on Outposts.
-
key
Key for which the PUT action was initiated.
- Returns:
- Key for which the PUT action was initiated.
-
requestPayer
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
requestPayerAsString
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
versionId
Version ID used to reference a specific version of the object.
This functionality is not supported for directory buckets.
- Returns:
- Version ID used to reference a specific version of the object.
This functionality is not supported for directory buckets.
-
expectedBucketOwner
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).- Returns:
- The account ID of the expected bucket owner. If the account ID that you provide does not match the actual
owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied).
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutObjectAclRequest.Builder,
PutObjectAclRequest> - Specified by:
toBuilder
in classS3Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-