/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.textract.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Starts the classification and analysis of an input document. * StartLendingAnalysis initiates the classification and analysis * of a packet of lending documents. StartLendingAnalysis operates * on a document file located in an Amazon S3 bucket. *

* StartLendingAnalysis can analyze text in documents that are in * one of the following formats: JPEG, PNG, TIFF, PDF. Use * DocumentLocation to specify the bucket name and the file name of * the document. *

* StartLendingAnalysis returns a job identifier ( * JobId) that you use to get the results of the operation. When * the 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 the status is SUCCEEDED you can call either * GetLendingAnalysis or GetLendingAnalysisSummary and * provide the JobId to obtain the results of the analysis. *

* If using OutputConfig to specify an Amazon S3 bucket, the output * will be contained within the specified prefix in a directory labeled with the * job-id. In the directory there are 3 sub-directories: *

*
* detailedResponse (contains the GetLendingAnalysis response) *
*
*
* summaryResponse (for the GetLendingAnalysisSummary response) *
*
*
* splitDocuments (documents split across logical boundaries) *
*

*/ public class StartLendingAnalysisRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The Amazon S3 bucket that contains the document to be processed. It's * used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. It can * also be a file in PDF format. *

*/ private DocumentLocation documentLocation; /** *

* The idempotent token that you use to identify the start request. If you * use the same token with multiple StartLendingAnalysis * 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 to be 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 Simple Notification Service (Amazon SNS) topic to which Amazon * Textract publishes the completion status of an asynchronous document * operation. *

*/ private NotificationChannel notificationChannel; /** *

* Sets whether or not your output will go to a user created bucket. Used to * set the name of the bucket, and the prefix on the output file. *

* OutputConfig is an optional parameter which lets you adjust * where your output will be placed. By default, Amazon Textract will store * the results internally and can only be accessed by the Get API * operations. With OutputConfig enabled, you can set the name * of the bucket the output will be sent to the file prefix of the results * where you can download your results. Additionally, you can set the * KMSKeyID parameter to a customer master key (CMK) to encrypt * your output. Without this parameter set Amazon Textract will encrypt * server-side using the AWS managed CMK for Amazon S3. *

* Decryption of Customer Content is necessary for processing of the * documents by Amazon Textract. If your account is opted out under an AI * services opt out policy then all unencrypted Customer Content is * immediately and permanently deleted after the Customer Content has been * processed by the service. No copy of of the output is retained by Amazon * Textract. For information about how to opt out, see Managing AI services opt-out policy. *

* For more information on data privacy, see the Data Privacy * FAQ. *

*/ 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 Amazon S3 bucket that contains the document to be processed. It's * used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. It can * also be a file in PDF format. *

* * @return

* The Amazon S3 bucket that contains the document to be processed. * It's used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. It * can also be a file in PDF format. *

