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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFaceLivenessSessionRequestSettings.Builder

Method Summary

Modifier and Type	Method	Description
Integer	auditImagesLimit()	Number of audit images to be returned back.
static CreateFaceLivenessSessionRequestSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LivenessOutputConfig	outputConfig()	Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFaceLivenessSessionRequestSettings.Builder>	serializableBuilderClass()
CreateFaceLivenessSessionRequestSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

toBuilder

public CreateFaceLivenessSessionRequestSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFaceLivenessSessionRequestSettings.Builder,CreateFaceLivenessSessionRequestSettings>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo