@Generated(value="software.amazon.awssdk:codegen") public final class GetDocumentTextDetectionResponse extends TextractResponse implements ToCopyableBuilder<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
GetDocumentTextDetectionResponse.Builder |
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()
Returns true if the Blocks property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasWarnings()
Returns true if the Warnings property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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.
|
responseMetadata
sdkHttpResponse
copy
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.
DocumentMetadata
is returned in
every page of paginated responses from an Amazon Textract video operation.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()
.
JobStatus
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()
.
JobStatus
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.
public final boolean hasBlocks()
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.
You can use hasBlocks()
to see if a value was sent in this field.
public final boolean hasWarnings()
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.
You can use hasWarnings()
to see if a value was sent in this field.
public final String statusMessage()
Returns if the detection job could not be completed. Contains explanation for what error occured.
public final String detectDocumentTextModelVersion()
public GetDocumentTextDetectionResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>
toBuilder
in class AwsResponse
public static GetDocumentTextDetectionResponse.Builder builder()
public static Class<? extends GetDocumentTextDetectionResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.