Class PutObjectAclRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3.model.S3Request
software.amazon.awssdk.services.s3.model.PutObjectAclRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutObjectAclRequest extends S3Request implements ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>

  • Method Details

    • acl

      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().

      Returns:
      The canned ACL to apply to the object. For more information, see Canned ACL.
      See Also:

    • aclAsString

      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().

      Returns:
      The canned ACL to apply to the object. For more information, see Canned ACL.
      See Also:

    • accessControlPolicy

      public final AccessControlPolicy 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

      public final String 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

      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 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

      public final ChecksumAlgorithm 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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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 return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

      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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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

      public final String 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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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 return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

      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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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

      public final String 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

      public final String 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

      public final String 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

      public final String 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

      public final String 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

      public final String key()

      Key for which the PUT action was initiated.

      Returns:
      Key for which the PUT action was initiated.

    • requestPayer

      public final RequestPayer 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 return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

      Returns:
      The value of the RequestPayer property for this object.
      See Also:

    • requestPayerAsString

      public final String 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 return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

      Returns:
      The value of the RequestPayer property for this object.
      See Also:

    • versionId

      public final String 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

      public final String 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

      public PutObjectAclRequest.Builder 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 interface ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • builder

      public static PutObjectAclRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutObjectAclRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.