Package software.amazon.awssdk.services.textract.model

Class DetectDocumentTextResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectDocumentTextResponse.Builder,DetectDocumentTextResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DetectDocumentTextResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<Block>	blocks()	An array of Block objects that contain the text that's detected in the document.
static DetectDocumentTextResponse.Builder	builder()
String	detectDocumentTextModelVersion()
DocumentMetadata	documentMetadata()	Metadata about the 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()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DetectDocumentTextResponse.Builder>	serializableBuilderClass()
DetectDocumentTextResponse.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 document. It contains the number of pages that are detected in the document.

Returns:

Metadata about the document. It contains the number of pages that are detected in the document.

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

An array of Block objects that contain the text that's detected in the document.

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:

An array of Block objects that contain the text that's detected in the document.

detectDocumentTextModelVersion

public final String detectDocumentTextModelVersion()

Returns:

toBuilder

public DetectDocumentTextResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectDocumentTextResponse.Builder,DetectDocumentTextResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DetectDocumentTextResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo