GetObjectResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.s3.model.S3Response
    - - software.amazon.awssdk.services.s3.model.GetObjectResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetObjectResponse
extends S3Response
implements ToCopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetObjectResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetObjectResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`acceptRanges()` Indicates that a range of bytes was specified.
`static GetObjectResponse.Builder`	`builder()`
`String`	`cacheControl()` Specifies caching behavior along the request/reply chain.
`String`	`contentDisposition()` Specifies presentational information for the object.
`String`	`contentEncoding()` Specifies 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`	`contentLanguage()` The language the content is in.
`Long`	`contentLength()` Size of the body in bytes.
`String`	`contentRange()` The portion of the object returned in the response.
`String`	`contentType()` A standard MIME type describing the format of the object data.
`Boolean`	`deleteMarker()` Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eTag()` An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
`String`	`expiration()` If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
`Instant`	`expires()` The date and time at which the object is no longer cacheable.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMetadata()` Returns true if the Metadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Instant`	`lastModified()` Last modified date of the object
`Map<String,String>`	`metadata()` A map of metadata to store with the object in S3.
`Integer`	`missingMeta()` This is set to the number of metadata entries not returned in `x-amz-meta` headers.
`ObjectLockLegalHoldStatus`	`objectLockLegalHoldStatus()` Indicates whether this object has an active legal hold.
`String`	`objectLockLegalHoldStatusAsString()` Indicates whether this object has an active legal hold.
`ObjectLockMode`	`objectLockMode()` The Object Lock mode currently in place for this object.
`String`	`objectLockModeAsString()` The Object Lock mode currently in place for this object.
`Instant`	`objectLockRetainUntilDate()` The date and time when this object's Object Lock will expire.
`Integer`	`partsCount()` The count of parts this object has.
`ReplicationStatus`	`replicationStatus()` Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
`String`	`replicationStatusAsString()` Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
`RequestCharged`	`requestCharged()` Returns the value of the RequestCharged property for this object.
`String`	`requestChargedAsString()` Returns the value of the RequestCharged property for this object.
`String`	`restore()` Provides information about object restoration operation and expiration time of the restored object copy.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetObjectResponse.Builder>`	`serializableBuilderClass()`
`ServerSideEncryption`	`serverSideEncryption()` The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
`String`	`serverSideEncryptionAsString()` The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
`String`	`sseCustomerAlgorithm()` If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
`String`	`sseCustomerKeyMD5()` If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
`String`	`ssekmsKeyId()` If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
`StorageClass`	`storageClass()` Provides storage class information of the object.
`String`	`storageClassAsString()` Provides storage class information of the object.
`Integer`	`tagCount()` The number of tags, if any, on the object.
`GetObjectResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`versionId()` Version of the object.
`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 class software.amazon.awssdk.services.s3.model.S3Response
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - deleteMarker
```
public Boolean deleteMarker()
```
    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
    
    Returns:
    
    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
  - acceptRanges
```
public String acceptRanges()
```
    Indicates that a range of bytes was specified.
    
    Returns:
    
    Indicates that a range of bytes was specified.
  - expiration
```
public 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:
    
    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.
  - restore
```
public String restore()
```
    Provides information about object restoration operation and expiration time of the restored object copy.
    
    Returns:
    
    Provides information about object restoration operation and expiration time of the restored object copy.
  - lastModified
```
public Instant lastModified()
```
    Last modified date of the object
    
    Returns:
    
    Last modified date of the object
  - contentLength
```
public Long contentLength()
```
    Size of the body in bytes.
    
    Returns:
    
    Size of the body in bytes.
  - eTag
```
public String eTag()
```
    An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
    
    Returns:
    
    An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
  - missingMeta
```
public Integer missingMeta()
```
    This is set to 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 is set to 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.
  - versionId
```
public String versionId()
```
    Version of the object.
    
    Returns:
    
    Version of the object.
  - cacheControl
```
public String cacheControl()
```
    Specifies caching behavior along the request/reply chain.
    
    Returns:
    
    Specifies caching behavior along the request/reply chain.
  - contentDisposition
```
public String contentDisposition()
```
    Specifies presentational information for the object.
    
    Returns:
    
    Specifies presentational information for the object.
  - contentEncoding
```
public String contentEncoding()
```
    Specifies 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:
    
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
  - contentLanguage
```
public String contentLanguage()
```
    The language the content is in.
    
    Returns:
    
    The language the content is in.
  - contentRange
```
public String contentRange()
```
    The portion of the object returned in the response.
    
    Returns:
    
    The portion of the object returned in the response.
  - contentType
```
public String contentType()
```
    A standard MIME type describing the format of the object data.
    
    Returns:
    
    A standard MIME type describing the format of the object data.
  - expires
