Class DescribeCollectionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.rekognition.model.RekognitionResponse
software.amazon.awssdk.services.rekognition.model.DescribeCollectionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeCollectionResponse.Builder,DescribeCollectionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeCollectionResponse extends RekognitionResponse implements ToCopyableBuilder<DescribeCollectionResponse.Builder,DescribeCollectionResponse>

  • Method Details

    • faceCount

      public final Long faceCount()

      The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

      Returns:
      The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

    • faceModelVersion

      public final String faceModelVersion()

      The version of the face model that's used by the collection for face detection.

      For more information, see Model versioning in the Amazon Rekognition Developer Guide.

      Returns:
      The version of the face model that's used by the collection for face detection.

      For more information, see Model versioning in the Amazon Rekognition Developer Guide.

    • collectionARN

      public final String collectionARN()

      The Amazon Resource Name (ARN) of the collection.

      Returns:
      The Amazon Resource Name (ARN) of the collection.

    • creationTimestamp

      public final Instant creationTimestamp()

      The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

      Returns:
      The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

    • userCount

      public final Long userCount()

      The number of UserIDs assigned to the specified colleciton.

      Returns:
      The number of UserIDs assigned to the specified colleciton.

    • toBuilder

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

    • builder

      public static DescribeCollectionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.