Interface GetFaceLivenessSessionResultsResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>, RekognitionResponse.Builder, SdkBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetFaceLivenessSessionResultsResponse
@Mutable @NotThreadSafe public static interface GetFaceLivenessSessionResultsResponse.Builder extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetFaceLivenessSessionResultsResponse.Builder,GetFaceLivenessSessionResultsResponse>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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. If no Amazon S3 bucket is defined, raw bytes are sent instead.

      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. If no Amazon S3 bucket is defined, raw bytes are sent instead.
      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. If no Amazon S3 bucket is defined, raw bytes are sent instead.

      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. If no Amazon S3 bucket is defined, raw bytes are sent instead.
      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. If no Amazon S3 bucket is defined, raw bytes are sent instead.

      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<AuditImage>).

      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:

    • challenge

      GetFaceLivenessSessionResultsResponse.Builder challenge(Challenge challenge)

      Contains information regarding the challenge type used for the Face Liveness check.

      Parameters:
      challenge - Contains information regarding the challenge type used for the Face Liveness check.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • challenge

      default GetFaceLivenessSessionResultsResponse.Builder challenge(Consumer<Challenge.Builder> challenge)

      Contains information regarding the challenge type used for the Face Liveness check.

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

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

      Parameters:
      challenge - a consumer that will call methods on Challenge.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • feedback

      GetFaceLivenessSessionResultsResponse.Builder feedback(Collection<FeedbackItem> feedback)

      A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score. Each item contains a code and a human-readable message. Feedback is returned only for sessions with a Status of SUCCEEDED, and the list is empty when no such conditions were detected.

      Parameters:
      feedback - A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score. Each item contains a code and a human-readable message. Feedback is returned only for sessions with a Status of SUCCEEDED, and the list is empty when no such conditions were detected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • feedback

      GetFaceLivenessSessionResultsResponse.Builder feedback(FeedbackItem... feedback)

      A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score. Each item contains a code and a human-readable message. Feedback is returned only for sessions with a Status of SUCCEEDED, and the list is empty when no such conditions were detected.

      Parameters:
      feedback - A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score. Each item contains a code and a human-readable message. Feedback is returned only for sessions with a Status of SUCCEEDED, and the list is empty when no such conditions were detected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • feedback

      GetFaceLivenessSessionResultsResponse.Builder feedback(Consumer<FeedbackItem.Builder>... feedback)

      A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score. Each item contains a code and a human-readable message. Feedback is returned only for sessions with a Status of SUCCEEDED, and the list is empty when no such conditions were detected.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to feedback(List<FeedbackItem>).

      Parameters:
      feedback - a consumer that will call methods on FeedbackItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadata

      GetFaceLivenessSessionResultsResponse.Builder metadata(SessionMetadata metadata)

      Metadata about the client that streamed the video for the Face Liveness session.

      Parameters:
      metadata - Metadata about the client that streamed the video for the Face Liveness session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadata

      default GetFaceLivenessSessionResultsResponse.Builder metadata(Consumer<SessionMetadata.Builder> metadata)

      Metadata about the client that streamed the video for the Face Liveness session.

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

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

      Parameters:
      metadata - a consumer that will call methods on SessionMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: