com.amazonaws.services.textract.model

Class IdentityDocument

java.lang.Object

com.amazonaws.services.textract.model.IdentityDocument

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The structure that lists each document processed in an AnalyzeID operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentityDocument()

Method Summary

Modifier and Type	Method and Description
IdentityDocument	clone()
boolean	equals(Object obj)
List<Block>	getBlocks() Individual word recognition, as returned by document detection.
Integer	getDocumentIndex() Denotes the placement of a document in the IdentityDocument list.
List<IdentityDocumentField>	getIdentityDocumentFields() The structure used to record information extracted from identity documents.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBlocks(Collection<Block> blocks) Individual word recognition, as returned by document detection.
void	setDocumentIndex(Integer documentIndex) Denotes the placement of a document in the IdentityDocument list.
void	setIdentityDocumentFields(Collection<IdentityDocumentField> identityDocumentFields) The structure used to record information extracted from identity documents.
String	toString() Returns a string representation of this object.
IdentityDocument	withBlocks(Block... blocks) Individual word recognition, as returned by document detection.
IdentityDocument	withBlocks(Collection<Block> blocks) Individual word recognition, as returned by document detection.
IdentityDocument	withDocumentIndex(Integer documentIndex) Denotes the placement of a document in the IdentityDocument list.
IdentityDocument	withIdentityDocumentFields(Collection<IdentityDocumentField> identityDocumentFields) The structure used to record information extracted from identity documents.
IdentityDocument	withIdentityDocumentFields(IdentityDocumentField... identityDocumentFields) The structure used to record information extracted from identity documents.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IdentityDocument

public IdentityDocument()

Method Detail

setDocumentIndex

public void setDocumentIndex(Integer documentIndex)

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

Parameters:

documentIndex - Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

getDocumentIndex

public Integer getDocumentIndex()

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

Returns:

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

withDocumentIndex

public IdentityDocument withDocumentIndex(Integer documentIndex)

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

Parameters:

documentIndex - Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

Returns:

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

getIdentityDocumentFields

public List<IdentityDocumentField> getIdentityDocumentFields()

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Returns:

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

setIdentityDocumentFields

public void setIdentityDocumentFields(Collection<IdentityDocumentField> identityDocumentFields)

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Parameters:

identityDocumentFields - The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

withIdentityDocumentFields

public IdentityDocument withIdentityDocumentFields(IdentityDocumentField... identityDocumentFields)

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

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

Parameters:

identityDocumentFields - The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Returns:

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

withIdentityDocumentFields

public IdentityDocument withIdentityDocumentFields(Collection<IdentityDocumentField> identityDocumentFields)

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Parameters:

identityDocumentFields - The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Returns:

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

getBlocks

public List<Block> getBlocks()

Individual word recognition, as returned by document detection.

Returns:

Individual word recognition, as returned by document detection.

setBlocks

public void setBlocks(Collection<Block> blocks)

Individual word recognition, as returned by document detection.

Parameters:

blocks - Individual word recognition, as returned by document detection.

withBlocks

public IdentityDocument withBlocks(Block... blocks)

Individual word recognition, as returned by document detection.

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

Parameters:

blocks - Individual word recognition, as returned by document detection.

Returns:

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

withBlocks

public IdentityDocument withBlocks(Collection<Block> blocks)

Individual word recognition, as returned by document detection.

Parameters:

blocks - Individual word recognition, as returned by document detection.

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