GetObjectResponse.Builder (IBM COS Java SDK

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>, S3Response.Builder, SdkBuilder<GetObjectResponse.Builder,GetObjectResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetObjectResponse
```
@Mutable
 @NotThreadSafe
public static interface GetObjectResponse.Builder
extends S3Response.Builder, SdkPojo, CopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`GetObjectResponse.Builder`	`acceptRanges(String acceptRanges)` Indicates that a range of bytes was specified in the request.
`GetObjectResponse.Builder`	`bucketKeyEnabled(Boolean bucketKeyEnabled)` Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
`GetObjectResponse.Builder`	`cacheControl(String cacheControl)` Specifies caching behavior along the request/reply chain.
`GetObjectResponse.Builder`	`checksumCRC32(String checksumCRC32)` The Base64 encoded, 32-bit `CRC32` checksum of the object.
`GetObjectResponse.Builder`	`checksumCRC32C(String checksumCRC32C)` The Base64 encoded, 32-bit `CRC32C` checksum of the object.
`GetObjectResponse.Builder`	`checksumCRC64NVME(String checksumCRC64NVME)` The Base64 encoded, 64-bit `CRC64NVME` checksum of the object.
`GetObjectResponse.Builder`	`checksumSHA1(String checksumSHA1)` The Base64 encoded, 160-bit `SHA1` digest of the object.
`GetObjectResponse.Builder`	`checksumSHA256(String checksumSHA256)` The Base64 encoded, 256-bit `SHA256` digest of the object.
`GetObjectResponse.Builder`	`checksumType(ChecksumType checksumType)` The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
`GetObjectResponse.Builder`	`checksumType(String checksumType)` The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
`GetObjectResponse.Builder`	`contentDisposition(String contentDisposition)` Specifies presentational information for the object.
`GetObjectResponse.Builder`	`contentEncoding(String contentEncoding)` 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.
`GetObjectResponse.Builder`	`contentLanguage(String contentLanguage)` The language the content is in.
`GetObjectResponse.Builder`	`contentLength(Long contentLength)` Size of the body in bytes.
`GetObjectResponse.Builder`	`contentRange(String contentRange)` The portion of the object returned in the response.
`GetObjectResponse.Builder`	`contentType(String contentType)` A standard MIME type describing the format of the object data.
`GetObjectResponse.Builder`	`deleteMarker(Boolean deleteMarker)` Indicates whether the object retrieved was (true) or was not (false) a Delete Marker.
`GetObjectResponse.Builder`	`eTag(String eTag)` An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
`GetObjectResponse.Builder`	`expiration(String expiration)` If the object expiration is configured (see `PutBucketLifecycleConfiguration` ), the response includes this header.
`GetObjectResponse.Builder`	`expires(Instant expires)` Deprecated. Usage of the Expires field is deprecated in favor of the more flexible and less error prone ExpiresString
`GetObjectResponse.Builder`	`expiresString(String expiresString)` The date and time at which the object is no longer cacheable
`GetObjectResponse.Builder`	`ibmSSEKPCrk(String ibmSSEKPCrk)` Sets the CRK value
`GetObjectResponse.Builder`	`ibmSSEKPEnabled(Boolean ibmSSEKPEnabled)` Sets if KP is enabled
`GetObjectResponse.Builder`	`lastModified(Instant lastModified)` Date and time when the object was last modified.
`GetObjectResponse.Builder`	`metadata(Map<String,String> metadata)` A map of metadata to store with the object in S3.
`GetObjectResponse.Builder`	`missingMeta(Integer missingMeta)` This is set to the number of metadata entries not returned in the headers that are prefixed with `x-amz-meta-`.
`GetObjectResponse.Builder`	`objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)` Indicates whether this object has an active legal hold.
`GetObjectResponse.Builder`	`objectLockLegalHoldStatus(String objectLockLegalHoldStatus)` Indicates whether this object has an active legal hold.
`GetObjectResponse.Builder`	`objectLockMode(ObjectLockMode objectLockMode)` The Object Lock mode that's currently in place for this object.
`GetObjectResponse.Builder`	`objectLockMode(String objectLockMode)` The Object Lock mode that's currently in place for this object.
`GetObjectResponse.Builder`	`objectLockRetainUntilDate(Instant objectLockRetainUntilDate)` The date and time when this object's Object Lock will expire.
`GetObjectResponse.Builder`	`partsCount(Integer partsCount)` The count of parts this object has.
`GetObjectResponse.Builder`	`replicationStatus(ReplicationStatus replicationStatus)` Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
`GetObjectResponse.Builder`	`replicationStatus(String replicationStatus)` Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
`GetObjectResponse.Builder`	`requestCharged(RequestCharged requestCharged)` Sets the value of the RequestCharged property for this object.
`GetObjectResponse.Builder`	`requestCharged(String requestCharged)` Sets the value of the RequestCharged property for this object.
`GetObjectResponse.Builder`	`restore(String restore)` Provides information about object restoration action and expiration time of the restored object copy.
`GetObjectResponse.Builder`	`retentionExpirationDate(Instant retentionExpirationDate)` Date on which it will be legal to delete or modify the object.
`GetObjectResponse.Builder`	`retentionLegalHoldCount(Integer retentionLegalHoldCount)` The number of legal holds applied to the object.
`GetObjectResponse.Builder`	`retentionPeriod(Long retentionPeriod)` Retention period to store on the object in seconds.
`GetObjectResponse.Builder`	`serverSideEncryption(ServerSideEncryption serverSideEncryption)` The server-side encryption algorithm used when you store this object in Amazon S3.
`GetObjectResponse.Builder`	`serverSideEncryption(String serverSideEncryption)` The server-side encryption algorithm used when you store this object in Amazon S3.
`GetObjectResponse.Builder`	`sseCustomerAlgorithm(String sseCustomerAlgorithm)` 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.
`GetObjectResponse.Builder`	`sseCustomerKeyMD5(String sseCustomerKeyMD5)` 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.
`GetObjectResponse.Builder`	`ssekmsKeyId(String ssekmsKeyId)` If present, indicates the ID of the KMS key that was used for object encryption.
`GetObjectResponse.Builder`	`storageClass(StorageClass storageClass)` Provides storage class information of the object.
`GetObjectResponse.Builder`	`storageClass(String storageClass)` Provides storage class information of the object.
`GetObjectResponse.Builder`	`tagCount(Integer tagCount)` The number of tags, if any, on the object, when you have the relevant permission to read object tags.
`GetObjectResponse.Builder`	`versionId(String versionId)` Version ID of the object.
`GetObjectResponse.Builder`	`websiteRedirectLocation(String websiteRedirectLocation)` 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.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Response.Builder
build, responseMetadata, responseMetadata

Methods inherited from interface com.ibm.cos.v2.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder
copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - deleteMarker
```
GetObjectResponse.Builder deleteMarker(Boolean deleteMarker)
```
    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.
    If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
    
    If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
    Parameters:
    deleteMarker - 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.
    
    If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
    
    If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - acceptRanges
```
GetObjectResponse.Builder acceptRanges(String acceptRanges)
```
    Indicates that a range of bytes was specified in the request.
    
    Parameters:
    
    acceptRanges - Indicates that a range of bytes was specified in the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - expiration
```
GetObjectResponse.Builder expiration(String expiration)
```
    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.
    
    Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.
    
    Parameters:
    
    expiration - 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.
    
    Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - restore
```
GetObjectResponse.Builder restore(String restore)
```
    Provides information about object restoration action and expiration time of the restored object copy.
    
    This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Parameters:
    
    restore - Provides information about object restoration action and expiration time of the restored object copy.
    
    This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastModified
```
GetObjectResponse.Builder lastModified(Instant lastModified)
```
    Date and time when the object was last modified.
    
    General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
    
    Parameters:
    
    lastModified - Date and time when the object was last modified.
    
    General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - contentLength
```
GetObjectResponse.Builder contentLength(Long contentLength)
```
    Size of the body in bytes.
    
    Parameters:
    
    contentLength - Size of the body in bytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - eTag
```
GetObjectResponse.Builder eTag(String eTag)
```
    An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
    
    Parameters:
    
    eTag - An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - checksumCRC32
```
GetObjectResponse.Builder checksumCRC32(String checksumCRC32)
```
    The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumCRC32 - The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - checksumCRC32C
```
GetObjectResponse.Builder checksumCRC32C(String checksumCRC32C)
```
    The Base64 encoded, 32-bit CRC32C checksum of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumCRC32C - The Base64 encoded, 32-bit CRC32C checksum of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - checksumCRC64NVME
```
GetObjectResponse.Builder checksumCRC64NVME(String checksumCRC64NVME)
```
    The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumCRC64NVME - The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - checksumSHA1
```
GetObjectResponse.Builder checksumSHA1(String checksumSHA1)
```
    The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumSHA1 - The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - checksumSHA256
```
GetObjectResponse.Builder checksumSHA256(String checksumSHA256)
```
    The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumSHA256 - The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - checksumType
```
GetObjectResponse.Builder checksumType(String checksumType)
```
    The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumType - The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChecksumType, ChecksumType
  - checksumType
```
GetObjectResponse.Builder checksumType(ChecksumType checksumType)
```
    The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumType - The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChecksumType, ChecksumType
  - missingMeta
```
GetObjectResponse.Builder missingMeta(Integer missingMeta)
```
    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.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    missingMeta - 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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - versionId
```
GetObjectResponse.Builder versionId(String versionId)
```
    Version ID of the object.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    versionId - Version ID of the object.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cacheControl
```
GetObjectResponse.Builder cacheControl(String cacheControl)
```
    Specifies caching behavior along the request/reply chain.
    
    Parameters:
    
    cacheControl - Specifies caching behavior along the request/reply chain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - contentDisposition
```
GetObjectResponse.Builder contentDisposition(String contentDisposition)
```
    Specifies presentational information for the object.
    
    Parameters:
    
    contentDisposition - Specifies presentational information for the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - contentEncoding
```
GetObjectResponse.Builder contentEncoding(String contentEncoding)
```
    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.
    
    Parameters:
    
    contentEncoding - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - contentLanguage
```
GetObjectResponse.Builder contentLanguage(String contentLanguage)
```
    The language the content is in.
    
    Parameters:
    
    contentLanguage - The language the content is in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - contentRange
```
GetObjectResponse.Builder contentRange(String contentRange)
```
    The portion of the object returned in the response.
    
    Parameters:
    
    contentRange - The portion of the object returned in the response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - contentType
```
GetObjectResponse.Builder contentType(String contentType)
```
    A standard MIME type describing the format of the object data.
    
    Parameters:
    
    contentType - A standard MIME type describing the format of the object data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - expires
```
@Deprecated
GetObjectResponse.Builder expires(Instant expires)
```
    Deprecated. Usage of the Expires field is deprecated in favor of the more flexible and less error prone ExpiresString
    
    The date and time at which the object is no longer cacheable.
    
    Parameters:
    
    expires - The date and time at which the object is no longer cacheable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - websiteRedirectLocation
```
GetObjectResponse.Builder websiteRedirectLocation(String websiteRedirectLocation)
```
    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.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    websiteRedirectLocation - 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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serverSideEncryption
```
GetObjectResponse.Builder serverSideEncryption(String serverSideEncryption)
```
    The server-side encryption algorithm used when you store this object in Amazon S3.
    
    Parameters:
    
    serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServerSideEncryption, ServerSideEncryption
  - serverSideEncryption
```
GetObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
```
    The server-side encryption algorithm used when you store this object in Amazon S3.
    
    Parameters:
    
    serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ServerSideEncryption, ServerSideEncryption
  - metadata
```
GetObjectResponse.Builder metadata(Map<String,String> metadata)
```
    A map of metadata to store with the object in S3.
    
    Parameters:
    
    metadata - A map of metadata to store with the object in S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sseCustomerAlgorithm
```
GetObjectResponse.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
```
    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.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    sseCustomerAlgorithm - 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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sseCustomerKeyMD5
```
GetObjectResponse.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)
```
    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.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    sseCustomerKeyMD5 - 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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ssekmsKeyId
```
GetObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)
```
    If present, indicates the ID of the KMS key that was used for object encryption.
    
    Parameters:
    
    ssekmsKeyId - If present, indicates the ID of the KMS key that was used for object encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - bucketKeyEnabled
```
GetObjectResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
```
    Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
    
    Parameters:
    
    bucketKeyEnabled - Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - storageClass
```
GetObjectResponse.Builder storageClass(String storageClass)
```
    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Parameters:
    
    storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass, StorageClass
  - storageClass
```
GetObjectResponse.Builder storageClass(StorageClass storageClass)
```
    Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Parameters:
    
    storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass, StorageClass
  - requestCharged
```
GetObjectResponse.Builder requestCharged(String requestCharged)
```
    Sets the value of the RequestCharged property for this object.
    
    Parameters:
    
    requestCharged - The new value for the RequestCharged property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequestCharged, RequestCharged
  - requestCharged
```
GetObjectResponse.Builder requestCharged(RequestCharged requestCharged)
```
    Sets the value of the RequestCharged property for this object.
    
    Parameters:
    
    requestCharged - The new value for the RequestCharged property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RequestCharged, RequestCharged
  - replicationStatus
```
GetObjectResponse.Builder replicationStatus(String replicationStatus)
```
    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    replicationStatus - Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReplicationStatus, ReplicationStatus
  - replicationStatus
```
GetObjectResponse.Builder replicationStatus(ReplicationStatus replicationStatus)
```
    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    replicationStatus - Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReplicationStatus, ReplicationStatus
  - partsCount
```
GetObjectResponse.Builder partsCount(Integer partsCount)
```
    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.
    
    Parameters:
    
    partsCount - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tagCount
```
GetObjectResponse.Builder tagCount(Integer tagCount)
```
    The number of tags, if any, on the object, when you have the relevant permission to read object tags.
    
    You can use GetObjectTagging to retrieve the tag set associated with an object.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    tagCount - The number of tags, if any, on the object, when you have the relevant permission to read object tags.
    
    You can use GetObjectTagging to retrieve the tag set associated with an object.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - objectLockMode
```
GetObjectResponse.Builder objectLockMode(String objectLockMode)
```
    The Object Lock mode that's currently in place for this object.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    objectLockMode - The Object Lock mode that's currently in place for this object.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectLockMode, ObjectLockMode
  - objectLockMode
```
GetObjectResponse.Builder objectLockMode(ObjectLockMode objectLockMode)
```
    The Object Lock mode that's currently in place for this object.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    objectLockMode - The Object Lock mode that's currently in place for this object.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectLockMode, ObjectLockMode
  - objectLockRetainUntilDate
```
GetObjectResponse.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
```
    The date and time when this object's Object Lock will expire.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    objectLockRetainUntilDate - The date and time when this object's Object Lock will expire.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - objectLockLegalHoldStatus
```
GetObjectResponse.Builder objectLockLegalHoldStatus(String 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.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus
  - objectLockLegalHoldStatus
```
GetObjectResponse.Builder objectLockLegalHoldStatus(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.
    
    This functionality is not supported for directory buckets.
    
    Parameters:
    
    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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus
  - expiresString
```
GetObjectResponse.Builder expiresString(String expiresString)
```
    The date and time at which the object is no longer cacheable
    
    Parameters:
    
    expiresString - The date and time at which the object is no longer cacheable
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ibmSSEKPEnabled
```
GetObjectResponse.Builder ibmSSEKPEnabled(Boolean ibmSSEKPEnabled)
```
    Sets if KP is enabled
    
    Parameters:
    
    ibmSSEKPEnabled -
  - ibmSSEKPCrk
```
GetObjectResponse.Builder ibmSSEKPCrk(String ibmSSEKPCrk)
```
    Sets the CRK value
    
    Parameters:
    
    ibmSSEKPCrk -
  - retentionExpirationDate
```
GetObjectResponse.Builder retentionExpirationDate(Instant retentionExpirationDate)
```
    Date on which it will be legal to delete or modify the object.
    
    Parameters:
    
    retentionExpirationDate -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - retentionLegalHoldCount
```
GetObjectResponse.Builder retentionLegalHoldCount(Integer retentionLegalHoldCount)
```
    The number of legal holds applied to the object.
    
    Parameters:
    
    retentionLegalHoldCount -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - retentionPeriod
```
GetObjectResponse.Builder retentionPeriod(Long retentionPeriod)
```
    Retention period to store on the object in seconds.
    
    Parameters:
    
    retentionPeriod -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface GetObjectResponse.Builder

Method Summary

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Response.Builder

Methods inherited from interface com.ibm.cos.v2.core.SdkResponse.Builder

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

Method Detail

deleteMarker

acceptRanges

expiration

restore

lastModified

contentLength

eTag

checksumCRC32

checksumCRC32C

checksumCRC64NVME

checksumSHA1

checksumSHA256

checksumType

checksumType

missingMeta

versionId

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentRange

contentType

expires

websiteRedirectLocation

serverSideEncryption

serverSideEncryption

metadata

sseCustomerAlgorithm

sseCustomerKeyMD5

ssekmsKeyId

bucketKeyEnabled

storageClass

storageClass

requestCharged

requestCharged

replicationStatus

replicationStatus

partsCount

tagCount

objectLockMode

objectLockMode

objectLockRetainUntilDate

objectLockLegalHoldStatus

objectLockLegalHoldStatus

expiresString

ibmSSEKPEnabled

ibmSSEKPCrk

retentionExpirationDate

retentionLegalHoldCount

retentionPeriod