DocumentClassifierProperties (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.comprehend.model.DocumentClassifierProperties

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentClassifierProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>

Provides information about a document classifier.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DocumentClassifierProperties.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DocumentClassifierProperties.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentClassifierProperties.Builder`	`builder()`
`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.
`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.
`String`	`documentClassifierArn()` The Amazon Resource Name (ARN) that identifies the document classifier.
`Instant`	`endTime()` The time that training the document classifier completed.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`DocumentClassifierInputDataConfig`	`inputDataConfig()` The input data configuration that you supplied when you created the document classifier for training.
`LanguageCode`	`languageCode()` The language code for the language of the documents that the classifier was trained on.
`String`	`languageCodeAsString()` The language code for the language of the documents that the classifier was trained on.
`String`	`message()` Additional information about the status of the classifier.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentClassifierProperties.Builder>`	`serializableBuilderClass()`
`ModelStatus`	`status()` The status of the document classifier.
`String`	`statusAsString()` The status of the document classifier.
`Instant`	`submitTime()` The time that the document classifier was submitted for training.
`DocumentClassifierProperties.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Instant`	`trainingEndTime()` The time that training of the document classifier was completed.
`Instant`	`trainingStartTime()` Indicates the time when the training starts on documentation classifiers.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - documentClassifierArn
```
public String documentClassifierArn()
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - languageCode
```
public LanguageCode languageCode()
```
    The language code for the language of the documents that the classifier was trained on.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public String languageCodeAsString()
```
    The language code for the language of the documents that the classifier was trained on.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - status
```
public ModelStatus status()
```
    The status of the document classifier. The 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the document classifier. The 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
  - statusAsString
```
public String statusAsString()
```
    The status of the document classifier. The 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the document classifier. The 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
  - message
```
public String message()
```
    Additional information about the status of the classifier.
    
    Returns:
    
    Additional information about the status of the classifier.
  - submitTime
```
public Instant submitTime()
```
    The time that the document classifier was submitted for training.
    
    Returns:
    
    The time that the document classifier was submitted for training.
  - endTime
```
public Instant endTime()
```
    The time that training the document classifier completed.
    
    Returns:
    
    The time that training the document classifier completed.
  - trainingStartTime
```
public Instant 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:
    
    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.
  - trainingEndTime
```
public Instant 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:
    
    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.
  - inputDataConfig
```
public DocumentClassifierInputDataConfig inputDataConfig()
```
    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.
  - classifierMetadata
```
public 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.
    
    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.
  - dataAccessRoleArn
```
public 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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - toBuilder
```
public DocumentClassifierProperties.Builder 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 interface ToCopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DocumentClassifierProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentClassifierProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DocumentClassifierProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

documentClassifierArn

languageCode

languageCodeAsString

status

statusAsString

message

submitTime

endTime

trainingStartTime

trainingEndTime

inputDataConfig

classifierMetadata

dataAccessRoleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields