software.amazon.awssdk.services.textract.model

Class AnalyzeDocumentRequest

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(value="software.amazon.awssdk:codegen")
public final class AnalyzeDocumentRequest
extends TextractRequest
implements ToCopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnalyzeDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
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() 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()
HumanLoopConfig	humanLoopConfig() Sets the configuration for the human in the loop workflow for analyzing documents.
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 or PNG 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 or PNG 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. 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.

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 ).

hasFeatureTypes

public final 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). For responses returned by the SDK, the sender is the AWS service.

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. 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.

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 ).

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.

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