com.amazonaws.services.comprehend.model

Class DocumentClassificationConfig

java.lang.Object

com.amazonaws.services.comprehend.model.DocumentClassificationConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Configuration required for a document classification model.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentClassificationConfig()

Method Summary

Modifier and Type	Method and Description
DocumentClassificationConfig	clone()
boolean	equals(Object obj)
List<String>	getLabels() One or more labels to associate with the custom classifier.
String	getMode() Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setLabels(Collection<String> labels) One or more labels to associate with the custom classifier.
void	setMode(String mode) Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
String	toString() Returns a string representation of this object.
DocumentClassificationConfig	withLabels(Collection<String> labels) One or more labels to associate with the custom classifier.
DocumentClassificationConfig	withLabels(String... labels) One or more labels to associate with the custom classifier.
DocumentClassificationConfig	withMode(DocumentClassifierMode mode) Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
DocumentClassificationConfig	withMode(String mode) Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentClassificationConfig

public DocumentClassificationConfig()

Method Detail

setMode

public void setMode(String mode)

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Parameters:

mode - Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

See Also:

DocumentClassifierMode

getMode

public String getMode()

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Returns:

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

See Also:

DocumentClassifierMode

withMode

public DocumentClassificationConfig withMode(String mode)

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Parameters:

mode - Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Returns:

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

See Also:

DocumentClassifierMode

withMode

public DocumentClassificationConfig withMode(DocumentClassifierMode mode)

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Parameters:

mode - Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

Returns:

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

See Also:

DocumentClassifierMode

getLabels

public List<String> getLabels()

One or more labels to associate with the custom classifier.

Returns:

One or more labels to associate with the custom classifier.

setLabels

public void setLabels(Collection<String> labels)

One or more labels to associate with the custom classifier.

Parameters:

labels - One or more labels to associate with the custom classifier.

withLabels

public DocumentClassificationConfig withLabels(String... labels)

One or more labels to associate with the custom classifier.

NOTE: This method appends the values to the existing list (if any). Use setLabels(java.util.Collection) or withLabels(java.util.Collection) if you want to override the existing values.

Parameters:

labels - One or more labels to associate with the custom classifier.

Returns:

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

withLabels

public DocumentClassificationConfig withLabels(Collection<String> labels)

One or more labels to associate with the custom classifier.

Parameters:

labels - One or more labels to associate with the custom classifier.

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 DocumentClassificationConfig 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.