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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClasses() Returns true if the Classes 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	hasLabels() Returns true if the Labels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.

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

Returns true if the Classes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasClasses() to see if a value was sent in this field.

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

Returns true if the Labels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasLabels() to see if a value was sent in this field.

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.

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