Class S3Object

java.lang.Object
software.amazon.awssdk.services.rekognition.model.S3Object
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3Object.Builder,S3Object>
@Generated("software.amazon.awssdk:codegen") public final class S3Object extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3Object.Builder,S3Object>

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

See Also:

  • Method Details

    • bucket

      public final String bucket()

      Name of the S3 bucket.

      Returns:
      Name of the S3 bucket.

    • name

      public final String name()

      S3 object key name.

      Returns:
      S3 object key name.

    • version

      public final String version()

      If the bucket is versioning enabled, you can specify the object version.

      Returns:
      If the bucket is versioning enabled, you can specify the object version.

    • toBuilder

      public S3Object.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<S3Object.Builder,S3Object>
      Returns:
      a builder for type T

    • builder

      public static S3Object.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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