@Generated(value="software.amazon.awssdk:codegen") public final class StartDocumentAnalysisRequest extends TextractRequest implements ToCopyableBuilder<StartDocumentAnalysisRequest.Builder,StartDocumentAnalysisRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
StartDocumentAnalysisRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static StartDocumentAnalysisRequest.Builder |
builder() |
String |
clientRequestToken()
The idempotent token that you use to identify the start request.
|
DocumentLocation |
documentLocation()
The location of the document to be processed.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<FeatureType> |
featureTypes()
A list of the types of analysis to perform.
|
List<String> |
featureTypesAsStrings()
A list of the types of analysis to perform.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasFeatureTypes()
Returns true if the FeatureTypes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
String |
jobTag()
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
|
String |
kmsKeyId()
The KMS key used to encrypt the inference results.
|
NotificationChannel |
notificationChannel()
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
|
OutputConfig |
outputConfig()
Sets if the output will go to a customer defined bucket.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends StartDocumentAnalysisRequest.Builder> |
serializableBuilderClass() |
StartDocumentAnalysisRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final DocumentLocation documentLocation()
The location of the document to be processed.
public final List<FeatureType> 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
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFeatureTypes()
to see if a value was sent in this field.
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
).public final boolean hasFeatureTypes()
public final List<String> featureTypesAsStrings()
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
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFeatureTypes()
to see if a value was sent in this field.
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
).public final 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.
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.public final 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).
JobTag
to identify the type of document that the completion
notification corresponds to (such as a tax form or a receipt).public final NotificationChannel notificationChannel()
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
public final 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.
public final 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.
public StartDocumentAnalysisRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartDocumentAnalysisRequest.Builder,StartDocumentAnalysisRequest>
toBuilder
in class TextractRequest
public static StartDocumentAnalysisRequest.Builder builder()
public static Class<? extends StartDocumentAnalysisRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.