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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DetectDocumentTextResponse.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasBlocks() Returns true if the Blocks 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()
List<SdkField<?>>	sdkFields()
static Class<? extends DetectDocumentTextResponse.Builder>	serializableBuilderClass()
DetectDocumentTextResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

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

Returns true if the Blocks 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.

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.

You can use hasBlocks() to see if a value was sent in this field.

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DetectDocumentTextResponse.Builder,DetectDocumentTextResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.