s3/aws.sdk.kotlin.services.s3.model/PutObjectAnnotationRequest/Builder

Builder

Properties

The name of the annotation.

The annotation payload. Must be between 1 byte and 1 MiB in size, and must be valid UTF-8 encoded text. If the payload contains invalid UTF-8 bytes, the request fails with HTTP 415 (Unsupported Media Type). To store binary data, encode the payload using Base64 before uploading.

bucket

var bucket: String?

The name of the bucket that contains the object.

checksumAlgorithm

var checksumAlgorithm: ChecksumAlgorithm?

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

checksumCrc32

var checksumCrc32: String?

Base64-encoded CRC32 checksum of the annotation payload.

checksumCrc32C

var checksumCrc32C: String?

Base64-encoded CRC32C checksum of the annotation payload.

checksumCrc64Nvme

var checksumCrc64Nvme: String?

Base64-encoded CRC64NVME checksum of the annotation payload.

checksumMd5

var checksumMd5: String?

Base64-encoded MD5 checksum of the annotation payload.

checksumSha1

var checksumSha1: String?

Base64-encoded SHA1 checksum of the annotation payload.

checksumSha256

var checksumSha256: String?

Base64-encoded SHA256 checksum of the annotation payload.

checksumSha512

var checksumSha512: String?

Base64-encoded SHA512 checksum of the annotation payload.

checksumXxhash128

var checksumXxhash128: String?

Base64-encoded XXHASH128 checksum of the annotation payload.

checksumXxhash3

var checksumXxhash3: String?

Base64-encoded XXHASH3 checksum of the annotation payload.

checksumXxhash64

var checksumXxhash64: String?

Base64-encoded XXHASH64 checksum of the annotation payload.

contentMd5

var contentMd5: String?

Base64-encoded MD5 digest of the message.

expectedBucketOwner

var expectedBucketOwner: String?

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.

key

var key: String?

The object key.

objectIfMatch

var objectIfMatch: String?

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

requestPayer

var requestPayer: RequestPayer?

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

versionId

var versionId: String?

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