software.amazon.awssdk.services.rekognition.model

Interface GetFaceLivenessSessionResultsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>, RekognitionResponse.Builder, SdkBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetFaceLivenessSessionResultsResponse

public static interface GetFaceLivenessSessionResultsResponse.Builder
extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>

Method Summary

Modifier and Type	Method and Description
GetFaceLivenessSessionResultsResponse.Builder	auditImages(AuditImage... auditImages) A set of images from the Face Liveness video that can be used for audit purposes.
GetFaceLivenessSessionResultsResponse.Builder	auditImages(Collection<AuditImage> auditImages) A set of images from the Face Liveness video that can be used for audit purposes.
GetFaceLivenessSessionResultsResponse.Builder	auditImages(Consumer<AuditImage.Builder>... auditImages) A set of images from the Face Liveness video that can be used for audit purposes.
GetFaceLivenessSessionResultsResponse.Builder	confidence(Float confidence) Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.
GetFaceLivenessSessionResultsResponse.Builder	referenceImage(AuditImage referenceImage) A high-quality image from the Face Liveness video that can be used for face comparison or search.
default GetFaceLivenessSessionResultsResponse.Builder	referenceImage(Consumer<AuditImage.Builder> referenceImage) A high-quality image from the Face Liveness video that can be used for face comparison or search.
GetFaceLivenessSessionResultsResponse.Builder	sessionId(String sessionId) The sessionId for which this request was called.
GetFaceLivenessSessionResultsResponse.Builder	status(LivenessSessionStatus status) Represents a status corresponding to the state of the session.
GetFaceLivenessSessionResultsResponse.Builder	status(String status) Represents a status corresponding to the state of the session.

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

sessionId

GetFaceLivenessSessionResultsResponse.Builder sessionId(String sessionId)

The sessionId for which this request was called.

Parameters:

sessionId - The sessionId for which this request was called.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetFaceLivenessSessionResultsResponse.Builder status(String status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LivenessSessionStatus, LivenessSessionStatus

status

GetFaceLivenessSessionResultsResponse.Builder status(LivenessSessionStatus status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LivenessSessionStatus, LivenessSessionStatus

confidence

GetFaceLivenessSessionResultsResponse.Builder confidence(Float confidence)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

referenceImage

GetFaceLivenessSessionResultsResponse.Builder referenceImage(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

referenceImage

default GetFaceLivenessSessionResultsResponse.Builder referenceImage(Consumer<AuditImage.Builder> 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.

This is a convenience method that creates an instance of the AuditImage.Builder avoiding the need to create one manually via AuditImage.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to referenceImage(AuditImage).

Parameters:

referenceImage - a consumer that will call methods on AuditImage.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

referenceImage(AuditImage)

auditImages

GetFaceLivenessSessionResultsResponse.Builder auditImages(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

auditImages

GetFaceLivenessSessionResultsResponse.Builder auditImages(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

auditImages

GetFaceLivenessSessionResultsResponse.Builder auditImages(Consumer<AuditImage.Builder>... 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.

This is a convenience method that creates an instance of the AuditImage.Builder avoiding the need to create one manually via AuditImage.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #auditImages(List).

Parameters:

auditImages - a consumer that will call methods on AuditImage.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#auditImages(java.util.Collection)