Class AnalyzeDocumentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AnalyzeDocumentRequest.Builder,
AnalyzeDocumentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AdaptersConfig
Specifies the adapter to be used when analyzing a document.builder()
final Document
document()
The input document as base64-encoded bytes or an Amazon S3 object.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 HumanLoopConfig
Sets the configuration for the human in the loop workflow for analyzing documents.final QueriesConfig
Contains Queries and the alias for those Queries, as determined by the input.static Class
<? extends AnalyzeDocumentRequest.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
-
document
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the
Bytes
field.- Returns:
- The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon
Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF
format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the
Bytes
field.
-
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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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.
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. Add SIGNATURES to return
the locations of detected signatures. Add LAYOUT to the list to return information about the layout of
the document. All lines and words detected in the document are included in the response (including text
that isn't related to the value of
FeatureTypes
).
-
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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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.
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. Add SIGNATURES to return
the locations of detected signatures. Add LAYOUT to the list to return information about the layout of
the document. All lines and words detected in the document are included in the response (including text
that isn't related to the value of
FeatureTypes
).
-
humanLoopConfig
Sets the configuration for the human in the loop workflow for analyzing documents.
- Returns:
- Sets the configuration for the human in the loop workflow for analyzing documents.
-
queriesConfig
Contains Queries and the alias for those Queries, as determined by the input.
- Returns:
- Contains Queries and the alias for those Queries, as determined by the input.
-
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<AnalyzeDocumentRequest.Builder,
AnalyzeDocumentRequest> - 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
-