software.amazon.awssdk.services.textract.model

Class GetDocumentTextDetectionResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDocumentTextDetectionResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<Block>	blocks() The results of the text-detection operation.
static GetDocumentTextDetectionResponse.Builder	builder()
String	detectDocumentTextModelVersion()
DocumentMetadata	documentMetadata() Information about a document that Amazon Textract processed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasBlocks() For responses, this returns true if the service returned a value for the Blocks property.
int	hashCode()
boolean	hasWarnings() For responses, this returns true if the service returned a value for the Warnings property.
JobStatus	jobStatus() The current status of the text detection job.
String	jobStatusAsString() The current status of the text detection job.
String	nextToken() If the response is truncated, Amazon Textract returns this token.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentTextDetectionResponse.Builder>	serializableBuilderClass()
String	statusMessage() Returns if the detection job could not be completed.
GetDocumentTextDetectionResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
List<Warning>	warnings() A list of warnings that occurred during the text-detection operation for the document.

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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

documentMetadata

public final DocumentMetadata documentMetadata()

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

Returns:

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

jobStatus

public final JobStatus jobStatus()

The current status of the text detection 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 text detection job.

See Also:

JobStatus

jobStatusAsString

public final String jobStatusAsString()

The current status of the text detection 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 text detection 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 text-detection 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 text-detection results.

hasBlocks

public final boolean hasBlocks()

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

blocks

public final List<Block> blocks()

The results of the text-detection 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 hasBlocks() method.

Returns:

The results of the text-detection operation.

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

Returns:

A list of warnings that occurred during the text-detection operation for the document.

statusMessage

public final String statusMessage()

Returns if the detection job could not be completed. Contains explanation for what error occured.

Returns:

Returns if the detection job could not be completed. Contains explanation for what error occured.

detectDocumentTextModelVersion

public final String detectDocumentTextModelVersion()

Returns:

toBuilder

public GetDocumentTextDetectionResponse.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<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetDocumentTextDetectionResponse.Builder builder()

serializableBuilderClass

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