Interface GetLabelDetectionResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetLabelDetectionResponse.Builder,
,GetLabelDetectionResponse> RekognitionResponse.Builder
,SdkBuilder<GetLabelDetectionResponse.Builder,
,GetLabelDetectionResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetLabelDetectionResponse
-
Method Summary
Modifier and TypeMethodDescriptiongetRequestMetadata
(Consumer<GetLabelDetectionRequestMetadata.Builder> getRequestMetadata) Information about the paramters used when getting a response.getRequestMetadata
(GetLabelDetectionRequestMetadata getRequestMetadata) Information about the paramters used when getting a response.Job identifier for the label detection operation for which you want to obtain results.The current status of the label detection job.jobStatus
(VideoJobStatus jobStatus) The current status of the label detection job.A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.labelModelVersion
(String labelModelVersion) Version number of the label detection model that was used to detect labels.labels
(Collection<LabelDetection> labels) An array of labels detected in the video.labels
(Consumer<LabelDetection.Builder>... labels) An array of labels detected in the video.labels
(LabelDetection... labels) An array of labels detected in the video.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.statusMessage
(String statusMessage) If the job fails,StatusMessage
provides a descriptive error message.video
(Consumer<Video.Builder> video) Sets the value of the Video property for this object.Sets the value of the Video property for this object.videoMetadata
(Consumer<VideoMetadata.Builder> videoMetadata) Information about a video that Amazon Rekognition Video analyzed.videoMetadata
(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition Video analyzed.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
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
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
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.
This is a convenience method that creates an instance of theVideometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.VideoMetadata.Builder
avoiding the need to create one manually viaVideoMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovideoMetadata(VideoMetadata)
.- Parameters:
videoMetadata
- a consumer that will call methods onVideoMetadata.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 theLabelDetection.Builder
avoiding the need to create one manually viaLabelDetection.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolabels(List<LabelDetection>)
.- Parameters:
labels
- a consumer that will call methods onLabelDetection.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theVideo.Builder
avoiding the need to create one manually viaVideo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovideo(Video)
.- Parameters:
video
- a consumer that will call methods onVideo.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
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 theGetLabelDetectionRequestMetadata.Builder
avoiding the need to create one manually viaGetLabelDetectionRequestMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togetRequestMetadata(GetLabelDetectionRequestMetadata)
.- Parameters:
getRequestMetadata
- a consumer that will call methods onGetLabelDetectionRequestMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-