com.amazonaws.services.comprehend.model

Class DocumentLabel

java.lang.Object

com.amazonaws.services.comprehend.model.DocumentLabel

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentLabel
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentLabel()

Method Summary

Modifier and Type	Method and Description
DocumentLabel	clone()
boolean	equals(Object obj)
String	getName() The name of the label.
Integer	getPage() Page number where the label occurs.
Float	getScore() The confidence score that Amazon Comprehend has this label correctly attributed.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setName(String name) The name of the label.
void	setPage(Integer page) Page number where the label occurs.
void	setScore(Float score) The confidence score that Amazon Comprehend has this label correctly attributed.
String	toString() Returns a string representation of this object.
DocumentLabel	withName(String name) The name of the label.
DocumentLabel	withPage(Integer page) Page number where the label occurs.
DocumentLabel	withScore(Float score) The confidence score that Amazon Comprehend has this label correctly attributed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentLabel

public DocumentLabel()

Method Detail

setName

public void setName(String name)

The name of the label.

Parameters:

name - The name of the label.

getName

public String getName()

The name of the label.

Returns:

The name of the label.

withName

public DocumentLabel withName(String name)

The name of the label.

Parameters:

name - The name of the label.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScore

public void setScore(Float score)

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

Parameters:

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

getScore

public Float getScore()

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

Returns:

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

withScore

public DocumentLabel withScore(Float score)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPage

public void setPage(Integer page)

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

Parameters:

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

getPage

public Integer getPage()

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.

withPage

public DocumentLabel withPage(Integer page)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DocumentLabel clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.