Interface PutObjectAnnotationRequest.Builder

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

  • Method Details

    • bucket

      PutObjectAnnotationRequest.Builder bucket(String bucket)

      The name of the bucket that contains the object.

      Parameters:
      bucket - The name of the bucket that contains the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

      PutObjectAnnotationRequest.Builder key(String key)

      The object key.

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

    • versionId

      PutObjectAnnotationRequest.Builder versionId(String versionId)

      The version ID of the object to attach the annotation to.

      Parameters:
      versionId - The version ID of the object to attach the annotation to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • annotationName

      PutObjectAnnotationRequest.Builder annotationName(String annotationName)

      The name of the annotation.

      Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

      Parameters:
      annotationName - The name of the annotation.

      Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

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

    • objectIfMatch

      PutObjectAnnotationRequest.Builder objectIfMatch(String objectIfMatch)

      If specified, the operation only succeeds if the object's ETag matches the provided value.

      Parameters:
      objectIfMatch - If specified, the operation only succeeds if the object's ETag matches the provided value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumAlgorithm

      PutObjectAnnotationRequest.Builder checksumAlgorithm(String checksumAlgorithm)

      The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.

      Parameters:
      checksumAlgorithm - The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumAlgorithm

      PutObjectAnnotationRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

      The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.

      Parameters:
      checksumAlgorithm - The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumCRC32

      PutObjectAnnotationRequest.Builder checksumCRC32(String checksumCRC32)

      Base64-encoded CRC32 checksum of the annotation payload.

      Parameters:
      checksumCRC32 - Base64-encoded CRC32 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumCRC32C

      PutObjectAnnotationRequest.Builder checksumCRC32C(String checksumCRC32C)

      Base64-encoded CRC32C checksum of the annotation payload.

      Parameters:
      checksumCRC32C - Base64-encoded CRC32C checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumCRC64NVME

      PutObjectAnnotationRequest.Builder checksumCRC64NVME(String checksumCRC64NVME)

      Base64-encoded CRC64NVME checksum of the annotation payload.

      Parameters:
      checksumCRC64NVME - Base64-encoded CRC64NVME checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA1

      PutObjectAnnotationRequest.Builder checksumSHA1(String checksumSHA1)

      Base64-encoded SHA1 checksum of the annotation payload.

      Parameters:
      checksumSHA1 - Base64-encoded SHA1 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA256

      PutObjectAnnotationRequest.Builder checksumSHA256(String checksumSHA256)

      Base64-encoded SHA256 checksum of the annotation payload.

      Parameters:
      checksumSHA256 - Base64-encoded SHA256 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA512

      PutObjectAnnotationRequest.Builder checksumSHA512(String checksumSHA512)

      Base64-encoded SHA512 checksum of the annotation payload.

      Parameters:
      checksumSHA512 - Base64-encoded SHA512 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumMD5

      PutObjectAnnotationRequest.Builder checksumMD5(String checksumMD5)

      Base64-encoded MD5 checksum of the annotation payload.

      Parameters:
      checksumMD5 - Base64-encoded MD5 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumXXHASH64

      PutObjectAnnotationRequest.Builder checksumXXHASH64(String checksumXXHASH64)

      Base64-encoded XXHASH64 checksum of the annotation payload.

      Parameters:
      checksumXXHASH64 - Base64-encoded XXHASH64 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumXXHASH3

      PutObjectAnnotationRequest.Builder checksumXXHASH3(String checksumXXHASH3)

      Base64-encoded XXHASH3 checksum of the annotation payload.

      Parameters:
      checksumXXHASH3 - Base64-encoded XXHASH3 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumXXHASH128

      PutObjectAnnotationRequest.Builder checksumXXHASH128(String checksumXXHASH128)

      Base64-encoded XXHASH128 checksum of the annotation payload.

      Parameters:
      checksumXXHASH128 - Base64-encoded XXHASH128 checksum of the annotation payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentMD5

      PutObjectAnnotationRequest.Builder contentMD5(String contentMD5)

      Base64-encoded MD5 digest of the message.

      Parameters:
      contentMD5 - Base64-encoded MD5 digest of the message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestPayer

      PutObjectAnnotationRequest.Builder requestPayer(String requestPayer)
      Sets the value of the RequestPayer property for this object.
      Parameters:
      requestPayer - The new value for the RequestPayer property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestPayer

      PutObjectAnnotationRequest.Builder requestPayer(RequestPayer requestPayer)
      Sets the value of the RequestPayer property for this object.
      Parameters:
      requestPayer - The new value for the RequestPayer property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expectedBucketOwner

      PutObjectAnnotationRequest.Builder expectedBucketOwner(String expectedBucketOwner)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.

      Parameters:
      expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutObjectAnnotationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutObjectAnnotationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.