software.amazon.awssdk.services.comprehend.model

Class ClassifyDocumentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.comprehend.model.ComprehendResponse

software.amazon.awssdk.services.comprehend.model.ClassifyDocumentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ClassifyDocumentResponse.Builder,ClassifyDocumentResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassifyDocumentResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ClassifyDocumentResponse.Builder	builder()
List<DocumentClass>	classes() The classes used by the document being analyzed.
DocumentMetadata	documentMetadata() Extraction information about the document.
List<DocumentTypeListItem>	documentType() The document type for each page in the input document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ErrorsListItem>	errors() Page-level errors that the system detected while processing the input document.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClasses() For responses, this returns true if the service returned a value for the Classes property.
boolean	hasDocumentType() For responses, this returns true if the service returned a value for the DocumentType property.
boolean	hasErrors() For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
boolean	hasLabels() For responses, this returns true if the service returned a value for the Labels property.
boolean	hasWarnings() For responses, this returns true if the service returned a value for the Warnings property.
List<DocumentLabel>	labels() The labels used the document being analyzed.
List<SdkField<?>>	sdkFields()
static Class<? extends ClassifyDocumentResponse.Builder>	serializableBuilderClass()
ClassifyDocumentResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<WarningsListItem>	warnings() Warnings detected while processing the input document.

Methods inherited from class software.amazon.awssdk.services.comprehend.model.ComprehendResponse

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

hasClasses

public final boolean hasClasses()

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

classes

public final List<DocumentClass> classes()

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

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

Returns:

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

hasLabels

public final boolean hasLabels()

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

labels

public final List<DocumentLabel> labels()

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

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

Returns:

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

documentMetadata

public final DocumentMetadata documentMetadata()

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

Returns:

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

hasDocumentType

public final boolean hasDocumentType()

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

documentType

public final List<DocumentTypeListItem> documentType()

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

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

Returns:

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

hasErrors

public final boolean hasErrors()

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

errors

public final List<ErrorsListItem> errors()

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

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

Returns:

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

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<WarningsListItem> warnings()

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

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:

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

toBuilder

public ClassifyDocumentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClassifyDocumentResponse.Builder,ClassifyDocumentResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ClassifyDocumentResponse.Builder builder()

serializableBuilderClass

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