Package software.amazon.awssdk.services.s3.model

Interface PutObjectTaggingRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>, S3Request.Builder, SdkBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutObjectTaggingRequest
@Mutable @NotThreadSafe public static interface PutObjectTaggingRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>

  • Method Details

    • bucket

      PutObjectTaggingRequest.Builder bucket(String bucket)

      The bucket name containing the object.

      Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

      Parameters:
      bucket - The bucket name containing the object.

      Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

      PutObjectTaggingRequest.Builder key(String key)

      Name of the object key.

      Parameters:
      key - Name of the object key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionId

      PutObjectTaggingRequest.Builder versionId(String versionId)

      The versionId of the object that the tag-set will be added to.

      Parameters:
      versionId - The versionId of the object that the tag-set will be added to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentMD5

      PutObjectTaggingRequest.Builder contentMD5(String contentMD5)

      The MD5 hash for the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

      Parameters:
      contentMD5 - The MD5 hash for the request body.

      For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumAlgorithm

      PutObjectTaggingRequest.Builder checksumAlgorithm(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumAlgorithm

      PutObjectTaggingRequest.Builder checksumAlgorithm(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagging

      PutObjectTaggingRequest.Builder tagging(Tagging tagging)

      Container for the TagSet and Tag elements

      Parameters:
      tagging - Container for the TagSet and Tag elements
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagging

      default PutObjectTaggingRequest.Builder tagging(Consumer<Tagging.Builder> tagging)

      Container for the TagSet and Tag elements

      This is a convenience method that creates an instance of the Tagging.Builder avoiding the need to create one manually via Tagging.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagging(Tagging).

      Parameters:
      tagging - a consumer that will call methods on Tagging.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedBucketOwner

      PutObjectTaggingRequest.Builder expectedBucketOwner(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • requestPayer

      PutObjectTaggingRequest.Builder requestPayer(String requestPayer)

      Confirms that the requester knows that she or he will be charged for the tagging object request. Bucket owners need not specify this parameter in their requests.

      Parameters:
      requestPayer - Confirms that the requester knows that she or he will be charged for the tagging object request. Bucket owners need not specify this parameter in their requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestPayer

      PutObjectTaggingRequest.Builder requestPayer(RequestPayer requestPayer)

      Confirms that the requester knows that she or he will be charged for the tagging object request. Bucket owners need not specify this parameter in their requests.

      Parameters:
      requestPayer - Confirms that the requester knows that she or he will be charged for the tagging object request. Bucket owners need not specify this parameter in their requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      PutObjectTaggingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      PutObjectTaggingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder