DocumentClassifierProperties (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.DocumentClassifierProperties

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a document classifier.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentClassifierProperties()

Constructors
Constructor and Description
`DocumentClassifierProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentClassifierProperties`	`clone()`
`boolean`	`equals(Object obj)`
`ClassifierMetadata`	`getClassifierMetadata()` Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
`String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`String`	`getDocumentClassifierArn()` The Amazon Resource Name (ARN) that identifies the document classifier.
`Date`	`getEndTime()` The time that training the document classifier completed.
`DocumentClassifierInputDataConfig`	`getInputDataConfig()` The input data configuration that you supplied when you created the document classifier for training.
`String`	`getLanguageCode()` The language code for the language of the documents that the classifier was trained on.
`String`	`getMessage()` Additional information about the status of the classifier.
`String`	`getStatus()` The status of the document classifier.
`Date`	`getSubmitTime()` The time that the document classifier was submitted for training.
`Date`	`getTrainingEndTime()` The time that training of the document classifier was completed.
`Date`	`getTrainingStartTime()` Indicates the time when the training starts on documentation classifiers.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClassifierMetadata(ClassifierMetadata classifierMetadata)` Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
`void`	`setDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`void`	`setDocumentClassifierArn(String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`void`	`setEndTime(Date endTime)` The time that training the document classifier completed.
`void`	`setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the document classifier for training.
`void`	`setLanguageCode(String languageCode)` The language code for the language of the documents that the classifier was trained on.
`void`	`setMessage(String message)` Additional information about the status of the classifier.
`void`	`setStatus(String status)` The status of the document classifier.
`void`	`setSubmitTime(Date submitTime)` The time that the document classifier was submitted for training.
`void`	`setTrainingEndTime(Date trainingEndTime)` The time that training of the document classifier was completed.
`void`	`setTrainingStartTime(Date trainingStartTime)` Indicates the time when the training starts on documentation classifiers.
`String`	`toString()` Returns a string representation of this object.
`DocumentClassifierProperties`	`withClassifierMetadata(ClassifierMetadata classifierMetadata)` Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
`DocumentClassifierProperties`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`DocumentClassifierProperties`	`withDocumentClassifierArn(String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`DocumentClassifierProperties`	`withEndTime(Date endTime)` The time that training the document classifier completed.
`DocumentClassifierProperties`	`withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the document classifier for training.
`DocumentClassifierProperties`	`withLanguageCode(LanguageCode languageCode)` The language code for the language of the documents that the classifier was trained on.
`DocumentClassifierProperties`	`withLanguageCode(String languageCode)` The language code for the language of the documents that the classifier was trained on.
`DocumentClassifierProperties`	`withMessage(String message)` Additional information about the status of the classifier.
`DocumentClassifierProperties`	`withStatus(ModelStatus status)` The status of the document classifier.
`DocumentClassifierProperties`	`withStatus(String status)` The status of the document classifier.
`DocumentClassifierProperties`	`withSubmitTime(Date submitTime)` The time that the document classifier was submitted for training.
`DocumentClassifierProperties`	`withTrainingEndTime(Date trainingEndTime)` The time that training of the document classifier was completed.
`DocumentClassifierProperties`	`withTrainingStartTime(Date trainingStartTime)` Indicates the time when the training starts on documentation classifiers.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentClassifierProperties
```
public DocumentClassifierProperties()
```
- Method Detail
  - setDocumentClassifierArn
```
public void setDocumentClassifierArn(String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Parameters:
    
    documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
  - getDocumentClassifierArn
```
public String getDocumentClassifierArn()
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - withDocumentClassifierArn
```
public DocumentClassifierProperties withDocumentClassifierArn(String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Parameters:
    
    documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Parameters:
    
    languageCode - The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code for the language of the documents that the classifier was trained on.
    
    Returns:
    
    The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public DocumentClassifierProperties withLanguageCode(String languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Parameters:
    
    languageCode - The language code for the language of the documents that the classifier was trained on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public DocumentClassifierProperties withLanguageCode(LanguageCode languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Parameters:
    
    languageCode - The language code for the language of the documents that the classifier was trained on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setStatus
```
public void setStatus(String status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Parameters:
    
    status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    See Also:
    
    ModelStatus
  - getStatus
```
public String getStatus()
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns:
    
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public DocumentClassifierProperties withStatus(String status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Parameters:
    
    status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public DocumentClassifierProperties withStatus(ModelStatus status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Parameters:
    
    status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - setMessage
```
public void setMessage(String message)
```
    Additional information about the status of the classifier.
    
    Parameters:
    
    message - Additional information about the status of the classifier.
  - getMessage
```
public String getMessage()
```
    Additional information about the status of the classifier.
    
    Returns:
    
    Additional information about the status of the classifier.
  - withMessage
```
public DocumentClassifierProperties withMessage(String message)
```
    Additional information about the status of the classifier.
    
    Parameters:
    
    message - Additional information about the status of the classifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubmitTime
```
public void setSubmitTime(Date submitTime)
```
    The time that the document classifier was submitted for training.
    
    Parameters:
    
    submitTime - The time that the document classifier was submitted for training.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the document classifier was submitted for training.
    
    Returns:
    
    The time that the document classifier was submitted for training.
  - withSubmitTime
```
public DocumentClassifierProperties withSubmitTime(Date submitTime)
```
    The time that the document classifier was submitted for training.
    
    Parameters:
    
    submitTime - The time that the document classifier was submitted for training.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that training the document classifier completed.
    
    Parameters:
    
    endTime - The time that training the document classifier completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that training the document classifier completed.
    
    Returns:
    
    The time that training the document classifier completed.
  - withEndTime
```
public DocumentClassifierProperties withEndTime(Date endTime)
```
    The time that training the document classifier completed.
    
    Parameters:
    
    endTime - The time that training the document classifier completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingStartTime
```
public void setTrainingStartTime(Date trainingStartTime)
```
    Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
    
    Parameters:
    
    trainingStartTime - Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
  - getTrainingStartTime
```
public Date getTrainingStartTime()
```
    Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
    
    Returns:
    
    Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
  - withTrainingStartTime
```
public DocumentClassifierProperties withTrainingStartTime(Date trainingStartTime)
```
    Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
    
    Parameters:
    
    trainingStartTime - Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingEndTime
```
public void setTrainingEndTime(Date trainingEndTime)
```
    The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
    
    Parameters:
    
    trainingEndTime - The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
  - getTrainingEndTime
```
public Date getTrainingEndTime()
```
    The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
    
    Returns:
    
    The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
  - withTrainingEndTime
```
public DocumentClassifierProperties withTrainingEndTime(Date trainingEndTime)
```
    The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
    
    Parameters:
    
    trainingEndTime - The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputDataConfig
```
public void setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the document classifier for training.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the document classifier for training.
  - getInputDataConfig
```
public DocumentClassifierInputDataConfig getInputDataConfig()
```
    The input data configuration that you supplied when you created the document classifier for training.
    
    Returns:
    
    The input data configuration that you supplied when you created the document classifier for training.
  - withInputDataConfig
```
public DocumentClassifierProperties withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the document classifier for training.
    
    Parameters:
    
    inputDataConfig - The input data configuration that you supplied when you created the document classifier for training.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClassifierMetadata
```
public void setClassifierMetadata(ClassifierMetadata classifierMetadata)
```
    Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
    
    Parameters:
    
    classifierMetadata - Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
  - getClassifierMetadata
```
public ClassifierMetadata getClassifierMetadata()
```
    Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
    
    Returns:
    
    Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
  - withClassifierMetadata
```
public DocumentClassifierProperties withClassifierMetadata(ClassifierMetadata classifierMetadata)
```
    Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
    
    Parameters:
    
    classifierMetadata - Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public DocumentClassifierProperties withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    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 DocumentClassifierProperties 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.

Did this page help you?

Class DocumentClassifierProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentClassifierProperties

Method Detail

setDocumentClassifierArn

getDocumentClassifierArn

withDocumentClassifierArn

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setStatus

getStatus

withStatus

withStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setTrainingStartTime

getTrainingStartTime

withTrainingStartTime

setTrainingEndTime

getTrainingEndTime

withTrainingEndTime

setInputDataConfig

getInputDataConfig

withInputDataConfig

setClassifierMetadata

getClassifierMetadata

withClassifierMetadata

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

toString

equals

hashCode

clone

marshall