* Starts the asynchronous detection of text in a document. Amazon Textract can * detect lines of text and the words that make up a line of text. *
*
* StartDocumentTextDetection can analyze text in documents that
* are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon
* S3 bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
*
* StartTextDetection returns a job identifier (JobId)
* that you use to get the results of the operation. When text detection is
* finished, Amazon Textract publishes a completion status to the Amazon Simple
* Notification Service (Amazon SNS) 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 GetDocumentTextDetection,
* and pass the job identifier (JobId) from the initial call to
* StartDocumentTextDetection.
*
* For more information, see Document Text Detection. *
*/ public class StartDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable { /** ** The location of the document to be processed. *
*/ private DocumentLocation documentLocation; /** *
* The idempotent token that's used to identify the start request. If you
* use the same token with multiple StartDocumentTextDetection
* requests, the same JobId is returned. Use
* ClientRequestToken to prevent the same job from being
* accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*/
private String clientRequestToken;
/**
*
* An identifier that you specify that's included in the completion
* notification published to the Amazon SNS topic. For example, you can use
* JobTag to identify the type of document that the completion
* notification corresponds to (such as a tax form or a receipt).
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.\-:]+
*/
private String jobTag;
/**
*
* The Amazon SNS topic ARN that you want Amazon Textract to publish the * completion status of the operation to. *
*/ private NotificationChannel notificationChannel; /** ** Sets if the output will go to a customer defined bucket. By default * Amazon Textract will save the results internally to be accessed with the * GetDocumentTextDetection operation. *
*/ private OutputConfig outputConfig; /** ** The KMS key used to encrypt the inference results. This can be in either * Key ID or Key Alias format. When a KMS key is provided, the KMS key will * be used for server-side encryption of the objects in the customer bucket. * When this parameter is not enabled, the result will be encrypted server * side,using SSE-S3. *
*
* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
*/
private String kMSKeyId;
/**
*
* The location of the document to be processed. *
* * @return* The location of the document to be processed. *
*/ public DocumentLocation getDocumentLocation() { return documentLocation; } /** ** The location of the document to be processed. *
* * @param documentLocation* The location of the document to be processed. *
*/ public void setDocumentLocation(DocumentLocation documentLocation) { this.documentLocation = documentLocation; } /** ** The location of the document to be processed. *
** Returns a reference to this object so that method calls can be chained * together. * * @param documentLocation
* The location of the document to be processed. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentTextDetectionRequest withDocumentLocation(DocumentLocation documentLocation) { this.documentLocation = documentLocation; return this; } /** *
* The idempotent token that's used to identify the start request. If you
* use the same token with multiple StartDocumentTextDetection
* requests, the same JobId is returned. Use
* ClientRequestToken to prevent the same job from being
* accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @return
* The idempotent token that's used to identify the start request.
* If you use the same token with multiple
* StartDocumentTextDetection requests, the same
* JobId is returned. Use
* ClientRequestToken to prevent the same job from
* being accidentally started more than once. For more information,
* see Calling Amazon Textract Asynchronous Operations.
*
* The idempotent token that's used to identify the start request. If you
* use the same token with multiple StartDocumentTextDetection
* requests, the same JobId is returned. Use
* ClientRequestToken to prevent the same job from being
* accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param clientRequestToken
* The idempotent token that's used to identify the start
* request. If you use the same token with multiple
* StartDocumentTextDetection requests, the same
* JobId is returned. Use
* ClientRequestToken to prevent the same job from
* being accidentally started more than once. For more
* information, see Calling Amazon Textract Asynchronous Operations.
*
* The idempotent token that's used to identify the start request. If you
* use the same token with multiple StartDocumentTextDetection
* requests, the same JobId is returned. Use
* ClientRequestToken to prevent the same job from being
* accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param clientRequestToken
* The idempotent token that's used to identify the start
* request. If you use the same token with multiple
* StartDocumentTextDetection requests, the same
* JobId is returned. Use
* ClientRequestToken to prevent the same job from
* being accidentally started more than once. For more
* information, see Calling Amazon Textract Asynchronous Operations.
*
* An identifier that you specify that's included in the completion
* notification published to the Amazon SNS topic. For example, you can use
* JobTag to identify the type of document that the completion
* notification corresponds to (such as a tax form or a receipt).
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @return
* An identifier that you specify that's included in the completion
* notification published to the Amazon SNS topic. For example, you
* can use JobTag to identify the type of document that
* the completion notification corresponds to (such as a tax form or
* a receipt).
*
* An identifier that you specify that's included in the completion
* notification published to the Amazon SNS topic. For example, you can use
* JobTag to identify the type of document that the completion
* notification corresponds to (such as a tax form or a receipt).
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @param jobTag
* An identifier that you specify that's included in the
* completion notification published to the Amazon SNS topic. For
* example, you can use JobTag to identify the type
* of document that the completion notification corresponds to
* (such as a tax form or a receipt).
*
* An identifier that you specify that's included in the completion
* notification published to the Amazon SNS topic. For example, you can use
* JobTag to identify the type of document that the completion
* notification corresponds to (such as a tax form or a receipt).
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @param jobTag
* An identifier that you specify that's included in the
* completion notification published to the Amazon SNS topic. For
* example, you can use JobTag to identify the type
* of document that the completion notification corresponds to
* (such as a tax form or a receipt).
*
* The Amazon SNS topic ARN that you want Amazon Textract to publish the * completion status of the operation to. *
* * @return* The Amazon SNS topic ARN that you want Amazon Textract to publish * the completion status of the operation to. *
*/ public NotificationChannel getNotificationChannel() { return notificationChannel; } /** ** The Amazon SNS topic ARN that you want Amazon Textract to publish the * completion status of the operation to. *
* * @param notificationChannel* The Amazon SNS topic ARN that you want Amazon Textract to * publish the completion status of the operation to. *
*/ public void setNotificationChannel(NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; } /** ** The Amazon SNS topic ARN that you want Amazon Textract to publish the * completion status of the operation to. *
** Returns a reference to this object so that method calls can be chained * together. * * @param notificationChannel
* The Amazon SNS topic ARN that you want Amazon Textract to * publish the completion status of the operation to. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentTextDetectionRequest withNotificationChannel( NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; return this; } /** ** Sets if the output will go to a customer defined bucket. By default * Amazon Textract will save the results internally to be accessed with the * GetDocumentTextDetection operation. *
* * @return* Sets if the output will go to a customer defined bucket. By * default Amazon Textract will save the results internally to be * accessed with the GetDocumentTextDetection operation. *
*/ public OutputConfig getOutputConfig() { return outputConfig; } /** ** Sets if the output will go to a customer defined bucket. By default * Amazon Textract will save the results internally to be accessed with the * GetDocumentTextDetection operation. *
* * @param outputConfig* Sets if the output will go to a customer defined bucket. By * default Amazon Textract will save the results internally to be * accessed with the GetDocumentTextDetection operation. *
*/ public void setOutputConfig(OutputConfig outputConfig) { this.outputConfig = outputConfig; } /** ** Sets if the output will go to a customer defined bucket. By default * Amazon Textract will save the results internally to be accessed with the * GetDocumentTextDetection operation. *
** Returns a reference to this object so that method calls can be chained * together. * * @param outputConfig
* Sets if the output will go to a customer defined bucket. By * default Amazon Textract will save the results internally to be * accessed with the GetDocumentTextDetection operation. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentTextDetectionRequest withOutputConfig(OutputConfig outputConfig) { this.outputConfig = outputConfig; return this; } /** ** The KMS key used to encrypt the inference results. This can be in either * Key ID or Key Alias format. When a KMS key is provided, the KMS key will * be used for server-side encryption of the objects in the customer bucket. * When this parameter is not enabled, the result will be encrypted server * side,using SSE-S3. *
*
* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
*
* @return
* The KMS key used to encrypt the inference results. This can be in * either Key ID or Key Alias format. When a KMS key is provided, * the KMS key will be used for server-side encryption of the * objects in the customer bucket. When this parameter is not * enabled, the result will be encrypted server side,using SSE-S3. *
*/ public String getKMSKeyId() { return kMSKeyId; } /** ** The KMS key used to encrypt the inference results. This can be in either * Key ID or Key Alias format. When a KMS key is provided, the KMS key will * be used for server-side encryption of the objects in the customer bucket. * When this parameter is not enabled, the result will be encrypted server * side,using SSE-S3. *
*
* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
*
* @param kMSKeyId
* The KMS key used to encrypt the inference results. This can be * in either Key ID or Key Alias format. When a KMS key is * provided, the KMS key will be used for server-side encryption * of the objects in the customer bucket. When this parameter is * not enabled, the result will be encrypted server side,using * SSE-S3. *
*/ public void setKMSKeyId(String kMSKeyId) { this.kMSKeyId = kMSKeyId; } /** ** The KMS key used to encrypt the inference results. This can be in either * Key ID or Key Alias format. When a KMS key is provided, the KMS key will * be used for server-side encryption of the objects in the customer bucket. * When this parameter is not enabled, the result will be encrypted server * side,using SSE-S3. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
*
* @param kMSKeyId
* The KMS key used to encrypt the inference results. This can be * in either Key ID or Key Alias format. When a KMS key is * provided, the KMS key will be used for server-side encryption * of the objects in the customer bucket. When this parameter is * not enabled, the result will be encrypted server side,using * SSE-S3. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentTextDetectionRequest withKMSKeyId(String kMSKeyId) { this.kMSKeyId = kMSKeyId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDocumentLocation() != null) sb.append("DocumentLocation: " + getDocumentLocation() + ","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getJobTag() != null) sb.append("JobTag: " + getJobTag() + ","); if (getNotificationChannel() != null) sb.append("NotificationChannel: " + getNotificationChannel() + ","); if (getOutputConfig() != null) sb.append("OutputConfig: " + getOutputConfig() + ","); if (getKMSKeyId() != null) sb.append("KMSKeyId: " + getKMSKeyId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDocumentLocation() == null) ? 0 : getDocumentLocation().hashCode()); hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); hashCode = prime * hashCode + ((getJobTag() == null) ? 0 : getJobTag().hashCode()); hashCode = prime * hashCode + ((getNotificationChannel() == null) ? 0 : getNotificationChannel().hashCode()); hashCode = prime * hashCode + ((getOutputConfig() == null) ? 0 : getOutputConfig().hashCode()); hashCode = prime * hashCode + ((getKMSKeyId() == null) ? 0 : getKMSKeyId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartDocumentTextDetectionRequest == false) return false; StartDocumentTextDetectionRequest other = (StartDocumentTextDetectionRequest) obj; if (other.getDocumentLocation() == null ^ this.getDocumentLocation() == null) return false; if (other.getDocumentLocation() != null && other.getDocumentLocation().equals(this.getDocumentLocation()) == false) return false; if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null) return false; if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false) return false; if (other.getJobTag() == null ^ this.getJobTag() == null) return false; if (other.getJobTag() != null && other.getJobTag().equals(this.getJobTag()) == false) return false; if (other.getNotificationChannel() == null ^ this.getNotificationChannel() == null) return false; if (other.getNotificationChannel() != null && other.getNotificationChannel().equals(this.getNotificationChannel()) == false) return false; if (other.getOutputConfig() == null ^ this.getOutputConfig() == null) return false; if (other.getOutputConfig() != null && other.getOutputConfig().equals(this.getOutputConfig()) == false) return false; if (other.getKMSKeyId() == null ^ this.getKMSKeyId() == null) return false; if (other.getKMSKeyId() != null && other.getKMSKeyId().equals(this.getKMSKeyId()) == false) return false; return true; } }