com.amazonaws.services.comprehend.model

Class DocumentClass

java.lang.Object

com.amazonaws.services.comprehend.model.DocumentClass

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the class that categorizes the document being analyzed

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentClass()

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentClass

public DocumentClass()

Method Detail

setName

public void setName(String name)

The name of the class.

Parameters:

name - The name of the class.

getName

public String getName()

The name of the class.

Returns:

The name of the class.

withName

public DocumentClass withName(String name)

The name of the class.

Parameters:

name - The name of the class.

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 class correctly attributed.

Parameters:

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

getScore

public Float getScore()

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

Returns:

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

withScore

public DocumentClass withScore(Float score)

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

Parameters:

score - The confidence score that Amazon Comprehend has this class 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 in the input document. This field is present in the response only if your request includes the Byte parameter.

Parameters:

page - Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

getPage

public Integer getPage()

Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

Returns:

Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

withPage

public DocumentClass withPage(Integer page)

Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

Parameters:

page - Page number in the input document. 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 DocumentClass 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.