software.amazon.awssdk.services.textract.model

Class LendingField

java.lang.Object

software.amazon.awssdk.services.textract.model.LendingField

All Implemented Interfaces:

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

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

Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LendingField.Builder

Method Summary

Modifier and Type	Method and Description
static LendingField.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValueDetections() For responses, this returns true if the service returned a value for the ValueDetections property.
LendingDetection	keyDetection() Returns the value of the KeyDetection property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends LendingField.Builder>	serializableBuilderClass()
LendingField.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The type of the lending document.
List<LendingDetection>	valueDetections() An array of LendingDetection objects.

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

type

public final String type()

The type of the lending document.

Returns:

The type of the lending document.

keyDetection

public final LendingDetection keyDetection()

Returns the value of the KeyDetection property for this object.

Returns:

The value of the KeyDetection property for this object.

hasValueDetections

public final boolean hasValueDetections()

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

valueDetections

public final List<LendingDetection> valueDetections()

An array of LendingDetection objects.

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

Returns:

An array of LendingDetection objects.

toBuilder

public LendingField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LendingField.Builder,LendingField>

builder

public static LendingField.Builder builder()

serializableBuilderClass

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