Class GetObjectAnnotationRequest

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

  • Method Details

    • bucket

      public final String bucket()

      The name of the bucket that contains the object.

      Returns:
      The name of the bucket that contains the object.

    • key

      public final String key()

      The object key.

      Returns:
      The object key.

    • annotationName

      public final String annotationName()

      The name of the annotation to retrieve.

      Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

      Returns:
      The name of the annotation to retrieve.

      Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

    • versionId

      public final String versionId()

      The version ID of the object.

      Returns:
      The version ID of the object.

    • requestPayer

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

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

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

    • requestPayerAsString

      public final String requestPayerAsString()
      Returns the value of the RequestPayer property for this object.

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

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

    • expectedBucketOwner

      public final String expectedBucketOwner()

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.

      Returns:
      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.

    • checksumMode

      public final ChecksumMode checksumMode()

      Set to ENABLED to validate the checksum of the annotation payload on retrieval.

      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:
      Set to ENABLED to validate the checksum of the annotation payload on retrieval.
      See Also:

    • checksumModeAsString

      public final String checksumModeAsString()

      Set to ENABLED to validate the checksum of the annotation payload on retrieval.

      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:
      Set to ENABLED to validate the checksum of the annotation payload on retrieval.
      See Also:

    • toBuilder

      public GetObjectAnnotationRequest.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<GetObjectAnnotationRequest.Builder,GetObjectAnnotationRequest>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • builder

      public static GetObjectAnnotationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetObjectAnnotationRequest.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.