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

Class SplitDocument

java.lang.Object

software.amazon.awssdk.services.textract.model.SplitDocument

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SplitDocument.Builder,SplitDocument>

@Generated("software.amazon.awssdk:codegen")
public final class SplitDocument
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SplitDocument.Builder,SplitDocument>

Contains information about the pages of a document, defined by logical boundary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SplitDocument.Builder

Method Summary

Modifier and Type	Method	Description
static SplitDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPages()	For responses, this returns true if the service returned a value for the Pages property.
Integer	index()	The index for a given document in a DocumentGroup of a specific Type.
List<Integer>	pages()	An array of page numbers for a for a given document, ordered by logical boundary.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SplitDocument.Builder>	serializableBuilderClass()
SplitDocument.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

index

public final Integer index()

The index for a given document in a DocumentGroup of a specific Type.

Returns:

The index for a given document in a DocumentGroup of a specific Type.

hasPages

public final boolean hasPages()

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

pages

public final List<Integer> pages()

An array of page numbers for a for a given document, ordered by logical boundary.

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

Returns:

An array of page numbers for a for a given document, ordered by logical boundary.

toBuilder

public SplitDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SplitDocument.Builder,SplitDocument>

builder

public static SplitDocument.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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