Class CreateFaceLivenessSessionRequestSettings

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

A session settings object. It contains settings for the operation to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.

See Also:

  • Method Details

    • outputConfig

      public final LivenessOutputConfig outputConfig()

      Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by the Face Liveness system. Requires that the caller has the s3:PutObject permission on the Amazon S3 bucket.

      Returns:
      Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by the Face Liveness system. Requires that the caller has the s3:PutObject permission on the Amazon S3 bucket.

    • auditImagesLimit

      public final Integer auditImagesLimit()

      Number of audit images to be returned back. Takes an integer between 0-4. Any integer less than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it is set to 0. The limit is best effort and is based on the actual duration of the selfie-video.

      Returns:
      Number of audit images to be returned back. Takes an integer between 0-4. Any integer less than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it is set to 0. The limit is best effort and is based on the actual duration of the selfie-video.

    • hasChallengePreferences

      public final boolean hasChallengePreferences()
      For responses, this returns true if the service returned a value for the ChallengePreferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • challengePreferences

      public final List<ChallengePreference> challengePreferences()

      Indicates preferred challenge types and versions for the Face Liveness session to be created.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChallengePreferences() method.

      Returns:
      Indicates preferred challenge types and versions for the Face Liveness session to be created.

    • toBuilder

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

    • builder

      public static CreateFaceLivenessSessionRequestSettings.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.