StartTextDetectionRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rekognition.model.StartTextDetectionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartTextDetectionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier ( JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier ( JobId) from the initial call to StartTextDetection.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartTextDetectionRequest()

Constructors
Constructor and Description
`StartTextDetectionRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientRequestToken()` Idempotent token used to identify the start request.
`StartTextDetectionFilters`	`getFilters()` Optional parameters that let you set criteria the text must meet to be included in your response.
`java.lang.String`	`getJobTag()` An identifier returned in the completion status published by your Amazon Simple Notification Service topic.
`NotificationChannel`	`getNotificationChannel()` The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation.
`Video`	`getVideo()` Video file stored in an Amazon S3 bucket.
`int`	`hashCode()`
`void`	`setClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`void`	`setFilters(StartTextDetectionFilters filters)` Optional parameters that let you set criteria the text must meet to be included in your response.
`void`	`setJobTag(java.lang.String jobTag)` An identifier returned in the completion status published by your Amazon Simple Notification Service topic.
`void`	`setNotificationChannel(NotificationChannel notificationChannel)` The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation.
`void`	`setVideo(Video video)` Video file stored in an Amazon S3 bucket.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartTextDetectionRequest`	`withClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`StartTextDetectionRequest`	`withFilters(StartTextDetectionFilters filters)` Optional parameters that let you set criteria the text must meet to be included in your response.
`StartTextDetectionRequest`	`withJobTag(java.lang.String jobTag)` An identifier returned in the completion status published by your Amazon Simple Notification Service topic.
`StartTextDetectionRequest`	`withNotificationChannel(NotificationChannel notificationChannel)` The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation.
`StartTextDetectionRequest`	`withVideo(Video video)` Video file stored in an Amazon S3 bucket.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartTextDetectionRequest
```
public StartTextDetectionRequest()
```
- Method Detail
  - getVideo
```
public Video getVideo()
```
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Returns:
    
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
  - setVideo
```
public void setVideo(Video video)
```
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Parameters:
    
    video -
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
  - withVideo
```
public StartTextDetectionRequest withVideo(Video video)
```
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    video -
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientRequestToken
```
public java.lang.String getClientRequestToken()
```
    Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    Returns:
    
    Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
  - setClientRequestToken
```
public void setClientRequestToken(java.lang.String clientRequestToken)
```
    Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    Parameters:
    
    clientRequestToken -
    Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
  - withClientRequestToken
```
public StartTextDetectionRequest withClientRequestToken(java.lang.String clientRequestToken)
```
    Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    Parameters:
    
    clientRequestToken -
    Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNotificationChannel
```
public NotificationChannel getNotificationChannel()
```
    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
    
    Returns:
    
    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
  - setNotificationChannel
```
public void setNotificationChannel(NotificationChannel notificationChannel)
```
    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
    
    Parameters:
    
    notificationChannel -
    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
  - withNotificationChannel
```
public StartTextDetectionRequest withNotificationChannel(NotificationChannel notificationChannel)
```
    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    notificationChannel -
    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobTag
```
public java.lang.String getJobTag()
```
    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    Returns:
    
    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
  - setJobTag
```
public void setJobTag(java.lang.String jobTag)
```
    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    Parameters:
    
    jobTag -
    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
  - withJobTag
```
public StartTextDetectionRequest withJobTag(java.lang.String jobTag)
```
    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    Parameters:
    
    jobTag -
    An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFilters
```
public StartTextDetectionFilters getFilters()
```
    Optional parameters that let you set criteria the text must meet to be included in your response.
    
    Returns:
    
    Optional parameters that let you set criteria the text must meet to be included in your response.
  - setFilters
```
public void setFilters(StartTextDetectionFilters filters)
```
    Optional parameters that let you set criteria the text must meet to be included in your response.
    
    Parameters:
    
    filters -
    Optional parameters that let you set criteria the text must meet to be included in your response.
  - withFilters
```
public StartTextDetectionRequest withFilters(StartTextDetectionFilters filters)
```
    Optional parameters that let you set criteria the text must meet to be included in your response.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    filters -
    Optional parameters that let you set criteria the text must meet to be included in your response.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartTextDetectionRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartTextDetectionRequest

Method Detail

getVideo

setVideo

withVideo

getClientRequestToken

setClientRequestToken

withClientRequestToken

getNotificationChannel

setNotificationChannel

withNotificationChannel

getJobTag

setJobTag

withJobTag

getFilters

setFilters

withFilters

toString

hashCode

equals