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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentLabel.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
name()
The name of the label.final Integer
page()
Page number where the label occurs.final Float
score()
The confidence score that Amazon Comprehend has this label correctly attributed.static Class
<? extends DocumentLabel.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the label.
- Returns:
- The name of the label.
-
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
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
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 interfaceToCopyableBuilder<DocumentLabel.Builder,
DocumentLabel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-