Package software.amazon.awssdk.services.rekognition.model

Class FaceSearchSettings

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

Input face recognition parameters for an Amazon Rekognition stream processor. Includes the collection to use for face recognition and the face attributes to detect. Defining the settings is required in the request parameter for CreateStreamProcessor.

See Also:

  • Method Details

    • collectionId

      public final String collectionId()

      The ID of a collection that contains faces that you want to search for.

      Returns:
      The ID of a collection that contains faces that you want to search for.

    • faceMatchThreshold

      public final Float faceMatchThreshold()

      Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

      Returns:
      Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

    • toBuilder

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

    • builder

      public static FaceSearchSettings.Builder builder()

    • serializableBuilderClass

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