Interface GetLabelDetectionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetLabelDetectionResponse.Builder,GetLabelDetectionResponse>, RekognitionResponse.Builder, SdkBuilder<GetLabelDetectionResponse.Builder,GetLabelDetectionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetLabelDetectionResponse

public static interface GetLabelDetectionResponse.Builder extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetLabelDetectionResponse.Builder,GetLabelDetectionResponse>
  • Method Details

    • jobStatus

      The current status of the label detection job.

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

      The current status of the label detection job.

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

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

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

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

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

      An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

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

      An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

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

      An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

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

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

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

      GetLabelDetectionResponse.Builder labelModelVersion(String labelModelVersion)

      Version number of the label detection model that was used to detect labels.

      Parameters:
      labelModelVersion - Version number of the label detection model that was used to detect labels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobId

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

      Parameters:
      jobId - Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      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

      A job identifier specified in the call to StartLabelDetection 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 StartLabelDetection 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.
    • getRequestMetadata

      Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.

      Parameters:
      getRequestMetadata - Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getRequestMetadata

      Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.

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

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

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