com.amazonaws.services.textract.model

Class PageClassification

java.lang.Object

com.amazonaws.services.textract.model.PageClassification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PageClassification
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageClassification()

Method Summary

Modifier and Type	Method and Description
PageClassification	clone()
boolean	equals(Object obj)
List<Prediction>	getPageNumber() The page number the value was detected on, relative to Amazon Textract's starting position.
List<Prediction>	getPageType() The class, or document type, assigned to a detected Page object.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPageNumber(Collection<Prediction> pageNumber) The page number the value was detected on, relative to Amazon Textract's starting position.
void	setPageType(Collection<Prediction> pageType) The class, or document type, assigned to a detected Page object.
String	toString() Returns a string representation of this object.
PageClassification	withPageNumber(Collection<Prediction> pageNumber) The page number the value was detected on, relative to Amazon Textract's starting position.
PageClassification	withPageNumber(Prediction... pageNumber) The page number the value was detected on, relative to Amazon Textract's starting position.
PageClassification	withPageType(Collection<Prediction> pageType) The class, or document type, assigned to a detected Page object.
PageClassification	withPageType(Prediction... pageType) The class, or document type, assigned to a detected Page object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageClassification

public PageClassification()

Method Detail

getPageType

public List<Prediction> getPageType()

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

Returns:

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

setPageType

public void setPageType(Collection<Prediction> pageType)

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

Parameters:

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

withPageType

public PageClassification withPageType(Prediction... pageType)

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

NOTE: This method appends the values to the existing list (if any). Use setPageType(java.util.Collection) or withPageType(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withPageType

public PageClassification withPageType(Collection<Prediction> pageType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getPageNumber

public List<Prediction> getPageNumber()

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

Returns:

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

setPageNumber

public void setPageNumber(Collection<Prediction> pageNumber)

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

Parameters:

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

withPageNumber

public PageClassification withPageNumber(Prediction... pageNumber)

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

NOTE: This method appends the values to the existing list (if any). Use setPageNumber(java.util.Collection) or withPageNumber(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withPageNumber

public PageClassification withPageNumber(Collection<Prediction> pageNumber)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PageClassification clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.