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

Class IdentityDocument

java.lang.Object

software.amazon.awssdk.services.textract.model.IdentityDocument

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdentityDocument.Builder

Method Summary

Modifier and Type	Method	Description
List<Block>	blocks()	Individual word recognition, as returned by document detection.
static IdentityDocument.Builder	builder()
Integer	documentIndex()	Denotes the placement of a document in the IdentityDocument list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlocks()	For responses, this returns true if the service returned a value for the Blocks property.
int	hashCode()
boolean	hasIdentityDocumentFields()	For responses, this returns true if the service returned a value for the IdentityDocumentFields property.
List<IdentityDocumentField>	identityDocumentFields()	The structure used to record information extracted from identity documents.
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityDocument.Builder>	serializableBuilderClass()
IdentityDocument.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

documentIndex

public final Integer documentIndex()

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.

hasIdentityDocumentFields

public final boolean hasIdentityDocumentFields()

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

identityDocumentFields

public final List<IdentityDocumentField> identityDocumentFields()

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

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

Returns:

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

hasBlocks

public final boolean hasBlocks()

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

blocks

public final List<Block> blocks()

Individual word recognition, as returned by document detection.

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

Returns:

Individual word recognition, as returned by document detection.

toBuilder

public IdentityDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityDocument.Builder,IdentityDocument>

builder

public static IdentityDocument.Builder builder()

serializableBuilderClass

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