Interface GetFaceDetectionResponse.Builder

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

  • Method Details

    • jobStatus

      GetFaceDetectionResponse.Builder jobStatus(String jobStatus)

      The current status of the face detection job.

      Parameters:
      jobStatus - The current status of the face detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobStatus

      GetFaceDetectionResponse.Builder jobStatus(VideoJobStatus jobStatus)

      The current status of the face detection job.

      Parameters:
      jobStatus - The current status of the face detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      GetFaceDetectionResponse.Builder statusMessage(String statusMessage)

      If the job fails, StatusMessage provides a descriptive error message.

      Parameters:
      statusMessage - If the job fails, StatusMessage provides a descriptive error message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • videoMetadata

      GetFaceDetectionResponse.Builder videoMetadata(VideoMetadata videoMetadata)

      Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

      Parameters:
      videoMetadata - Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • videoMetadata

      default GetFaceDetectionResponse.Builder videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)

      Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

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

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

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

    • nextToken

      GetFaceDetectionResponse.Builder nextToken(String nextToken)

      If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

      Parameters:
      nextToken - If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faces

      GetFaceDetectionResponse.Builder faces(Collection<FaceDetection> faces)

      An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

      Parameters:
      faces - An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faces

      GetFaceDetectionResponse.Builder faces(FaceDetection... faces)

      An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

      Parameters:
      faces - An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faces

      GetFaceDetectionResponse.Builder faces(Consumer<FaceDetection.Builder>... faces)

      An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

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

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

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

    • jobId

      GetFaceDetectionResponse.Builder jobId(String jobId)

      Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.

      Parameters:
      jobId - Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • video

      GetFaceDetectionResponse.Builder video(Video video)
      Sets the value of the Video property for this object.
      Parameters:
      video - The new value for the Video property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • video

      default GetFaceDetectionResponse.Builder video(Consumer<Video.Builder> video)
      Sets the value of the Video property for this object. This is a convenience method that creates an instance of the Video.Builder avoiding the need to create one manually via Video.builder().

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

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

    • jobTag

      GetFaceDetectionResponse.Builder jobTag(String jobTag)

      A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

      Parameters:
      jobTag - A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.