Interface GetTextDetectionResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<GetTextDetectionResponse.Builder,GetTextDetectionResponse>,RekognitionResponse.Builder,SdkBuilder<GetTextDetectionResponse.Builder,GetTextDetectionResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- GetTextDetectionResponse
public static interface GetTextDetectionResponse.Builder extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetTextDetectionResponse.Builder,GetTextDetectionResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GetTextDetectionResponse.BuilderjobId(String jobId)Job identifier for the text detection operation for which you want to obtain results.GetTextDetectionResponse.BuilderjobStatus(String jobStatus)Current status of the text detection job.GetTextDetectionResponse.BuilderjobStatus(VideoJobStatus jobStatus)Current status of the text detection job.GetTextDetectionResponse.BuilderjobTag(String jobTag)A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.GetTextDetectionResponse.BuildernextToken(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 text.GetTextDetectionResponse.BuilderstatusMessage(String statusMessage)If the job fails,StatusMessageprovides a descriptive error message.GetTextDetectionResponse.BuildertextDetections(Collection<TextDetectionResult> textDetections)An array of text detected in the video.GetTextDetectionResponse.BuildertextDetections(Consumer<TextDetectionResult.Builder>... textDetections)An array of text detected in the video.GetTextDetectionResponse.BuildertextDetections(TextDetectionResult... textDetections)An array of text detected in the video.GetTextDetectionResponse.BuildertextModelVersion(String textModelVersion)Version number of the text detection model that was used to detect text.default GetTextDetectionResponse.Buildervideo(Consumer<Video.Builder> video)Sets the value of the Video property for this object.GetTextDetectionResponse.Buildervideo(Video video)Sets the value of the Video property for this object.default GetTextDetectionResponse.BuildervideoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)Sets the value of the VideoMetadata property for this object.GetTextDetectionResponse.BuildervideoMetadata(VideoMetadata videoMetadata)Sets the value of the VideoMetadata property for this object.-
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, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
jobStatus
GetTextDetectionResponse.Builder jobStatus(String jobStatus)
Current status of the text detection job.
- Parameters:
jobStatus- Current status of the text detection job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VideoJobStatus,VideoJobStatus
-
jobStatus
GetTextDetectionResponse.Builder jobStatus(VideoJobStatus jobStatus)
Current status of the text detection job.
- Parameters:
jobStatus- Current status of the text detection job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VideoJobStatus,VideoJobStatus
-
statusMessage
GetTextDetectionResponse.Builder statusMessage(String statusMessage)
If the job fails,
StatusMessageprovides a descriptive error message.- Parameters:
statusMessage- If the job fails,StatusMessageprovides a descriptive error message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
videoMetadata
GetTextDetectionResponse.Builder videoMetadata(VideoMetadata videoMetadata)
Sets the value of the VideoMetadata property for this object.- Parameters:
videoMetadata- The new value for the VideoMetadata property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
videoMetadata
default GetTextDetectionResponse.Builder videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)
Sets the value of the VideoMetadata property for this object. This is a convenience method that creates an instance of theVideoMetadata.Builderavoiding the need to create one manually viaVideoMetadata.builder().When the
Consumercompletes,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:
videoMetadata(VideoMetadata)
-
textDetections
GetTextDetectionResponse.Builder textDetections(Collection<TextDetectionResult> textDetections)
An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
- Parameters:
textDetections- An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
textDetections
GetTextDetectionResponse.Builder textDetections(TextDetectionResult... textDetections)
An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
- Parameters:
textDetections- An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
textDetections
GetTextDetectionResponse.Builder textDetections(Consumer<TextDetectionResult.Builder>... textDetections)
An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
This is a convenience method that creates an instance of theTextDetectionResult.Builderavoiding the need to create one manually viaTextDetectionResult.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#textDetections(List.) - Parameters:
textDetections- a consumer that will call methods onTextDetectionResult.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#textDetections(java.util.Collection)
-
nextToken
GetTextDetectionResponse.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 text.
- 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 text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
textModelVersion
GetTextDetectionResponse.Builder textModelVersion(String textModelVersion)
Version number of the text detection model that was used to detect text.
- Parameters:
textModelVersion- Version number of the text detection model that was used to detect text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobId
GetTextDetectionResponse.Builder jobId(String jobId)
Job identifier for the text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.
- Parameters:
jobId- Job identifier for the text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
video
GetTextDetectionResponse.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 GetTextDetectionResponse.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 theVideo.Builderavoiding the need to create one manually viaVideo.builder().When the
Consumercompletes,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:
video(Video)
-
jobTag
GetTextDetectionResponse.Builder jobTag(String jobTag)
A job identifier specified in the call to StartTextDetection 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 StartTextDetection 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.
-
-