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

Class AnalyzeIdResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.textract.model.TextractResponse

software.amazon.awssdk.services.textract.model.AnalyzeIdResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AnalyzeIdResponse.Builder,AnalyzeIdResponse>

@Generated("software.amazon.awssdk:codegen")
public final class AnalyzeIdResponse
extends TextractResponse
implements ToCopyableBuilder<AnalyzeIdResponse.Builder,AnalyzeIdResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalyzeIdResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	analyzeIDModelVersion()	The version of the AnalyzeIdentity API being used to process documents.
static AnalyzeIdResponse.Builder	builder()
DocumentMetadata	documentMetadata()	Returns the value of the DocumentMetadata property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentityDocuments()	For responses, this returns true if the service returned a value for the IdentityDocuments property.
List<IdentityDocument>	identityDocuments()	The list of documents processed by AnalyzeID.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyzeIdResponse.Builder>	serializableBuilderClass()
AnalyzeIdResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.textract.model.TextractResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasIdentityDocuments

public final boolean hasIdentityDocuments()

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

identityDocuments

public final List<IdentityDocument> identityDocuments()

The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

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

Returns:

The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

documentMetadata

public final DocumentMetadata documentMetadata()

Returns the value of the DocumentMetadata property for this object.

Returns:

The value of the DocumentMetadata property for this object.

analyzeIDModelVersion

public final String analyzeIDModelVersion()

The version of the AnalyzeIdentity API being used to process documents.

Returns:

The version of the AnalyzeIdentity API being used to process documents.

toBuilder

public AnalyzeIdResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyzeIdResponse.Builder,AnalyzeIdResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static AnalyzeIdResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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