*/ public DocumentLocation getDocumentLocation() { return documentLocation; } /** *

* The Amazon S3 bucket that contains the document to be processed. It's * used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. It can * also be a file in PDF format. *

* * @param documentLocation

* The Amazon S3 bucket that contains the document to be * processed. It's used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. * It can also be a file in PDF format. *

*/ public void setDocumentLocation(DocumentLocation documentLocation) { this.documentLocation = documentLocation; } /** *

* The Amazon S3 bucket that contains the document to be processed. It's * used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. It can * also be a file in PDF format. *

* Returns a reference to this object so that method calls can be chained * together. * * @param documentLocation

* The Amazon S3 bucket that contains the document to be * processed. It's used by asynchronous operations. *

* The input document can be an image file in JPEG or PNG format. * It can also be a file in PDF format. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLendingAnalysisRequest withDocumentLocation(DocumentLocation documentLocation) { this.documentLocation = documentLocation; return this; } /** *

* 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 * StartLendingAnalysis 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. *

*/ public String getClientRequestToken() { return clientRequestToken; } /** *

* 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 * StartLendingAnalysis 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. *

*/ public void setClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; } /** *

* 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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLendingAnalysisRequest withClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; return this; } /** *

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.\-:]+
* * @return

* An identifier that you specify to be 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). *

*/ public String getJobTag() { return jobTag; } /** *

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9_.\-:]+
* * @param jobTag

* An identifier that you specify to be 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). *

*/ public void setJobTag(String jobTag) { this.jobTag = jobTag; } /** *

* 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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLendingAnalysisRequest withJobTag(String jobTag) { this.jobTag = jobTag; return this; } /** *

* The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon * Textract publishes the completion status of an asynchronous document * operation. *

* * @return

* The Amazon Simple Notification Service (Amazon SNS) topic to * which Amazon Textract publishes the completion status of an * asynchronous document operation. *

*/ public NotificationChannel getNotificationChannel() { return notificationChannel; } /** *

* The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon * Textract publishes the completion status of an asynchronous document * operation. *

* * @param notificationChannel

* The Amazon Simple Notification Service (Amazon SNS) topic to * which Amazon Textract publishes the completion status of an * asynchronous document operation. *

*/ public void setNotificationChannel(NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; } /** *

* The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon * Textract publishes the completion status of an asynchronous document * operation. *

* Returns a reference to this object so that method calls can be chained * together. * * @param notificationChannel

* The Amazon Simple Notification Service (Amazon SNS) topic to * which Amazon Textract publishes the completion status of an * asynchronous document operation. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLendingAnalysisRequest withNotificationChannel( NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; return this; } /** *

* Sets whether or not your output will go to a user created bucket. Used to * set the name of the bucket, and the prefix on the output file. *

* For more information on data privacy, see the Data Privacy * FAQ. *

* * @return

* Sets whether or not your output will go to a user created bucket. * Used to set the name of the bucket, and the prefix on the output * file. *

* OutputConfig is an optional parameter which lets you * adjust where your output will be placed. By default, Amazon * Textract will store the results internally and can only be * accessed by the Get API operations. With * OutputConfig enabled, you can set the name of the * bucket the output will be sent to the file prefix of the results * where you can download your results. Additionally, you can set * the KMSKeyID parameter to a customer master key * (CMK) to encrypt your output. Without this parameter set Amazon * Textract will encrypt server-side using the AWS managed CMK for * Amazon S3. *

* Decryption of Customer Content is necessary for processing of the * documents by Amazon Textract. If your account is opted out under * an AI services opt out policy then all unencrypted Customer * Content is immediately and permanently deleted after the Customer * Content has been processed by the service. No copy of of the * output is retained by Amazon Textract. For information about how * to opt out, see Managing AI services opt-out policy. *

* For more information on data privacy, see the Data * Privacy FAQ. *

*/ public OutputConfig getOutputConfig() { return outputConfig; } /** *

* Sets whether or not your output will go to a user created bucket. Used to * set the name of the bucket, and the prefix on the output file. *

* For more information on data privacy, see the Data Privacy * FAQ. *

* * @param outputConfig

* Sets whether or not your output will go to a user created * bucket. Used to set the name of the bucket, and the prefix on * the output file. *

* OutputConfig is an optional parameter which lets * you adjust where your output will be placed. By default, * Amazon Textract will store the results internally and can only * be accessed by the Get API operations. With * OutputConfig enabled, you can set the name of the * bucket the output will be sent to the file prefix of the * results where you can download your results. Additionally, you * can set the KMSKeyID parameter to a customer * master key (CMK) to encrypt your output. Without this * parameter set Amazon Textract will encrypt server-side using * the AWS managed CMK for Amazon S3. *

* Decryption of Customer Content is necessary for processing of * the documents by Amazon Textract. If your account is opted out * under an AI services opt out policy then all unencrypted * Customer Content is immediately and permanently deleted after * the Customer Content has been processed by the service. No * copy of of the output is retained by Amazon Textract. For * information about how to opt out, see Managing AI services opt-out policy. *

* For more information on data privacy, see the Data Privacy FAQ. *

*/ public void setOutputConfig(OutputConfig outputConfig) { this.outputConfig = outputConfig; } /** *

* Sets whether or not your output will go to a user created bucket. Used to * set the name of the bucket, and the prefix on the output file. *

* For more information on data privacy, see the Data Privacy * FAQ. *

* Returns a reference to this object so that method calls can be chained * together. * * @param outputConfig

* Sets whether or not your output will go to a user created * bucket. Used to set the name of the bucket, and the prefix on * the output file. *

* For more information on data privacy, see the Data Privacy FAQ. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLendingAnalysisRequest withOutputConfig(OutputConfig outputConfig) { this.outputConfig = outputConfig; return this; } /** *

* 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; } /** *

* 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; } /** *

* 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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLendingAnalysisRequest 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 StartLendingAnalysisRequest == false) return false; StartLendingAnalysisRequest other = (StartLendingAnalysisRequest) 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; } }