* Starts the asynchronous analysis of an input document for relationships * between detected items such as key-value pairs, tables, and selection * elements. *
*
* StartDocumentAnalysis 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.
*
* StartDocumentAnalysis returns a job identifier (
* JobId) that you use to get the results of the operation. When
* text analysis 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 analysis
* operation, first check that the status value published to the Amazon SNS
* topic is SUCCEEDED. If so, call GetDocumentAnalysis, and
* pass the job identifier (JobId) from the initial call to
* StartDocumentAnalysis.
*
* For more information, see Document Text Analysis. *
*/ public class StartDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable { /** ** The location of the document to be processed. *
*/ private DocumentLocation documentLocation; /** *
* A list of the types of analysis to perform. Add TABLES to the list to
* return information about the tables that are detected in the input
* document. Add FORMS to return detected form data. To perform both types
* of analysis, add TABLES and FORMS to FeatureTypes. All lines
* and words detected in the document are included in the response
* (including text that isn't related to the value of
* FeatureTypes).
*
* The idempotent token that you use to identify the start request. If you
* use the same token with multiple StartDocumentAnalysis
* 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 by the * GetDocumentAnalysis 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 StartDocumentAnalysisRequest withDocumentLocation(DocumentLocation documentLocation) { this.documentLocation = documentLocation; return this; } /** *
* A list of the types of analysis to perform. Add TABLES to the list to
* return information about the tables that are detected in the input
* document. Add FORMS to return detected form data. To perform both types
* of analysis, add TABLES and FORMS to FeatureTypes. All lines
* and words detected in the document are included in the response
* (including text that isn't related to the value of
* FeatureTypes).
*
* A list of the types of analysis to perform. Add TABLES to the
* list to return information about the tables that are detected in
* the input document. Add FORMS to return detected form data. To
* perform both types of analysis, add TABLES and FORMS to
* FeatureTypes. All lines and words detected in the
* document are included in the response (including text that isn't
* related to the value of FeatureTypes).
*
* A list of the types of analysis to perform. Add TABLES to the list to
* return information about the tables that are detected in the input
* document. Add FORMS to return detected form data. To perform both types
* of analysis, add TABLES and FORMS to FeatureTypes. All lines
* and words detected in the document are included in the response
* (including text that isn't related to the value of
* FeatureTypes).
*
* A list of the types of analysis to perform. Add TABLES to the
* list to return information about the tables that are detected
* in the input document. Add FORMS to return detected form data.
* To perform both types of analysis, add TABLES and FORMS to
* FeatureTypes. All lines and words detected in the
* document are included in the response (including text that
* isn't related to the value of FeatureTypes).
*
* A list of the types of analysis to perform. Add TABLES to the list to
* return information about the tables that are detected in the input
* document. Add FORMS to return detected form data. To perform both types
* of analysis, add TABLES and FORMS to FeatureTypes. All lines
* and words detected in the document are included in the response
* (including text that isn't related to the value of
* FeatureTypes).
*
* Returns a reference to this object so that method calls can be chained * together. * * @param featureTypes
* A list of the types of analysis to perform. Add TABLES to the
* list to return information about the tables that are detected
* in the input document. Add FORMS to return detected form data.
* To perform both types of analysis, add TABLES and FORMS to
* FeatureTypes. All lines and words detected in the
* document are included in the response (including text that
* isn't related to the value of FeatureTypes).
*
* A list of the types of analysis to perform. Add TABLES to the list to
* return information about the tables that are detected in the input
* document. Add FORMS to return detected form data. To perform both types
* of analysis, add TABLES and FORMS to FeatureTypes. All lines
* and words detected in the document are included in the response
* (including text that isn't related to the value of
* FeatureTypes).
*
* Returns a reference to this object so that method calls can be chained * together. * * @param featureTypes
* A list of the types of analysis to perform. Add TABLES to the
* list to return information about the tables that are detected
* in the input document. Add FORMS to return detected form data.
* To perform both types of analysis, add TABLES and FORMS to
* FeatureTypes. All lines and words detected in the
* document are included in the response (including text that
* isn't related to the value of FeatureTypes).
*
* The idempotent token that you use to identify the start request. If you
* use the same token with multiple StartDocumentAnalysis
* 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 you use to identify the start request.
* If you use the same token with multiple
* StartDocumentAnalysis 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 you use to identify the start request. If you
* use the same token with multiple StartDocumentAnalysis
* 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 you use to identify the start
* request. If you use the same token with multiple
* StartDocumentAnalysis 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 you use to identify the start request. If you
* use the same token with multiple StartDocumentAnalysis
* 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 you use to identify the start
* request. If you use the same token with multiple
* StartDocumentAnalysis 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 StartDocumentAnalysisRequest 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 by the * GetDocumentAnalysis 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 by the GetDocumentAnalysis 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 by the * GetDocumentAnalysis 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 by the GetDocumentAnalysis 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 by the * GetDocumentAnalysis 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 by the GetDocumentAnalysis operation. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentAnalysisRequest 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 StartDocumentAnalysisRequest withKMSKeyId(String kMSKeyId) { this.kMSKeyId = kMSKeyId; return this; } /** * * * @return */ public QueriesConfig getQueriesConfig() { return queriesConfig; } /** * * * @param queriesConfig */ public void setQueriesConfig(QueriesConfig queriesConfig) { this.queriesConfig = queriesConfig; } /** * ** Returns a reference to this object so that method calls can be chained * together. * * @param queriesConfig
* @return A reference to this updated object so that method calls can be * chained together. */ public StartDocumentAnalysisRequest withQueriesConfig(QueriesConfig queriesConfig) { this.queriesConfig = queriesConfig; 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 (getFeatureTypes() != null) sb.append("FeatureTypes: " + getFeatureTypes() + ","); 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() + ","); if (getQueriesConfig() != null) sb.append("QueriesConfig: " + getQueriesConfig()); 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 + ((getFeatureTypes() == null) ? 0 : getFeatureTypes().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()); hashCode = prime * hashCode + ((getQueriesConfig() == null) ? 0 : getQueriesConfig().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartDocumentAnalysisRequest == false) return false; StartDocumentAnalysisRequest other = (StartDocumentAnalysisRequest) obj; if (other.getDocumentLocation() == null ^ this.getDocumentLocation() == null) return false; if (other.getDocumentLocation() != null && other.getDocumentLocation().equals(this.getDocumentLocation()) == false) return false; if (other.getFeatureTypes() == null ^ this.getFeatureTypes() == null) return false; if (other.getFeatureTypes() != null && other.getFeatureTypes().equals(this.getFeatureTypes()) == 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; if (other.getQueriesConfig() == null ^ this.getQueriesConfig() == null) return false; if (other.getQueriesConfig() != null && other.getQueriesConfig().equals(this.getQueriesConfig()) == false) return false; return true; } }