Class SearchUsersByImageRequest

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

  • Method Details

    • collectionId

      public final String collectionId()

      The ID of an existing collection containing the UserID.

      Returns:
      The ID of an existing collection containing the UserID.

    • image

      public final Image image()
      Returns the value of the Image property for this object.
      Returns:
      The value of the Image property for this object.

    • userMatchThreshold

      public final Float userMatchThreshold()

      Specifies the minimum confidence in the UserID match to return. Default value is 80.

      Returns:
      Specifies the minimum confidence in the UserID match to return. Default value is 80.

    • maxUsers

      public final Integer maxUsers()

      Maximum number of UserIDs to return.

      Returns:
      Maximum number of UserIDs to return.

    • qualityFilter

      public final QualityFilter qualityFilter()

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

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

      Returns:
      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.
      See Also:

    • qualityFilterAsString

      public final String qualityFilterAsString()

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

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

      Returns:
      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.
      See Also:

    • toBuilder

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

    • builder

      public static SearchUsersByImageRequest.Builder builder()

    • serializableBuilderClass

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