Package software.amazon.awssdk.services.s3.model

Class ListObjectAnnotationsRequest

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.ListObjectAnnotationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListObjectAnnotationsRequest.Builder,ListObjectAnnotationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListObjectAnnotationsRequest extends S3Request implements ToCopyableBuilder<ListObjectAnnotationsRequest.Builder,ListObjectAnnotationsRequest>

  • 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.

    • versionId

      public final String versionId()

      The version ID of the object.

      Returns:
      The version ID of the object.

    • maxAnnotationResults

      public final Integer maxAnnotationResults()

      The maximum number of annotations to return in the response. Maximum is 1,000.

      Returns:
      The maximum number of annotations to return in the response. Maximum is 1,000.

    • annotationPrefix

      public final String annotationPrefix()

      Filter results to annotations whose name begins with the specified prefix.

      Returns:
      Filter results to annotations whose name begins with the specified prefix.

    • continuationToken

      public final String continuationToken()

      Continuation token returned by a previous request to retrieve the next page.

      Returns:
      Continuation token returned by a previous request to retrieve the next page.

    • 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.

      Returns:
      The account ID of the expected bucket owner.

    • toBuilder

      public ListObjectAnnotationsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListObjectAnnotationsRequest.Builder,ListObjectAnnotationsRequest>
      Specified by:
      toBuilder in class S3Request

    • builder

      public static ListObjectAnnotationsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListObjectAnnotationsRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo