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

Builder

class Builder

Properties

acceptRanges

var acceptRanges: String?

Indicates that a range of bytes was specified in the request.

body

var body: ByteStream?

Object data.

bucketKeyEnabled

var bucketKeyEnabled: Boolean?

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

cacheControl

var cacheControl: String?

Specifies caching behavior along the request/reply chain.

checksumCrc32

var checksumCrc32: String?

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

checksumCrc32C

var checksumCrc32C: String?

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

checksumSha1

var checksumSha1: String?

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

checksumSha256

var checksumSha256: String?

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

contentDisposition

var contentDisposition: String?

Specifies presentational information for the object.

contentEncoding

var contentEncoding: String?

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

contentLanguage

var contentLanguage: String?

The language the content is in.

contentLength

var contentLength: Long?

Size of the body in bytes.

contentRange

var contentRange: String?

The portion of the object returned in the response.

contentType

var contentType: String?

A standard MIME type describing the format of the object data.

deleteMarker

var deleteMarker: Boolean?

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

eTag

var eTag: String?

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

expiration

var expiration: String?

If the object expiration is configured (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

expires

var expires: Instant?

The date and time at which the object is no longer cacheable.

lastModified

var lastModified: Instant?

Date and time when the object was last modified.

metadata

var metadata: Map<String, String>?

A map of metadata to store with the object in S3.

missingMeta

var missingMeta: Int?

This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

objectLockLegalHoldStatus

var objectLockLegalHoldStatus: ObjectLockLegalHoldStatus?

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

objectLockMode

var objectLockMode: ObjectLockMode?

The Object Lock mode that's currently in place for this object.

objectLockRetainUntilDate

var objectLockRetainUntilDate: Instant?

The date and time when this object's Object Lock will expire.

partsCount

var partsCount: Int?

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

replicationStatus

var replicationStatus: ReplicationStatus?

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

requestCharged

var requestCharged: RequestCharged?

If present, indicates that the requester was successfully charged for the request.

restore

var restore: String?

Provides information about object restoration action and expiration time of the restored object copy.

serverSideEncryption

var serverSideEncryption: ServerSideEncryption?

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

sseCustomerAlgorithm

var sseCustomerAlgorithm: String?

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

sseCustomerKeyMd5

var sseCustomerKeyMd5: String?

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

ssekmsKeyId

var ssekmsKeyId: String?

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

storageClass

var storageClass: StorageClass?

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

tagCount

var tagCount: Int?

The number of tags, if any, on the object, when you have the relevant permission to read object tags.

versionId

var versionId: String?

Version ID of the object.

websiteRedirectLocation

var websiteRedirectLocation: String?

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.