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("software.amazon.awssdk:codegen") public final class GetLendingAnalysisResponse extends TextractResponse implements ToCopyableBuilder<GetLendingAnalysisResponse.Builder,GetLendingAnalysisResponse>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetLendingAnalysisResponse.Builder,GetLendingAnalysisResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.