GetObjectResponse.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.objectstorage.responses.GetObjectResponse.Builder

All Implemented Interfaces:: BmcResponse.Builder<GetObjectResponse>

Enclosing class:: GetObjectResponse

public static class GetObjectResponse.Builder
extends Object
implements BmcResponse.Builder<GetObjectResponse>

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetObjectResponse.Builder`	`__httpStatusCode__(int __httpStatusCode__)`
`GetObjectResponse.Builder`	`archivalState(ArchivalState archivalState)` Archival state of an object.
`GetObjectResponse`	`build()` Build the response object.
`GetObjectResponse.Builder`	`cacheControl(String cacheControl)` Cache-Control header, as described in RFC 2616.
`GetObjectResponse.Builder`	`contentDisposition(String contentDisposition)` Content-Disposition header, as described in RFC 2616.
`GetObjectResponse.Builder`	`contentEncoding(String contentEncoding)` Content-Encoding header, as described in RFC 2616.
`GetObjectResponse.Builder`	`contentLanguage(String contentLanguage)` Content-Language header, as described in RFC 2616.
`GetObjectResponse.Builder`	`contentLength(Long contentLength)` The object size in bytes.
`GetObjectResponse.Builder`	`contentMd5(String contentMd5)` Content-MD5 header, as described in RFC 2616.
`GetObjectResponse.Builder`	`contentRange(Range contentRange)` Content-Range header for range requests, per RFC 7233.
`GetObjectResponse.Builder`	`contentType(String contentType)` Content-Type header, as described in RFC 2616.
`GetObjectResponse.Builder`	`copy(GetObjectResponse o)` Copy method to populate the builder with values from the given instance.
`GetObjectResponse.Builder`	`eTag(String eTag)` The entity tag (ETag) for the object.
`GetObjectResponse.Builder`	`expires(Date expires)` The date and time after which the object is no longer cached by a browser, proxy, or other caching entity.
`GetObjectResponse.Builder`	`headers(Map<String,List<String>> headers)`
`GetObjectResponse.Builder`	`inputStream(InputStream inputStream)` The returned java.io.InputStream instance, or null if `GetObjectResponse.isNotModified()` is true.
`GetObjectResponse.Builder`	`isNotModified(boolean isNotModified)` Flag to indicate whether or not the object was modified.
`GetObjectResponse.Builder`	`lastModified(Date lastModified)` The object modification time, as described in RFC 2616.
`GetObjectResponse.Builder`	`opcClientRequestId(String opcClientRequestId)` Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
`GetObjectResponse.Builder`	`opcContentCrc32c(String opcContentCrc32c)` The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the object.
`GetObjectResponse.Builder`	`opcContentSha256(String opcContentSha256)` Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload.
`GetObjectResponse.Builder`	`opcContentSha384(String opcContentSha384)` Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload.
`GetObjectResponse.Builder`	`opcMeta(Map<String,String> opcMeta)` The user-defined metadata for the object.
`GetObjectResponse.Builder`	`opcMultipartMd5(String opcMultipartMd5)` Only applicable to objects uploaded using multipart upload.
`GetObjectResponse.Builder`	`opcMultipartSha256(String opcMultipartSha256)` Only applicable to objects uploaded using multipart upload.
`GetObjectResponse.Builder`	`opcMultipartSha384(String opcMultipartSha384)` Only applicable to objects uploaded using multipart upload.
`GetObjectResponse.Builder`	`opcRequestId(String opcRequestId)` Unique Oracle-assigned identifier for the request.
`GetObjectResponse.Builder`	`storageTier(StorageTier storageTier)` The storage tier that the object is stored in.
`GetObjectResponse.Builder`	`timeOfArchival(Date timeOfArchival)` Time that the object is returned to the archived state.
`GetObjectResponse.Builder`	`versionId(String versionId)` VersionId of the object

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - __httpStatusCode__
```
public GetObjectResponse.Builder __httpStatusCode__(int __httpStatusCode__)
```
    Specified by:
    
    __httpStatusCode__ in interface BmcResponse.Builder<GetObjectResponse>
  - headers
```
public GetObjectResponse.Builder headers(Map<String,List<String>> headers)
```
    Specified by:
    
    headers in interface BmcResponse.Builder<GetObjectResponse>
  - opcClientRequestId
```
public GetObjectResponse.Builder opcClientRequestId(String opcClientRequestId)
```
    Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
    
    Parameters:
    
    opcClientRequestId - the value to set
    
    Returns:
    
    this builder
  - opcRequestId
```
public GetObjectResponse.Builder opcRequestId(String opcRequestId)
```
    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide this request ID.
    
    Parameters:
    
    opcRequestId - the value to set
    
    Returns:
    
    this builder
  - eTag
```
public GetObjectResponse.Builder eTag(String eTag)
```
    The entity tag (ETag) for the object.
    
    Parameters:
    
    eTag - the value to set
    
    Returns:
    
    this builder
  - opcMeta
```
public GetObjectResponse.Builder opcMeta(Map<String,String> opcMeta)
```
    The user-defined metadata for the object.
    
    Parameters:
    
    opcMeta - the value to set
    
    Returns:
    
    this builder
  - contentLength
```
public GetObjectResponse.Builder contentLength(Long contentLength)
```
    The object size in bytes.
    
    Parameters:
    
    contentLength - the value to set
    
    Returns:
    
    this builder
  - contentRange
```
public GetObjectResponse.Builder contentRange(Range contentRange)
```
    Content-Range header for range requests, per RFC 7233.
    
    Parameters:
    
    contentRange - the value to set
    
    Returns:
    
    this builder
  - contentMd5
```
public GetObjectResponse.Builder contentMd5(String contentMd5)
```
    Content-MD5 header, as described in RFC 2616. Unavailable for objects uploaded using multipart upload.
    
    Parameters:
    
    contentMd5 - the value to set
    
    Returns:
    
    this builder
  - opcMultipartMd5
```
public GetObjectResponse.Builder opcMultipartMd5(String opcMultipartMd5)
```
    Only applicable to objects uploaded using multipart upload. Base-64 representation of the multipart object hash. The multipart object hash is calculated by taking the MD5 hashes of the parts, concatenating the binary representation of those hashes in order of their part numbers, and then calculating the MD5 hash of the concatenated values.
    
    Parameters:
    
    opcMultipartMd5 - the value to set
    
    Returns:
    
    this builder
  - opcContentCrc32c
```
public GetObjectResponse.Builder opcContentCrc32c(String opcContentCrc32c)
```
    The base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the object. Even for objects uploaded using multipart upload, this header returns the CRC32C (Castagnoli) checksum of the complete reconstructed object.
    
    Parameters:
    
    opcContentCrc32c - the value to set
    
    Returns:
    
    this builder
  - opcContentSha256
```
public GetObjectResponse.Builder opcContentSha256(String opcContentSha256)
```
    Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload. The base64-encoded SHA256 hash of the object as computed during upload. Unavailable for objects uploaded using multipart upload.
    
    Parameters:
    
    opcContentSha256 - the value to set
    
    Returns:
    
    this builder
  - opcMultipartSha256
```
public GetObjectResponse.Builder opcMultipartSha256(String opcMultipartSha256)
```
    Only applicable to objects uploaded using multipart upload. Applicable only if SHA256 was specified in the opc-checksum-algorithm request header during upload. Base-64 representation of the multipart object SHA256 hash. The multipart object hash is calculated by taking the SHA256 hashes of the parts, concatenating the binary representation of those hashes in order of their part numbers, and then calculating the SHA256 hash of the concatenated values.
    
    Parameters:
    
    opcMultipartSha256 - the value to set
    
    Returns:
    
    this builder
  - opcContentSha384
```
public GetObjectResponse.Builder opcContentSha384(String opcContentSha384)
```
    Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload. The base64-encoded SHA384 hash of the object as computed during upload. Unavailable for objects uploaded using multipart upload.
    
    Parameters:
    
    opcContentSha384 - the value to set
    
    Returns:
    
    this builder
  - opcMultipartSha384
```
public GetObjectResponse.Builder opcMultipartSha384(String opcMultipartSha384)
```
    Only applicable to objects uploaded using multipart upload. Applicable only if SHA384 was specified in the opc-checksum-algorithm request header during upload. Base-64 representation of the multipart object SHA384 hash. The multipart object hash is calculated by taking the SHA384 hashes of the parts, concatenating the binary representation of those hashes in order of their part numbers, and then calculating the SHA384 hash of the concatenated values.
    
    Parameters:
    
    opcMultipartSha384 - the value to set
    
    Returns:
    
    this builder
  - contentType
```
public GetObjectResponse.Builder contentType(String contentType)
```
    Content-Type header, as described in RFC 2616.
    
    Parameters:
    
    contentType - the value to set
    
    Returns:
    
    this builder
  - contentLanguage
```
public GetObjectResponse.Builder contentLanguage(String contentLanguage)
```
    Content-Language header, as described in RFC 2616.
    
    Parameters:
    
    contentLanguage - the value to set
    
    Returns:
    
    this builder
  - contentEncoding
```
public GetObjectResponse.Builder contentEncoding(String contentEncoding)
```
    Content-Encoding header, as described in RFC 2616.
    
    Parameters:
    
    contentEncoding - the value to set
    
    Returns:
    
    this builder
  - cacheControl
```
public GetObjectResponse.Builder cacheControl(String cacheControl)
```
    Cache-Control header, as described in RFC 2616.
    
    Parameters:
    
    cacheControl - the value to set
    
    Returns:
    
    this builder
  - contentDisposition
```
public GetObjectResponse.Builder contentDisposition(String contentDisposition)
```
    Content-Disposition header, as described in RFC 2616.
    
    Parameters:
    
    contentDisposition - the value to set
    
    Returns:
    
    this builder
  - lastModified
```
public GetObjectResponse.Builder lastModified(Date lastModified)
```
    The object modification time, as described in RFC 2616.
    
    Parameters:
    
    lastModified - the value to set
    
    Returns:
    
    this builder
  - storageTier
```
public GetObjectResponse.Builder storageTier(StorageTier storageTier)
```
    The storage tier that the object is stored in.
    
    Parameters:
    
    storageTier - the value to set
    
    Returns:
    
    this builder
  - archivalState
```
public GetObjectResponse.Builder archivalState(ArchivalState archivalState)
```
    Archival state of an object. This field is set only for objects in Archive tier.
    
    Parameters:
    
    archivalState - the value to set
    
    Returns:
    
    this builder
  - timeOfArchival
```
public GetObjectResponse.Builder timeOfArchival(Date timeOfArchival)
```
    Time that the object is returned to the archived state. This field is only present for restored objects.
    
    Parameters:
    
    timeOfArchival - the value to set
    
    Returns:
    
    this builder
  - versionId
```
public GetObjectResponse.Builder versionId(String versionId)
```
    VersionId of the object
    
    Parameters:
    
    versionId - the value to set
    
    Returns:
    
    this builder
  - expires
```
public GetObjectResponse.Builder expires(Date expires)
```
    The date and time after which the object is no longer cached by a browser, proxy, or other caching entity. See RFC 2616.
    
    Parameters:
    
    expires - the value to set
    
    Returns:
    
    this builder
  - inputStream
```
public GetObjectResponse.Builder inputStream(InputStream inputStream)
```
    The returned java.io.InputStream instance, or null if GetObjectResponse.isNotModified() is true.
    
    Parameters:
    
    inputStream - the value to set
    
    Returns:
    
    this builder
  - isNotModified
```
public GetObjectResponse.Builder isNotModified(boolean isNotModified)
```
    Flag to indicate whether or not the object was modified. If this is true, the getter for the object itself will return null. Callers should check this if they specified one of the request params that might result in a conditional response (like ‘if-match’/‘if-none-match’).
    
    Specified by:
    
    isNotModified in interface BmcResponse.Builder<GetObjectResponse>
    
    Parameters:
    
    true - if the object was not modified
  - copy
```
public GetObjectResponse.Builder copy(GetObjectResponse o)
```
    Copy method to populate the builder with values from the given instance.
    
    Specified by:
    
    copy in interface BmcResponse.Builder<GetObjectResponse>
    
    Parameters:
    
    o - other request from which to copy values
    
    Returns:
    
    this builder instance
  - build
```
public GetObjectResponse build()
```
    Build the response object.
    
    Specified by:
    
    build in interface BmcResponse.Builder<GetObjectResponse>
    
    Returns:
    
    the response object

Class GetObjectResponse.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

__httpStatusCode__

headers

opcClientRequestId

opcRequestId

eTag

opcMeta

contentLength

contentRange

contentMd5

opcMultipartMd5

opcContentCrc32c

opcContentSha256

opcMultipartSha256

opcContentSha384

opcMultipartSha384

contentType

contentLanguage

contentEncoding

cacheControl

contentDisposition

lastModified

storageTier

archivalState

timeOfArchival

versionId

expires

inputStream

isNotModified

copy

build

httpStatusCode