software.amazon.awssdk.services.rekognition.model

Class GetFaceLivenessSessionResultsResponse

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.GetFaceLivenessSessionResultsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetFaceLivenessSessionResultsResponse
extends RekognitionResponse
implements ToCopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetFaceLivenessSessionResultsResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<AuditImage>	auditImages() A set of images from the Face Liveness video that can be used for audit purposes.
static GetFaceLivenessSessionResultsResponse.Builder	builder()
Float	confidence() Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuditImages() For responses, this returns true if the service returned a value for the AuditImages property.
int	hashCode()
AuditImage	referenceImage() A high-quality image from the Face Liveness video that can be used for face comparison or search.
List<SdkField<?>>	sdkFields()
static Class<? extends GetFaceLivenessSessionResultsResponse.Builder>	serializableBuilderClass()
String	sessionId() The sessionId for which this request was called.
LivenessSessionStatus	status() Represents a status corresponding to the state of the session.
String	statusAsString() Represents a status corresponding to the state of the session.
GetFaceLivenessSessionResultsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

sessionId

public final String sessionId()

The sessionId for which this request was called.

Returns:

The sessionId for which this request was called.

status

public final LivenessSessionStatus status()

Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.

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

Returns:

Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.

See Also:

LivenessSessionStatus

statusAsString

public final String statusAsString()

Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.

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

Returns:

Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.

See Also:

LivenessSessionStatus

confidence

public final Float confidence()

Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.

Returns:

Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.

referenceImage

public final AuditImage referenceImage()

A high-quality image from the Face Liveness video that can be used for face comparison or search. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. In case the reference image is not returned, it's recommended to retry the Liveness check.

Returns:

A high-quality image from the Face Liveness video that can be used for face comparison or search. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. In case the reference image is not returned, it's recommended to retry the Liveness check.

hasAuditImages

public final boolean hasAuditImages()

For responses, this returns true if the service returned a value for the AuditImages 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.

auditImages

public final List<AuditImage> auditImages()

A set of images from the Face Liveness video that can be used for audit purposes. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration.

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 hasAuditImages() method.

Returns:

A set of images from the Face Liveness video that can be used for audit purposes. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration.

toBuilder

public GetFaceLivenessSessionResultsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetFaceLivenessSessionResultsResponse.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo