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

Class LendingResult

java.lang.Object

software.amazon.awssdk.services.textract.model.LendingResult

All Implemented Interfaces:

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

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

Contains the detections for each page analyzed through the Analyze Lending API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LendingResult.Builder

Method Summary

Modifier and Type	Method	Description
static LendingResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Extraction>	extractions()	An array of Extraction to hold structured data.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExtractions()	For responses, this returns true if the service returned a value for the Extractions property.
int	hashCode()
Integer	page()	The page number for a page, with regard to whole submission.
PageClassification	pageClassification()	The classifier result for a given page.
List<SdkField<?>>	sdkFields()
static Class<? extends LendingResult.Builder>	serializableBuilderClass()
LendingResult.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

page

public final Integer page()

The page number for a page, with regard to whole submission.

Returns:

The page number for a page, with regard to whole submission.

pageClassification

public final PageClassification pageClassification()

The classifier result for a given page.

Returns:

The classifier result for a given page.

hasExtractions

public final boolean hasExtractions()

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

extractions

public final List<Extraction> extractions()

An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .

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

Returns:

An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .

toBuilder

public LendingResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LendingResult.Builder,LendingResult>

builder

public static LendingResult.Builder builder()

serializableBuilderClass

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