```
public Instant expires()
```
    The date and time at which the object is no longer cacheable.
    
    Returns:
    
    The date and time at which the object is no longer cacheable.
  - websiteRedirectLocation
```
public 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.
    
    Returns:
    
    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.
  - serverSideEncryption
```
public ServerSideEncryption serverSideEncryption()
```
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().
    
    Returns:
    
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    See Also:
    
    ServerSideEncryption
  - serverSideEncryptionAsString
```
public String serverSideEncryptionAsString()
```
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().
    
    Returns:
    
    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
    
    See Also:
    
    ServerSideEncryption
  - hasMetadata
```
public boolean hasMetadata()
```
    Returns true if the Metadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - metadata
```
public Map<String,String> metadata()
```
    A map of metadata to store with the object in S3.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMetadata() to see if a value was sent in this field.
    
    Returns:
    
    A map of metadata to store with the object in S3.
  - sseCustomerAlgorithm
```
public String sseCustomerAlgorithm()
```
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
    
    Returns:
    
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
  - sseCustomerKeyMD5
```
public String sseCustomerKeyMD5()
```
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
    
    Returns:
    
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
  - ssekmsKeyId
```
public String ssekmsKeyId()
```
    If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
    
    Returns:
    
    If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
  - storageClass
```
public StorageClass storageClass()
```
    Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.
    
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.
    
    See Also:
    
    StorageClass
  - storageClassAsString
```
public String storageClassAsString()
```
    Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.
    
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.
    
    See Also:
    
    StorageClass
  - requestCharged
```
public RequestCharged requestCharged()
```
    Returns the value of the RequestCharged property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestCharged will return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().
    
    Returns:
    
    The value of the RequestCharged property for this object.
    
    See Also:
    
    RequestCharged
  - requestChargedAsString
```
public String requestChargedAsString()
```
    Returns the value of the RequestCharged property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestCharged will return RequestCharged.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestChargedAsString().
    
    Returns:
    
    The value of the RequestCharged property for this object.
    
    See Also:
    
    RequestCharged
  - replicationStatus
```
public ReplicationStatus replicationStatus()
```
    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    If the service returns an enum value that is not available in the current SDK version, replicationStatus will return ReplicationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replicationStatusAsString().
    
    Returns:
    
    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    See Also:
    
    ReplicationStatus
  - replicationStatusAsString
```
public String replicationStatusAsString()
```
    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    If the service returns an enum value that is not available in the current SDK version, replicationStatus will return ReplicationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replicationStatusAsString().
    
    Returns:
    
    Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
    
    See Also:
    
    ReplicationStatus
  - partsCount
```
public Integer partsCount()
```
    The count of parts this object has.
    
    Returns:
    
    The count of parts this object has.
  - tagCount
```
public Integer tagCount()
```
    The number of tags, if any, on the object.
    
    Returns:
    
    The number of tags, if any, on the object.
  - objectLockMode
```
public ObjectLockMode objectLockMode()
```
    The Object Lock mode currently in place for this object.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockMode will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().
    
    Returns:
    
    The Object Lock mode currently in place for this object.
    
    See Also:
    
    ObjectLockMode
  - objectLockModeAsString
```
public String objectLockModeAsString()
```
    The Object Lock mode currently in place for this object.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockMode will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().
    
    Returns:
    
    The Object Lock mode currently in place for this object.
    
    See Also:
    
    ObjectLockMode
  - objectLockRetainUntilDate
```
public Instant objectLockRetainUntilDate()
```
    The date and time when this object's Object Lock will expire.
    
    Returns:
    
    The date and time when this object's Object Lock will expire.
  - objectLockLegalHoldStatus
```
public 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.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockLegalHoldStatus will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockLegalHoldStatusAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ObjectLockLegalHoldStatus
  - objectLockLegalHoldStatusAsString
```
public String objectLockLegalHoldStatusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockLegalHoldStatus will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockLegalHoldStatusAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ObjectLockLegalHoldStatus
  - toBuilder
```
public GetObjectResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetObjectResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetObjectResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetObjectResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

deleteMarker

acceptRanges

expiration

restore

lastModified

contentLength

eTag

missingMeta

versionId

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentRange

contentType

expires

websiteRedirectLocation

serverSideEncryption

serverSideEncryptionAsString

hasMetadata

metadata

sseCustomerAlgorithm

sseCustomerKeyMD5

ssekmsKeyId

storageClass

storageClassAsString

requestCharged

requestChargedAsString

replicationStatus

replicationStatusAsString

partsCount

tagCount

objectLockMode

objectLockModeAsString

objectLockRetainUntilDate

objectLockLegalHoldStatus

objectLockLegalHoldStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields