java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.textract.model.TextractRequest
    - - software.amazon.awssdk.services.textract.model.AnalyzeDocumentRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AnalyzeDocumentRequest
extends TextractRequest
implements ToCopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AnalyzeDocumentRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AdaptersConfig`	`adaptersConfig()`	Specifies the adapter to be used when analyzing a document.
`static AnalyzeDocumentRequest.Builder`	`builder()`
`Document`	`document()`	The input document as base64-encoded bytes or an Amazon S3 object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`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)`
`boolean`	`hasFeatureTypes()`	For responses, this returns true if the service returned a value for the FeatureTypes property.
`int`	`hashCode()`
`HumanLoopConfig`	`humanLoopConfig()`	Sets the configuration for the human in the loop workflow for analyzing documents.
`QueriesConfig`	`queriesConfig()`	Contains Queries and the alias for those Queries, as determined by the input.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnalyzeDocumentRequest.Builder>`	`serializableBuilderClass()`
`AnalyzeDocumentRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - document
```
public final Document 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
```
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. 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 the isEmpty() 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
```
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. 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
```
public final HumanLoopConfig 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
```
public final QueriesConfig 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
```
public final AdaptersConfig adaptersConfig()
```
    Specifies the adapter to be used when analyzing a document.
    
    Returns:
    
    Specifies the adapter to be used when analyzing a document.
  - toBuilder
```
public AnalyzeDocumentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>
    
    Specified by:
    
    toBuilder in class TextractRequest
  - builder
```
public static AnalyzeDocumentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalyzeDocumentRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AnalyzeDocumentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

document

featureTypes

hasFeatureTypes

featureTypesAsStrings

humanLoopConfig

queriesConfig

adaptersConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField