software.amazon.awssdk.services.rekognition.model

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 Summary

Modifier and Type	Method and Description
default GetLabelDetectionResponse.Builder	getRequestMetadata(Consumer<GetLabelDetectionRequestMetadata.Builder> getRequestMetadata) Information about the paramters used when getting a response.
GetLabelDetectionResponse.Builder	getRequestMetadata(GetLabelDetectionRequestMetadata getRequestMetadata) Information about the paramters used when getting a response.
GetLabelDetectionResponse.Builder	jobId(String jobId) Job identifier for the label detection operation for which you want to obtain results.
GetLabelDetectionResponse.Builder	jobStatus(String jobStatus) The current status of the label detection job.
GetLabelDetectionResponse.Builder	jobStatus(VideoJobStatus jobStatus) The current status of the label detection job.
GetLabelDetectionResponse.Builder	jobTag(String 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.
GetLabelDetectionResponse.Builder	labelModelVersion(String labelModelVersion) Version number of the label detection model that was used to detect labels.
GetLabelDetectionResponse.Builder	labels(Collection<LabelDetection> labels) An array of labels detected in the video.
GetLabelDetectionResponse.Builder	labels(Consumer<LabelDetection.Builder>... labels) An array of labels detected in the video.
GetLabelDetectionResponse.Builder	labels(LabelDetection... labels) An array of labels detected in the video.
GetLabelDetectionResponse.Builder	nextToken(String 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.
GetLabelDetectionResponse.Builder	statusMessage(String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
default GetLabelDetectionResponse.Builder	video(Consumer<Video.Builder> video) Sets the value of the Video property for this object.
GetLabelDetectionResponse.Builder	video(Video video) Sets the value of the Video property for this object.
default GetLabelDetectionResponse.Builder	videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata) Information about a video that Amazon Rekognition Video analyzed.
GetLabelDetectionResponse.Builder	videoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition Video analyzed.

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

jobStatus

GetLabelDetectionResponse.Builder jobStatus(String 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:

VideoJobStatus, VideoJobStatus

jobStatus

GetLabelDetectionResponse.Builder jobStatus(VideoJobStatus 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:

VideoJobStatus, VideoJobStatus

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:

videoMetadata(VideoMetadata)

nextToken

GetLabelDetectionResponse.Builder nextToken(String 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

GetLabelDetectionResponse.Builder labels(Collection<LabelDetection> 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

GetLabelDetectionResponse.Builder labels(LabelDetection... 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

GetLabelDetectionResponse.Builder labels(Consumer<LabelDetection.Builder>... 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).

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:

#labels(java.util.Collection)

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

GetLabelDetectionResponse.Builder jobId(String 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

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

video(Video)

jobTag

GetLabelDetectionResponse.Builder jobTag(String 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

GetLabelDetectionResponse.Builder getRequestMetadata(GetLabelDetectionRequestMetadata 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

default GetLabelDetectionResponse.Builder getRequestMetadata(Consumer<GetLabelDetectionRequestMetadata.Builder> 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:

getRequestMetadata(GetLabelDetectionRequestMetadata)