/* * Copyright 2018-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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartExpenseAnalysisRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String clientRequestToken; /** *

* An identifier 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). *

*/ 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 GetExpenseAnalysis 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. *

*/ private String kMSKeyId; /** *

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

* * @return The location of the document to be processed. */ public DocumentLocation getDocumentLocation() { return this.documentLocation; } /** *

* The location of the document to be processed. *

* * @param documentLocation * The location of the document to be processed. * @return Returns a reference to this object so that method calls can be chained together. */ public StartExpenseAnalysisRequest withDocumentLocation(DocumentLocation documentLocation) { setDocumentLocation(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 *

* * @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 */ public void setClientRequestToken(String clientRequestToken) { this.clientRequestToken = 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 *

* * @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 */ public String getClientRequestToken() { return this.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 *

* * @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 * @return Returns a reference to this object so that method calls can be chained together. */ public StartExpenseAnalysisRequest withClientRequestToken(String clientRequestToken) { setClientRequestToken(clientRequestToken); return this; } /** *

* An identifier 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). *

* * @param jobTag * An identifier 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). */ public void setJobTag(String jobTag) { this.jobTag = jobTag; } /** *

* An identifier 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). *

* * @return An identifier 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). */ public String getJobTag() { return this.jobTag; } /** *

* An identifier 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). *

* * @param jobTag * An identifier 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). * @return Returns a reference to this object so that method calls can be chained together. */ public StartExpenseAnalysisRequest withJobTag(String jobTag) { setJobTag(jobTag); return this; } /** *

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

* * @return The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation * to. */ public NotificationChannel getNotificationChannel() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartExpenseAnalysisRequest withNotificationChannel(NotificationChannel notificationChannel) { setNotificationChannel(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 GetExpenseAnalysis 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 GetExpenseAnalysis 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 GetExpenseAnalysis 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 GetExpenseAnalysis operation. */ public OutputConfig getOutputConfig() { return this.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 GetExpenseAnalysis 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 GetExpenseAnalysis operation. * @return Returns a reference to this object so that method calls can be chained together. */ public StartExpenseAnalysisRequest withOutputConfig(OutputConfig outputConfig) { setOutputConfig(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. *

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

* * @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 this.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. *

* * @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 Returns a reference to this object so that method calls can be chained together. */ public StartExpenseAnalysisRequest withKMSKeyId(String kMSKeyId) { setKMSKeyId(kMSKeyId); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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: ").append(getDocumentLocation()).append(","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(","); if (getJobTag() != null) sb.append("JobTag: ").append(getJobTag()).append(","); if (getNotificationChannel() != null) sb.append("NotificationChannel: ").append(getNotificationChannel()).append(","); if (getOutputConfig() != null) sb.append("OutputConfig: ").append(getOutputConfig()).append(","); if (getKMSKeyId() != null) sb.append("KMSKeyId: ").append(getKMSKeyId()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartExpenseAnalysisRequest == false) return false; StartExpenseAnalysisRequest other = (StartExpenseAnalysisRequest) 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; } @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 StartExpenseAnalysisRequest clone() { return (StartExpenseAnalysisRequest) super.clone(); } }