software.amazon.awssdk.services.textract.model

Class AnalyzeDocumentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.textract.model.TextractResponse

software.amazon.awssdk.services.textract.model.AnalyzeDocumentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AnalyzeDocumentResponse.Builder,AnalyzeDocumentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class AnalyzeDocumentResponse
extends TextractResponse
implements ToCopyableBuilder<AnalyzeDocumentResponse.Builder,AnalyzeDocumentResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnalyzeDocumentResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	analyzeDocumentModelVersion() The version of the model used to analyze the document.
List<Block>	blocks() The items that are detected and analyzed by AnalyzeDocument.
static AnalyzeDocumentResponse.Builder	builder()
DocumentMetadata	documentMetadata() Metadata about the analyzed document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlocks() For responses, this returns true if the service returned a value for the Blocks property.
int	hashCode()
HumanLoopActivationOutput	humanLoopActivationOutput() Shows the results of the human in the loop evaluation.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyzeDocumentResponse.Builder>	serializableBuilderClass()
AnalyzeDocumentResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.textract.model.TextractResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

documentMetadata

public final DocumentMetadata documentMetadata()

Metadata about the analyzed document. An example is the number of pages.

Returns:

Metadata about the analyzed document. An example is the number of pages.

hasBlocks

public final boolean hasBlocks()

For responses, this returns true if the service returned a value for the Blocks 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.

blocks

public final List<Block> blocks()

The items that are detected and analyzed by AnalyzeDocument.

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 hasBlocks() method.

Returns:

The items that are detected and analyzed by AnalyzeDocument.

humanLoopActivationOutput

public final HumanLoopActivationOutput humanLoopActivationOutput()

Shows the results of the human in the loop evaluation.

Returns:

Shows the results of the human in the loop evaluation.

analyzeDocumentModelVersion

public final String analyzeDocumentModelVersion()

The version of the model used to analyze the document.

Returns:

The version of the model used to analyze the document.

toBuilder

public AnalyzeDocumentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyzeDocumentResponse.Builder,AnalyzeDocumentResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static AnalyzeDocumentResponse.Builder builder()

serializableBuilderClass

public static Class<? extends AnalyzeDocumentResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo