software.amazon.awssdk.services.textract.model

Class GetDocumentAnalysisResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentAnalysisResponse.Builder,GetDocumentAnalysisResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDocumentAnalysisResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	analyzeDocumentModelVersion()
List<Block>	blocks() The results of the text-analysis operation.
static GetDocumentAnalysisResponse.Builder	builder()
DocumentMetadata	documentMetadata() Information about a document that Amazon Textract processed.
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()
boolean	hasWarnings() For responses, this returns true if the service returned a value for the Warnings property.
JobStatus	jobStatus() The current status of the text detection job.
String	jobStatusAsString() The current status of the text detection job.
String	nextToken() If the response is truncated, Amazon Textract returns this token.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentAnalysisResponse.Builder>	serializableBuilderClass()
String	statusMessage() Returns if the detection job could not be completed.
GetDocumentAnalysisResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<Warning>	warnings() A list of warnings that occurred during the document-analysis operation.

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

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

Returns:

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

jobStatus

public final JobStatus jobStatus()

The current status of the text detection job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

The current status of the text detection job.

See Also:

JobStatus

jobStatusAsString

public final String jobStatusAsString()

The current status of the text detection job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

The current status of the text detection job.

See Also:

JobStatus

nextToken

public final String nextToken()

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

Returns:

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

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 results of the text-analysis operation.

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 results of the text-analysis operation.

hasWarnings

public final boolean hasWarnings()

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

warnings

public final List<Warning> warnings()

A list of warnings that occurred during the document-analysis operation.

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

Returns:

A list of warnings that occurred during the document-analysis operation.

statusMessage

public final String statusMessage()

Returns if the detection job could not be completed. Contains explanation for what error occured.

Returns:

Returns if the detection job could not be completed. Contains explanation for what error occured.

analyzeDocumentModelVersion

public final String analyzeDocumentModelVersion()

Returns:

toBuilder

public GetDocumentAnalysisResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDocumentAnalysisResponse.Builder,GetDocumentAnalysisResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetDocumentAnalysisResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetDocumentAnalysisResponse.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