Class StartDocumentAnalysisRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartDocumentAnalysisRequest.Builder,
StartDocumentAnalysisRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AdaptersConfig
Specifies the adapter to be used when analyzing a document.builder()
final String
The idempotent token that you use to identify the start request.final DocumentLocation
The location of the document to be processed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<FeatureType> A list of the types of analysis to perform.A list of the types of analysis to perform.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the FeatureTypes property.final int
hashCode()
final String
jobTag()
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.final String
kmsKeyId()
The KMS key used to encrypt the inference results.final NotificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.final OutputConfig
Sets if the output will go to a customer defined bucket.final QueriesConfig
Returns the value of the QueriesConfig property for this object.static Class
<? extends StartDocumentAnalysisRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentLocation
The location of the document to be processed.
- Returns:
- The location of the document to be processed.
-
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 ofFeatureTypes
).Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFeatureTypes()
method.- 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 ofFeatureTypes
).
-
hasFeatureTypes
public final boolean hasFeatureTypes()For responses, this returns true if the service returned a value for the FeatureTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 ofFeatureTypes
).Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFeatureTypes()
method.- 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 ofFeatureTypes
).
-
clientRequestToken
The idempotent token that you use to identify the start request. If you use the same token with multiple
StartDocumentAnalysis
requests, the sameJobId
is returned. UseClientRequestToken
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 you use to identify the start request. If you use the same token with multiple
StartDocumentAnalysis
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
-
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:
- 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).
-
notificationChannel
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.
-
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:
- 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.
-
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:
- 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.
-
queriesConfig
Returns the value of the QueriesConfig property for this object.- Returns:
- The value of the QueriesConfig property for this object.
-
adaptersConfig
Specifies the adapter to be used when analyzing a document.
- Returns:
- Specifies the adapter to be used when analyzing a document.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartDocumentAnalysisRequest.Builder,
StartDocumentAnalysisRequest> - Specified by:
toBuilder
in classTextractRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-