WriteGetObjectResponseRequest (IBM COS SDK for Java 2.13.6 API)

java.lang.Object
- com.ibm.cloud.objectstorage.AmazonWebServiceRequest
- - com.ibm.cloud.objectstorage.services.s3.model.WriteGetObjectResponseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, S3DataSource, Serializable, Cloneable
```
public class WriteGetObjectResponseRequest
extends AmazonWebServiceRequest
implements Serializable, S3DataSource
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.s3.model.S3DataSource
  S3DataSource.Utils

Field Summary
- Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

WriteGetObjectResponseRequest()

Constructors
Constructor and Description
`WriteGetObjectResponseRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAcceptRanges()` Indicates that a range of bytes was specified.
`Boolean`	`getBucketKeyEnabled()` Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
`String`	`getCacheControl()` The caching behavior along the request/reply chain.
`String`	`getContentDisposition()` The presentational information for the object.
`String`	`getContentEncoding()` 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.
`String`	`getContentLanguage()` The language the content is in.
`Long`	`getContentLength()` The size of the body in bytes.
`String`	`getContentRange()` The portion of the object returned in the response.
`String`	`getContentType()` The standard MIME type describing the format of the object data.
`String`	`getDeleteMarker()` Whether an object stored in Amazon S3 is (`true`) or is not (`false`) a delete marker.
`String`	`getErrorCode()` A string that uniquely identifies an error condition.
`String`	`getErrorMessage()` A generic description of the error condition.
`String`	`getETag()` An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
`String`	`getExpiration()` If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
`Date`	`getExpires()` The date and time at which the object is no longer cacheable.
`File`	`getFile()`
`InputStream`	`getInputStream()`
`Date`	`getLastModified()` The date and time the object was last modified.
`ObjectMetadata`	`getMetadata()` A map of metadata to store with the object in S3.
`Integer`	`getMissingMeta()` The number of metadata entries not returned in `x-amz-meta` headers.
`String`	`getObjectLockLegalHoldStatus()` Whether an object stored in Amazon S3 has an active legal hold.
`String`	`getObjectLockMode()` Whether an object stored in Amazon S3 has Object Lock enabled.
`Date`	`getObjectLockRetainUntilDate()` The date and time when Object Lock is configured to expire.
`Integer`	`getPartsCount()` The count of parts this object has.
`String`	`getReplicationStatus()` If request involves bucket that is either a source or destination in a Replication rule.
`String`	`getRequestCharged()` The value of the RequestCharged property for this object.
`String`	`getRequestRoute()` The route prefix to the HTTP URL generated.
`String`	`getRequestToken()` A single use encrypted token that maps `WriteGetObjectResponse` to the end user `GetObject` request.
`String`	`getRestore()` Information about object restoration operation and expiration time of the restored object copy.
`String`	`getServerSideEncryption()` The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, `aws:kms`)).
`String`	`getSSECustomerAlgorithm()` The algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
`String`	`getSSECustomerKeyMD5()` The 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3.
`String`	`getSSEKMSKeyId()` If present, specifies the ID of the Amazon Web Services Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
`Integer`	`getStatusCode()` The integer status code for an HTTP response of a corresponding `GetObject` request.
`String`	`getStorageClass()` The class of storage used to store object in Amazon S3.
`Integer`	`getTagCount()` The number of tags, if any, on the object.
`String`	`getVersionId()` An ID used to reference a specific version of the object.
`int`	`hashCode()`
`void`	`setAcceptRanges(String acceptRanges)` Indicate that a range of bytes was specified.
`void`	`setBucketKeyEnabled(Boolean bucketKeyEnabled)` Indicate whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
`void`	`setCacheControl(String cacheControl)` Specify caching behavior along the request/reply chain.
`void`	`setContentDisposition(String contentDisposition)` Specify presentational information for the object.
`void`	`setContentEncoding(String contentEncoding)` Specify 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.
`void`	`setContentLanguage(String contentLanguage)` Set the language the content is in..
`void`	`setContentLength(Long contentLength)` Set the size of the body in bytes.
`void`	`setContentRange(String contentRange)` Set the portion of the object returned in the response.
`void`	`setContentType(String contentType)` Set the standard MIME type describing the format of the object data.
`void`	`setDeleteMarker(String deleteMarker)` Set whether an object stored in Amazon S3 is (`true`) or is not (`false`) a delete marker.
`void`	`setErrorCode(String errorCode)` Set a string that uniquely identifies an error condition.
`void`	`setErrorMessage(String errorMessage)` Set a generic description of the error condition.
`void`	`setETag(String eTag)` Set an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
`void`	`setExpiration(String expiration)` If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
`void`	`setExpires(Date expires)` Set the date and time at which the object is no longer cacheable.
`void`	`setFile(File file)`
`void`	`setInputStream(InputStream inputStream)`
`void`	`setLastModified(Date lastModified)` Set the date and time the object was last modified.
`void`	`setMetadata(ObjectMetadata metadata)` Set a map of metadata to store with the object in S3.
`void`	`setMissingMeta(Integer missingMeta)` Set the number of metadata entries not returned in `x-amz-meta` headers.
`void`	`setObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)` Set whether an object stored in Amazon S3 has an active legal hold.
`void`	`setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)` Set whether an object stored in Amazon S3 has an active legal hold.
`void`	`setObjectLockMode(ObjectLockMode objectLockMode)` Set whether an object stored in Amazon S3 has Object Lock enabled.
`void`	`setObjectLockMode(String objectLockMode)` Set whether an object stored in Amazon S3 has Object Lock enabled.
`void`	`setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)` Set the date and time when Object Lock is configured to expire.
`void`	`setPartsCount(Integer partsCount)` Set the count of parts this object has.
`void`	`setReplicationStatus(String replicationStatus)` Set if request involves bucket that is either a source or destination in a Replication rule.
`void`	`setRequestCharged(String requestCharged)` Set the value of the RequestCharged property for this object.
`void`	`setRequestRoute(String requestRoute)` Set the route prefix to the HTTP URL generated.
`void`	`setRequestToken(String requestToken)` Set a single use encrypted token that maps `WriteGetObjectResponse` to the end user `GetObject` request.
`void`	`setRestore(String restore)` Set information about object restoration operation and expiration time of the restored object copy.
`void`	`setServerSideEncryption(String serverSideEncryption)` Set the server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, `aws:kms`)).
`void`	`setSSECustomerAlgorithm(String sSECustomerAlgorithm)` Set the algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
`void`	`setSSECustomerKeyMD5(String sSECustomerKeyMD5)` Set the 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3.
`void`	`setSSEKMSKeyId(String sSEKMSKeyId)` Specify the ID of the Amazon Web Services Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
`void`	`setStatusCode(Integer statusCode)` Set the integer status code for an HTTP response of a corresponding `GetObject` request.
`void`	`setStorageClass(StorageClass storageClass)` Set the class of storage used to store object in Amazon S3.
`void`	`setStorageClass(String storageClass)` Set the class of storage used to store object in Amazon S3.
`void`	`setTagCount(Integer tagCount)` Set the number of tags, if any, on the object.
`void`	`setVersionId(String versionId)` Set an ID used to reference a specific version of the object.
`WriteGetObjectResponseRequest`	`withAcceptRanges(String acceptRanges)` Indicate that a range of bytes was specified.
`WriteGetObjectResponseRequest`	`withBucketKeyEnabled(Boolean bucketKeyEnabled)` Indicate whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
`WriteGetObjectResponseRequest`	`withCacheControl(String cacheControl)` Specify caching behavior along the request/reply chain.
`WriteGetObjectResponseRequest`	`withContentDisposition(String contentDisposition)` Specify presentational information for the object.
`WriteGetObjectResponseRequest`	`withContentEncoding(String contentEncoding)` Specify 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.
`WriteGetObjectResponseRequest`	`withContentLanguage(String contentLanguage)` Set the language the content is in.
`WriteGetObjectResponseRequest`	`withContentLength(Long contentLength)` Set the size of the body in bytes.
`WriteGetObjectResponseRequest`	`withContentRange(String contentRange)` Set the portion of the object returned in the response.
`WriteGetObjectResponseRequest`	`withContentType(String contentType)` Set the standard MIME type describing the format of the object data.
`WriteGetObjectResponseRequest`	`withDeleteMarker(String deleteMarker)` Set whether an object stored in Amazon S3 is (`true`) or is not (`false`) a delete marker.
`WriteGetObjectResponseRequest`	`withErrorCode(String errorCode)` Set a string that uniquely identifies an error condition.
`WriteGetObjectResponseRequest`	`withErrorMessage(String errorMessage)` Set a generic description of the error condition.
`WriteGetObjectResponseRequest`	`withETag(String eTag)` Set an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
`WriteGetObjectResponseRequest`	`withExpiration(String expiration)` If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
`WriteGetObjectResponseRequest`	`withExpires(Date expires)` Set the date and time at which the object is no longer cacheable.
`WriteGetObjectResponseRequest`	`withFile(File file)`
`WriteGetObjectResponseRequest`	`withInputStream(InputStream inputStream)`
`WriteGetObjectResponseRequest`	`withLastModified(Date lastModified)` Set the date and time the object was last modified.
`WriteGetObjectResponseRequest`	`withMetadata(ObjectMetadata metadata)` Set a map of metadata to store with the object in S3.
`WriteGetObjectResponseRequest`	`withMissingMeta(Integer missingMeta)` Set the number of metadata entries not returned in `x-amz-meta` headers.
`WriteGetObjectResponseRequest`	`withObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)` Set whether an object stored in Amazon S3 has an active legal hold.
`WriteGetObjectResponseRequest`	`withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)` Set whether an object stored in Amazon S3 has an active legal hold.
`WriteGetObjectResponseRequest`	`withObjectLockMode(ObjectLockMode objectLockMode)` Set whether an object stored in Amazon S3 has Object Lock enabled.
`WriteGetObjectResponseRequest`	`withObjectLockMode(String objectLockMode)` Set whether an object stored in Amazon S3 has Object Lock enabled.
`WriteGetObjectResponseRequest`	`withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)` Set the date and time when Object Lock is configured to expire.
`WriteGetObjectResponseRequest`	`withPartsCount(Integer partsCount)` Set the count of parts this object has.
`WriteGetObjectResponseRequest`	`withReplicationStatus(String replicationStatus)` Set if request involves bucket that is either a source or destination in a Replication rule.
`WriteGetObjectResponseRequest`	`withRequestCharged(String requestCharged)` Set the value of the RequestCharged property for this object.
`WriteGetObjectResponseRequest`	`withRequestRoute(String requestRoute)` Set the route prefix to the HTTP URL generated.
`WriteGetObjectResponseRequest`	`withRequestToken(String requestToken)` Set a single use encrypted token that maps `WriteGetObjectResponse` to the end user `GetObject` request.
`WriteGetObjectResponseRequest`	`withRestore(String restore)` Set information about object restoration operation and expiration time of the restored object copy.
`WriteGetObjectResponseRequest`	`withServerSideEncryption(String serverSideEncryption)` Set the server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, `aws:kms`)).
`WriteGetObjectResponseRequest`	`withSSECustomerAlgorithm(String sSECustomerAlgorithm)` Set the algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
`WriteGetObjectResponseRequest`	`withSSECustomerKeyMD5(String sSECustomerKeyMD5)` Set the 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3.
`WriteGetObjectResponseRequest`	`withSSEKMSKeyId(String sSEKMSKeyId)` Specify the ID of the Amazon Web Services Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
`WriteGetObjectResponseRequest`	`withStatusCode(Integer statusCode)` Set the integer status code for an HTTP response of a corresponding `GetObject` request.
`WriteGetObjectResponseRequest`	`withStorageClass(StorageClass storageClass)` Set the class of storage used to store object in Amazon S3.
`WriteGetObjectResponseRequest`	`withStorageClass(String storageClass)` Set the class of storage used to store object in Amazon S3.
`WriteGetObjectResponseRequest`	`withTagCount(Integer tagCount)` Set the number of tags, if any, on the object.
`WriteGetObjectResponseRequest`	`withVersionId(String versionId)` Set an ID used to reference a specific version of the object.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WriteGetObjectResponseRequest
```
public WriteGetObjectResponseRequest()
```
- Method Detail
  - withRequestRoute
```
public WriteGetObjectResponseRequest withRequestRoute(String requestRoute)
```
    Set the route prefix to the HTTP URL generated.
    
    Returns:
    
    this object for method chaning.
  - setRequestRoute
```
public void setRequestRoute(String requestRoute)
```
    Set the route prefix to the HTTP URL generated.
  - getRequestRoute
```
public String getRequestRoute()
```
    The route prefix to the HTTP URL generated.
  - withRequestToken
```
public WriteGetObjectResponseRequest withRequestToken(String requestToken)
```
    Set a single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
    
    Returns:
    
    This object for method chaining.
  - setRequestToken
```
public void setRequestToken(String requestToken)
```
    Set a single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
  - getRequestToken
```
public String getRequestToken()
```
    A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
  - withStatusCode
```
public WriteGetObjectResponseRequest withStatusCode(Integer statusCode)
```
    Set the integer status code for an HTTP response of a corresponding GetObject request.
    Status Codes
    - 200 - OK
    - 206 - Partial Content
    - 304 - Not Modified
    - 400 - Bad Request
    - 401 - Unauthorized
    - 403 - Forbidden
    - 404 - Not Found
    - 405 - Method Not Allowed
    - 409 - Conflict
    - 411 - Length Required
    - 412 - Precondition Failed
    - 416 - Range Not Satisfiable
    - 500 - Internal Server Error
    - 503 - Service Unavailable
    Returns:
    
    This object for method chaining.
  - setStatusCode
```
public void setStatusCode(Integer statusCode)
```
    Set the integer status code for an HTTP response of a corresponding GetObject request.
    Status Codes
    - 200 - OK
    - 206 - Partial Content
    - 304 - Not Modified
    - 400 - Bad Request
    - 401 - Unauthorized
    - 403 - Forbidden
    - 404 - Not Found
    - 405 - Method Not Allowed
    - 409 - Conflict
    - 411 - Length Required
    - 412 - Precondition Failed
    - 416 - Range Not Satisfiable
    - 500 - Internal Server Error
    - 503 - Service Unavailable
  - getStatusCode
```
public Integer getStatusCode()
```
    The integer status code for an HTTP response of a corresponding GetObject request.
    Status Codes
    - 200 - OK
    - 206 - Partial Content
    - 304 - Not Modified
    - 400 - Bad Request
    - 401 - Unauthorized
    - 403 - Forbidden
    - 404 - Not Found
    - 405 - Method Not Allowed
    - 409 - Conflict
    - 411 - Length Required
    - 412 - Precondition Failed
    - 416 - Range Not Satisfiable
    - 500 - Internal Server Error
    - 503 - Service Unavailable
  - withErrorCode
```
public WriteGetObjectResponseRequest withErrorCode(String errorCode)
```
    Set a string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body.
    
    Returns:
    
    This object for method chaining.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    Set a string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body.
  - getErrorCode
```
public String getErrorCode()
```
    A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body.
  - withErrorMessage
```
public WriteGetObjectResponseRequest withErrorMessage(String errorMessage)
```
    Set a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
    
    Returns:
    
    This object for method chaining.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Set a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
  - getErrorMessage
```
public String getErrorMessage()
```
    A generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
  - withAcceptRanges
```
public WriteGetObjectResponseRequest withAcceptRanges(String acceptRanges)
```
    Indicate that a range of bytes was specified.
    
    Returns:
    
    This object for method chaining.
  - setAcceptRanges
```
public void setAcceptRanges(String acceptRanges)
```
    Indicate that a range of bytes was specified.
  - getAcceptRanges
```
public String getAcceptRanges()
```
    Indicates that a range of bytes was specified.
  - withCacheControl
```
public WriteGetObjectResponseRequest withCacheControl(String cacheControl)
```
    Specify caching behavior along the request/reply chain.
    
    Returns:
    
    This object for method chaining.
  - setCacheControl
```
public void setCacheControl(String cacheControl)
```
    Specify caching behavior along the request/reply chain.
  - getCacheControl
```
public String getCacheControl()
```
    The caching behavior along the request/reply chain.
  - withContentDisposition
```
public WriteGetObjectResponseRequest withContentDisposition(String contentDisposition)
```
    Specify presentational information for the object.
    
    Returns:
    
    This object for method chaining.
  - setContentDisposition
```
public void setContentDisposition(String contentDisposition)
```
    Specify presentational information for the object.
  - getContentDisposition
```
public String getContentDisposition()
```
    The presentational information for the object.
  - withContentEncoding
```
public WriteGetObjectResponseRequest withContentEncoding(String contentEncoding)
```
    Specify 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:
    
    This object for method chaining.
  - setContentEncoding
```
public void setContentEncoding(String contentEncoding)
```
    Specify 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.
  - getContentEncoding
```
public String getContentEncoding()
```
    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.
  - withContentLanguage
```
public WriteGetObjectResponseRequest withContentLanguage(String contentLanguage)
```
    Set the language the content is in.
    
    Returns:
    
    This object for method chaining.
  - setContentLanguage
```
public void setContentLanguage(String contentLanguage)
```
    Set the language the content is in..
  - getContentLanguage
```
public String getContentLanguage()
```
    The language the content is in.
  - withContentLength
```
public WriteGetObjectResponseRequest withContentLength(Long contentLength)
```
    Set the size of the body in bytes.
    
    Returns:
    
    This object for method chaining.
  - setContentLength
```
public void setContentLength(Long contentLength)
```
    Set the size of the body in bytes.
  - getContentLength
```
public Long getContentLength()
```
    The size of the body in bytes.
  - withContentRange
```
public WriteGetObjectResponseRequest withContentRange(String contentRange)
```
    Set the portion of the object returned in the response.
    
    Returns:
    
    This object for method chaining.
  - setContentRange
```
public void setContentRange(String contentRange)
```
    Set the portion of the object returned in the response.
  - getContentRange
```
public String getContentRange()
```
    The portion of the object returned in the response.
  - withDeleteMarker
```
public WriteGetObjectResponseRequest withDeleteMarker(String deleteMarker)
```
    Set whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.
    
    Returns:
    
    This object for method chaining.
  - setDeleteMarker
```
public void setDeleteMarker(String deleteMarker)
```
    Set whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.
  - getDeleteMarker
```
public String getDeleteMarker()
```
    Whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.
  - withETag
```
public WriteGetObjectResponseRequest withETag(String eTag)
```
    Set an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
    
    Returns:
    
    This object for method chaining.
  - setETag
```
public void setETag(String eTag)
```
    Set an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
  - getETag
```
public String getETag()
```
    An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
  - withExpires
```
public WriteGetObjectResponseRequest withExpires(Date expires)
```
    Set the date and time at which the object is no longer cacheable.
    
    Returns:
    
    This object for method chaining.
  - setExpires
```
public void setExpires(Date expires)
```
    Set the date and time at which the object is no longer cacheable.
  - getExpires
```
public Date getExpires()
```
    The date and time at which the object is no longer cacheable.
  - withExpiration
```
public WriteGetObjectResponseRequest withExpiration(String expiration)
```
    If the object expiration is configured (see PUT Bucket lifecycle), 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.
    
    Returns:
    
    This object for method chaining.
  - setExpiration
```
public void setExpiration(String expiration)
```
    If the object expiration is configured (see PUT Bucket lifecycle), 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.
  - getExpiration
```
public String getExpiration()
```
    If the object expiration is configured (see PUT Bucket lifecycle), 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.
  - withLastModified
```
public WriteGetObjectResponseRequest withLastModified(Date lastModified)
```
    Set the date and time the object was last modified.
    
    Returns:
    
    This object for method chaining.
  - setLastModified
```
public void setLastModified(Date lastModified)
```
    Set the date and time the object was last modified.
  - getLastModified
```
public Date getLastModified()
```
    The date and time the object was last modified.
  - withMissingMeta
```
public WriteGetObjectResponseRequest withMissingMeta(Integer missingMeta)
```
    Set the number of metadata entries not returned in x-amz-meta headers. 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.
    
    Returns:
    
    This object for method chaining.
  - setMissingMeta
```
public void setMissingMeta(Integer missingMeta)
```
    Set the number of metadata entries not returned in x-amz-meta headers. 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.
  - getMissingMeta
```
public Integer getMissingMeta()
```
    The number of metadata entries not returned in x-amz-meta headers. 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.
  - withObjectLockMode
```
public WriteGetObjectResponseRequest withObjectLockMode(String objectLockMode)
```
    Set whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
    
    Returns:
    
    This object for method chaining.
  - withObjectLockMode
```
public WriteGetObjectResponseRequest withObjectLockMode(ObjectLockMode objectLockMode)
```
    Set whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
    
    Returns:
    
    This object for method chaining.
  - setObjectLockMode
```
public void setObjectLockMode(String objectLockMode)
```
    Set whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
  - setObjectLockMode
```
public void setObjectLockMode(ObjectLockMode objectLockMode)
```
    Set whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
  - getObjectLockMode
```
public String getObjectLockMode()
```
    Whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
  - withObjectLockLegalHoldStatus
```
public WriteGetObjectResponseRequest withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
```
    Set whether an object stored in Amazon S3 has an active legal hold.
    
    Returns:
    
    This object for method chaining.
  - withObjectLockLegalHoldStatus
```
public WriteGetObjectResponseRequest withObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
```
    Set whether an object stored in Amazon S3 has an active legal hold.
    
    Returns:
    
    This object for method chaining.
  - setObjectLockLegalHoldStatus
```
public void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
```
    Set whether an object stored in Amazon S3 has an active legal hold.
  - setObjectLockLegalHoldStatus
```
public void setObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
```
    Set whether an object stored in Amazon S3 has an active legal hold.
  - getObjectLockLegalHoldStatus
```
public String getObjectLockLegalHoldStatus()
```
    Whether an object stored in Amazon S3 has an active legal hold.
  - withObjectLockRetainUntilDate
```
public WriteGetObjectResponseRequest withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
```
    Set the date and time when Object Lock is configured to expire.
    
    Returns:
    
    This object for method chaining.
  - setObjectLockRetainUntilDate
```
public void setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
```
    Set the date and time when Object Lock is configured to expire.
  - getObjectLockRetainUntilDate
```
public Date getObjectLockRetainUntilDate()
```
    The date and time when Object Lock is configured to expire.
  - withPartsCount
```
public WriteGetObjectResponseRequest withPartsCount(Integer partsCount)
```
    Set the count of parts this object has.
    
    Returns:
    
    This object for method chaining.
  - setPartsCount
```
public void setPartsCount(Integer partsCount)
```
    Set the count of parts this object has.
  - getPartsCount
```
public Integer getPartsCount()
```
    The count of parts this object has.
  - withReplicationStatus
```
public WriteGetObjectResponseRequest withReplicationStatus(String replicationStatus)
```
    Set if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
    
    Returns:
    
    This object for method chaining.
  - setReplicationStatus
```
public void setReplicationStatus(String replicationStatus)
```
    Set if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
  - getReplicationStatus
```
public String getReplicationStatus()
```
    If request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
  - withRequestCharged
```
public WriteGetObjectResponseRequest withRequestCharged(String requestCharged)
```
    Set the value of the RequestCharged property for this object.
    
    Returns:
    
    This object for method chaining.
  - setRequestCharged
```
public void setRequestCharged(String requestCharged)
```
    Set the value of the RequestCharged property for this object.
  - getRequestCharged
```
public String getRequestCharged()
```
    The value of the RequestCharged property for this object.
  - withRestore
```
public WriteGetObjectResponseRequest withRestore(String restore)
```
    Set information about object restoration operation and expiration time of the restored object copy.
    
    Returns:
    
    This object for method chaining.
  - setRestore
```
public void setRestore(String restore)
```
    Set information about object restoration operation and expiration time of the restored object copy.
  - getRestore
```
public String getRestore()
```
    Information about object restoration operation and expiration time of the restored object copy.
  - withServerSideEncryption
```
public WriteGetObjectResponseRequest withServerSideEncryption(String serverSideEncryption)
```
    Set the server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms)).
    
    Returns:
    
    This object for method chaining.
  - setServerSideEncryption
```
public void setServerSideEncryption(String serverSideEncryption)
```
    Set the server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms)).
  - getServerSideEncryption
```
public String getServerSideEncryption()
```
    The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms)).
  - withSSECustomerAlgorithm
```
public WriteGetObjectResponseRequest withSSECustomerAlgorithm(String sSECustomerAlgorithm)
```
    Set the algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
    
    Returns:
    
    this object for method chaining.
  - setSSECustomerAlgorithm
```
public void setSSECustomerAlgorithm(String sSECustomerAlgorithm)
```
    Set the algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
  - getSSECustomerAlgorithm
```
public String getSSECustomerAlgorithm()
```
    The algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
  - withSSEKMSKeyId
```
public WriteGetObjectResponseRequest withSSEKMSKeyId(String sSEKMSKeyId)
```
    Specify the ID of the Amazon Web Services Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
    
    Returns:
    
    this object for method chaining.
  - setSSEKMSKeyId
```
public void setSSEKMSKeyId(String sSEKMSKeyId)
```
    Specify the ID of the Amazon Web Services Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
  - getSSEKMSKeyId
```
public String getSSEKMSKeyId()
```
    If present, specifies the ID of the Amazon Web Services Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
  - withSSECustomerKeyMD5
```
public WriteGetObjectResponseRequest withSSECustomerKeyMD5(String sSECustomerKeyMD5)
```
    Set the 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
    
    Returns:
    
    this object for method chaining.
  - setSSECustomerKeyMD5
```
public void setSSECustomerKeyMD5(String sSECustomerKeyMD5)
```
    Set the 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
  - getSSECustomerKeyMD5
```
public String getSSECustomerKeyMD5()
```
    The 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
    
    Returns:
    
    this object for method chaining.
  - withStorageClass
```
public WriteGetObjectResponseRequest withStorageClass(String storageClass)
```
    Set the class of storage used to store object in Amazon S3.
    
    Returns:
    
    This object for method chaining.
  - withStorageClass
```
public WriteGetObjectResponseRequest withStorageClass(StorageClass storageClass)
```
    Set the class of storage used to store object in Amazon S3.
    
    Returns:
    
    This object for method chaining.
  - setStorageClass
```
public void setStorageClass(String storageClass)
```
    Set the class of storage used to store object in Amazon S3.
  - setStorageClass
```
public void setStorageClass(StorageClass storageClass)
```
    Set the class of storage used to store object in Amazon S3.
  - getStorageClass
```
public String getStorageClass()
```
    The class of storage used to store object in Amazon S3.
  - withTagCount
```
public WriteGetObjectResponseRequest withTagCount(Integer tagCount)
```
    Set the number of tags, if any, on the object.
    
    Returns:
    
    This object for method chaining.
  - setTagCount
```
public void setTagCount(Integer tagCount)
```
    Set the number of tags, if any, on the object.
  - getTagCount
```
public Integer getTagCount()
```
    The number of tags, if any, on the object.
  - withVersionId
```
public WriteGetObjectResponseRequest withVersionId(String versionId)
```
    Set an ID used to reference a specific version of the object.
    
    Returns:
    
    This object for method chaining.
  - setVersionId
```
public void setVersionId(String versionId)
```
    Set an ID used to reference a specific version of the object.
  - getVersionId
```
public String getVersionId()
```
    An ID used to reference a specific version of the object.
  - withBucketKeyEnabled
```
public WriteGetObjectResponseRequest withBucketKeyEnabled(Boolean bucketKeyEnabled)
```
    Indicate whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
    
    Returns:
    
    This object for method chaining.
  - setBucketKeyEnabled
```
public void setBucketKeyEnabled(Boolean bucketKeyEnabled)
```
    Indicate whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
  - getBucketKeyEnabled
```
public Boolean getBucketKeyEnabled()
```
    Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
  - withContentType
```
public WriteGetObjectResponseRequest withContentType(String contentType)
```
    Set the standard MIME type describing the format of the object data.
    
    Returns:
    
    This object for method chaining.
  - setContentType
```
public void setContentType(String contentType)
```
    Set the standard MIME type describing the format of the object data.
  - getContentType
```
public String getContentType()
```
    The standard MIME type describing the format of the object data.
  - withMetadata
```
public WriteGetObjectResponseRequest withMetadata(ObjectMetadata metadata)
```
    Set a map of metadata to store with the object in S3.
    
    Returns:
    
    This object for method chaining.
  - setMetadata
```
public void setMetadata(ObjectMetadata metadata)
```
    Set a map of metadata to store with the object in S3.
  - getMetadata
```
public ObjectMetadata getMetadata()
```
    A map of metadata to store with the object in S3.
  - withInputStream
```
public WriteGetObjectResponseRequest withInputStream(InputStream inputStream)
```
  - setInputStream
```
public void setInputStream(InputStream inputStream)
```
    Specified by:
    
    setInputStream in interface S3DataSource
  - getInputStream
```
public InputStream getInputStream()
```
    Specified by:
    
    getInputStream in interface S3DataSource
  - withFile
```
public WriteGetObjectResponseRequest withFile(File file)
```
  - setFile
```
public void setFile(File file)
```
    Specified by:
    
    setFile in interface S3DataSource
  - getFile
```
public File getFile()
```
    Specified by:
    
    getFile in interface S3DataSource
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class WriteGetObjectResponseRequest

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.s3.model.S3DataSource

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

WriteGetObjectResponseRequest

Method Detail

withRequestRoute

setRequestRoute

getRequestRoute

withRequestToken

setRequestToken

getRequestToken

withStatusCode

setStatusCode

getStatusCode

withErrorCode

setErrorCode

getErrorCode

withErrorMessage

setErrorMessage

getErrorMessage

withAcceptRanges

setAcceptRanges

getAcceptRanges

withCacheControl

setCacheControl

getCacheControl

withContentDisposition

setContentDisposition

getContentDisposition

withContentEncoding

setContentEncoding

getContentEncoding

withContentLanguage

setContentLanguage

getContentLanguage

withContentLength

setContentLength

getContentLength

withContentRange

setContentRange

getContentRange

withDeleteMarker

setDeleteMarker

getDeleteMarker

withETag

setETag

getETag

withExpires

setExpires

getExpires

withExpiration

setExpiration

getExpiration

withLastModified

setLastModified

getLastModified

withMissingMeta

setMissingMeta

getMissingMeta

withObjectLockMode

withObjectLockMode

setObjectLockMode

setObjectLockMode

getObjectLockMode

withObjectLockLegalHoldStatus

withObjectLockLegalHoldStatus

setObjectLockLegalHoldStatus

setObjectLockLegalHoldStatus

getObjectLockLegalHoldStatus

withObjectLockRetainUntilDate

setObjectLockRetainUntilDate

getObjectLockRetainUntilDate

withPartsCount