Class GetObjectRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.restjsondataplane.model.RestJsonDataPlaneRequest
software.amazon.awssdk.services.restjsondataplane.model.GetObjectRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetObjectRequest extends RestJsonDataPlaneRequest implements ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>

  • Method Details

    • bucket

      public final String bucket()
      Returns the value of the Bucket property for this object.
      Returns:
      The value of the Bucket property for this object.

    • key

      public final String key()
      Returns the value of the Key property for this object.
      Returns:
      The value of the Key property for this object.

    • ifMatch

      public final String ifMatch()
      Returns the value of the IfMatch property for this object.
      Returns:
      The value of the IfMatch property for this object.

    • ifModifiedSince

      public final Instant ifModifiedSince()
      Returns the value of the IfModifiedSince property for this object.
      Returns:
      The value of the IfModifiedSince property for this object.

    • ifNoneMatch

      public final String ifNoneMatch()
      Returns the value of the IfNoneMatch property for this object.
      Returns:
      The value of the IfNoneMatch property for this object.

    • ifUnmodifiedSince

      public final Instant ifUnmodifiedSince()
      Returns the value of the IfUnmodifiedSince property for this object.
      Returns:
      The value of the IfUnmodifiedSince property for this object.

    • range

      public final String range()
      Returns the value of the Range property for this object.
      Returns:
      The value of the Range property for this object.

    • responseCacheControl

      public final String responseCacheControl()
      Returns the value of the ResponseCacheControl property for this object.
      Returns:
      The value of the ResponseCacheControl property for this object.

    • responseContentDisposition

      public final String responseContentDisposition()
      Returns the value of the ResponseContentDisposition property for this object.
      Returns:
      The value of the ResponseContentDisposition property for this object.

    • responseContentEncoding

      public final String responseContentEncoding()
      Returns the value of the ResponseContentEncoding property for this object.
      Returns:
      The value of the ResponseContentEncoding property for this object.

    • responseContentLanguage

      public final String responseContentLanguage()
      Returns the value of the ResponseContentLanguage property for this object.
      Returns:
      The value of the ResponseContentLanguage property for this object.

    • responseContentType

      public final String responseContentType()
      Returns the value of the ResponseContentType property for this object.
      Returns:
      The value of the ResponseContentType property for this object.

    • responseExpires

      public final Instant responseExpires()
      Returns the value of the ResponseExpires property for this object.
      Returns:
      The value of the ResponseExpires property for this object.

    • versionId

      public final String versionId()
      Returns the value of the VersionId property for this object.
      Returns:
      The value of the VersionId property for this object.

    • sseCustomerAlgorithm

      public final String sseCustomerAlgorithm()
      Returns the value of the SSECustomerAlgorithm property for this object.
      Returns:
      The value of the SSECustomerAlgorithm property for this object.

    • sseCustomerKey

      public final String sseCustomerKey()
      Returns the value of the SSECustomerKey property for this object.
      Returns:
      The value of the SSECustomerKey property for this object.

    • sseCustomerKeyMD5

      public final String sseCustomerKeyMD5()
      Returns the value of the SSECustomerKeyMD5 property for this object.
      Returns:
      The value of the SSECustomerKeyMD5 property for this object.

    • requestPayer

      public final String requestPayer()
      Returns the value of the RequestPayer property for this object.
      Returns:
      The value of the RequestPayer property for this object.

    • partNumber

      public final Integer partNumber()
      Returns the value of the PartNumber property for this object.
      Returns:
      The value of the PartNumber property for this object.

    • expectedBucketOwner

      public final String expectedBucketOwner()
      Returns the value of the ExpectedBucketOwner property for this object.
      Returns:
      The value of the ExpectedBucketOwner property for this object.

    • checksumMode

      public final ChecksumMode checksumMode()
      Returns the value of the ChecksumMode property for this object.

      If the service returns an enum value that is not available in the current SDK version, checksumMode will return ChecksumMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumModeAsString().

      Returns:
      The value of the ChecksumMode property for this object.
      See Also:

    • checksumModeAsString

      public final String checksumModeAsString()
      Returns the value of the ChecksumMode property for this object.

      If the service returns an enum value that is not available in the current SDK version, checksumMode will return ChecksumMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumModeAsString().

      Returns:
      The value of the ChecksumMode property for this object.
      See Also:

    • toBuilder

      public GetObjectRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>
      Specified by:
      toBuilder in class RestJsonDataPlaneRequest
      Returns:
      a builder for type T

    • builder

      public static GetObjectRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetObjectRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.