software.amazon.awssdk.services.textract.model

Class GetLendingAnalysisResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetLendingAnalysisResponse.Builder,GetLendingAnalysisResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetLendingAnalysisResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	analyzeLendingModelVersion() The current model version of the Analyze Lending API.
static GetLendingAnalysisResponse.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	hasResults() For responses, this returns true if the service returned a value for the Results property.
boolean	hasWarnings() For responses, this returns true if the service returned a value for the Warnings property.
JobStatus	jobStatus() The current status of the lending analysis job.
String	jobStatusAsString() The current status of the lending analysis job.
String	nextToken() If the response is truncated, Amazon Textract returns this token.
List<LendingResult>	results() Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.
List<SdkField<?>>	sdkFields()
static Class<? extends GetLendingAnalysisResponse.Builder>	serializableBuilderClass()
String	statusMessage() Returns if the lending analysis job could not be completed.
GetLendingAnalysisResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<Warning>	warnings() A list of warnings that occurred during the lending analysis operation.

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

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.

jobStatus

public final JobStatus jobStatus()

The current status of the lending analysis job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

The current status of the lending analysis job.

See Also:

JobStatus

jobStatusAsString

public final String jobStatusAsString()

The current status of the lending analysis job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

The current status of the lending analysis job.

See Also:

JobStatus

nextToken

public final String nextToken()

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.

Returns:

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.

hasResults

public final boolean hasResults()

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

results

public final List<LendingResult> results()

Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

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

Returns:

Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

hasWarnings

public final boolean hasWarnings()

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

warnings

public final List<Warning> warnings()

A list of warnings that occurred during the lending analysis operation.

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

Returns:

A list of warnings that occurred during the lending analysis operation.

statusMessage

public final String statusMessage()

Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.

Returns:

Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.

analyzeLendingModelVersion

public final String analyzeLendingModelVersion()

The current model version of the Analyze Lending API.

Returns:

The current model version of the Analyze Lending API.

toBuilder

public GetLendingAnalysisResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetLendingAnalysisResponse.Builder,GetLendingAnalysisResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetLendingAnalysisResponse.Builder builder()

serializableBuilderClass

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