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

Class PageClassification

java.lang.Object

software.amazon.awssdk.services.textract.model.PageClassification

All Implemented Interfaces:

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

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

The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PageClassification.Builder

Method Summary

Modifier and Type	Method	Description
static PageClassification.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPageNumber()	For responses, this returns true if the service returned a value for the PageNumber property.
boolean	hasPageType()	For responses, this returns true if the service returned a value for the PageType property.
List<Prediction>	pageNumber()	The page number the value was detected on, relative to Amazon Textract's starting position.
List<Prediction>	pageType()	The class, or document type, assigned to a detected Page object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PageClassification.Builder>	serializableBuilderClass()
PageClassification.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

hasPageType

public final boolean hasPageType()

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

pageType

public final List<Prediction> pageType()

The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.

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

Returns:

The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.

hasPageNumber

public final boolean hasPageNumber()

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

pageNumber

public final List<Prediction> pageNumber()

The page number the value was detected on, relative to Amazon Textract's starting position.

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

Returns:

The page number the value was detected on, relative to Amazon Textract's starting position.

toBuilder

public PageClassification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PageClassification.Builder,PageClassification>

builder

public static PageClassification.Builder builder()

serializableBuilderClass

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