StartDocumentAnalysisRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.textract.model.StartDocumentAnalysisRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartDocumentAnalysisRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
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, 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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartDocumentAnalysisRequest()

Constructors
Constructor and Description
`StartDocumentAnalysisRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientRequestToken()` The idempotent token that you use to identify the start request.
`DocumentLocation`	`getDocumentLocation()` The location of the document to be processed.
`java.util.List<java.lang.String>`	`getFeatureTypes()` A list of the types of analysis to perform.
`java.lang.String`	`getJobTag()` An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
`java.lang.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(java.lang.String clientRequestToken)` The idempotent token that you use to identify the start request.
`void`	`setDocumentLocation(DocumentLocation documentLocation)` The location of the document to be processed.
`void`	`setFeatureTypes(java.util.Collection<java.lang.String> featureTypes)` A list of the types of analysis to perform.
`void`	`setJobTag(java.lang.String jobTag)` An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
`void`	`setKMSKeyId(java.lang.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.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartDocumentAnalysisRequest`	`withClientRequestToken(java.lang.String clientRequestToken)` The idempotent token that you use to identify the start request.
`StartDocumentAnalysisRequest`	`withDocumentLocation(DocumentLocation documentLocation)` The location of the document to be processed.
`StartDocumentAnalysisRequest`	`withFeatureTypes(java.util.Collection<java.lang.String> featureTypes)` A list of the types of analysis to perform.
`StartDocumentAnalysisRequest`	`withFeatureTypes(java.lang.String... featureTypes)` A list of the types of analysis to perform.
`StartDocumentAnalysisRequest`	`withJobTag(java.lang.String jobTag)` An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
`StartDocumentAnalysisRequest`	`withKMSKeyId(java.lang.String kMSKeyId)` The KMS key used to encrypt the inference results.
`StartDocumentAnalysisRequest`	`withNotificationChannel(NotificationChannel notificationChannel)` The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
`StartDocumentAnalysisRequest`	`withOutputConfig(OutputConfig outputConfig)` Sets if the output will go to a customer defined bucket.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartDocumentAnalysisRequest
```
public StartDocumentAnalysisRequest()
```
- Method Detail
  - getDocumentLocation
```
public DocumentLocation getDocumentLocation()
```
    The location of the document to be processed.
    
    Returns:
    
    The location of the document to be processed.
  - setDocumentLocation
```
public void setDocumentLocation(DocumentLocation documentLocation)
```
    The location of the document to be processed.
    
    Parameters:
    
    documentLocation -
    The location of the document to be processed.
  - withDocumentLocation
```
public StartDocumentAnalysisRequest withDocumentLocation(DocumentLocation documentLocation)
```
    The location of the document to be processed.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    documentLocation -
    The location of the document to be processed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFeatureTypes
```
public java.util.List<java.lang.String> getFeatureTypes()
```
    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 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).
  - setFeatureTypes
```
public void setFeatureTypes(java.util.Collection<java.lang.String> 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).
    
    Parameters:
    
    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).
  - withFeatureTypes
```
public StartDocumentAnalysisRequest withFeatureTypes(java.lang.String... 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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - withFeatureTypes
```
public StartDocumentAnalysisRequest withFeatureTypes(java.util.Collection<java.lang.String> 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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - getClientRequestToken
```
public java.lang.String getClientRequestToken()
```
    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-_]+$
    
    Returns:
    
    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.
  - setClientRequestToken
```
public void setClientRequestToken(java.lang.String 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.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    Parameters:
    
    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.
  - withClientRequestToken
```
public StartDocumentAnalysisRequest withClientRequestToken(java.lang.String 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobTag
```
public java.lang.String getJobTag()
```
    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_.\-:]+
    
    Returns:
    
    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).
  - setJobTag
```
public void setJobTag(java.lang.String 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).
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.\-:]+
    
    Parameters:
    
    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).
  - withJobTag
```
public StartDocumentAnalysisRequest withJobTag(java.lang.String 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).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.\-:]+
    
    Parameters:
    
    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).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withNotificationChannel
```
public StartDocumentAnalysisRequest withNotificationChannel(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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - 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 GetDocumentAnalysis 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 GetDocumentAnalysis operation.
  - 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 GetDocumentAnalysis 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 GetDocumentAnalysis operation.
  - withOutputConfig
```
public StartDocumentAnalysisRequest 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 GetDocumentAnalysis operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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 GetDocumentAnalysis operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKMSKeyId
```
public java.lang.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.
    
    Constraints:
    Length: 1 - 2048
    Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
    
    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.
  - setKMSKeyId
```
public void setKMSKeyId(java.lang.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.
    
    Constraints:
    Length: 1 - 2048
    Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
    
    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.
  - withKMSKeyId
```
public StartDocumentAnalysisRequest withKMSKeyId(java.lang.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.
    
    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}$
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartDocumentAnalysisRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartDocumentAnalysisRequest

Method Detail

getDocumentLocation

setDocumentLocation

withDocumentLocation

getFeatureTypes

setFeatureTypes

withFeatureTypes

withFeatureTypes

getClientRequestToken

setClientRequestToken

withClientRequestToken

getJobTag

setJobTag

withJobTag

getNotificationChannel

setNotificationChannel

withNotificationChannel

getOutputConfig

setOutputConfig

withOutputConfig

getKMSKeyId

setKMSKeyId

withKMSKeyId

toString

hashCode

equals