com.amazonaws.services.textract.model

Class StartExpenseAnalysisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.textract.model.StartExpenseAnalysisRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartExpenseAnalysisRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartExpenseAnalysisRequest()

Method Summary

Modifier and Type	Method and Description
StartExpenseAnalysisRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() The idempotent token that's used to identify the start request.
DocumentLocation	getDocumentLocation() The location of the document to be processed.
String	getJobTag() An identifier you specify that's included in the completion notification published to the Amazon SNS topic.
String	getKMSKeyId() The KMS key used to encrypt the inference results.
NotificationChannel	getNotificationChannel() The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig	getOutputConfig() Sets if the output will go to a customer defined bucket.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) The idempotent token that's used to identify the start request.
void	setDocumentLocation(DocumentLocation documentLocation) The location of the document to be processed.
void	setJobTag(String jobTag) An identifier you specify that's included in the completion notification published to the Amazon SNS topic.
void	setKMSKeyId(String kMSKeyId) The KMS key used to encrypt the inference results.
void	setNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
void	setOutputConfig(OutputConfig outputConfig) Sets if the output will go to a customer defined bucket.
String	toString() Returns a string representation of this object.
StartExpenseAnalysisRequest	withClientRequestToken(String clientRequestToken) The idempotent token that's used to identify the start request.
StartExpenseAnalysisRequest	withDocumentLocation(DocumentLocation documentLocation) The location of the document to be processed.
StartExpenseAnalysisRequest	withJobTag(String jobTag) An identifier you specify that's included in the completion notification published to the Amazon SNS topic.
StartExpenseAnalysisRequest	withKMSKeyId(String kMSKeyId) The KMS key used to encrypt the inference results.
StartExpenseAnalysisRequest	withNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
StartExpenseAnalysisRequest	withOutputConfig(OutputConfig outputConfig) Sets if the output will go to a customer defined bucket.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartExpenseAnalysisRequest

public StartExpenseAnalysisRequest()

Method Detail

setDocumentLocation

public void setDocumentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Parameters:

documentLocation - The location of the document to be processed.

getDocumentLocation

public DocumentLocation getDocumentLocation()

The location of the document to be processed.

Returns:

The location of the document to be processed.

withDocumentLocation

public StartExpenseAnalysisRequest withDocumentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Parameters:

documentLocation - The location of the document to be processed.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientRequestToken

public void setClientRequestToken(String 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

Parameters:

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

getClientRequestToken

public String getClientRequestToken()

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:

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

withClientRequestToken

public StartExpenseAnalysisRequest withClientRequestToken(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setJobTag

public void setJobTag(String 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).

Parameters:

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

getJobTag

public String getJobTag()

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

Returns:

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

withJobTag

public StartExpenseAnalysisRequest withJobTag(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotificationChannel

public void setNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Parameters:

notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

getNotificationChannel

public NotificationChannel getNotificationChannel()

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

withNotificationChannel

public StartExpenseAnalysisRequest withNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Parameters:

notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputConfig

public void setOutputConfig(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.

Parameters:

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.

getOutputConfig

public OutputConfig getOutputConfig()

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.

Returns:

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.

withOutputConfig

public StartExpenseAnalysisRequest withOutputConfig(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKMSKeyId

public void setKMSKeyId(String 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.

Parameters:

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.

getKMSKeyId

public String getKMSKeyId()

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:

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.

withKMSKeyId

public StartExpenseAnalysisRequest withKMSKeyId(String 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartExpenseAnalysisRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()