Package software.amazon.awssdk.services.comprehend.model

Class DocumentLabel

java.lang.Object

software.amazon.awssdk.services.comprehend.model.DocumentLabel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentLabel.Builder,DocumentLabel>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentLabel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentLabel.Builder,DocumentLabel>

Specifies one of the label or labels that categorize the document being analyzed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentLabel.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentLabel.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the label.
Integer	page()	Page number where the label occurs.
Float	score()	The confidence score that Amazon Comprehend has this label correctly attributed.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentLabel.Builder>	serializableBuilderClass()
DocumentLabel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final String name()

The name of the label.

Returns:

The name of the label.

score

public final Float score()

The confidence score that Amazon Comprehend has this label correctly attributed.

Returns:

The confidence score that Amazon Comprehend has this label correctly attributed.

page

public final Integer page()

Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

Returns:

Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

toBuilder

public DocumentLabel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentLabel.Builder,DocumentLabel>

builder

public static DocumentLabel.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentLabel.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo