Package software.amazon.awssdk.services.comprehend.model

Class DocumentClassifierOutputDataConfig

java.lang.Object

software.amazon.awssdk.services.comprehend.model.DocumentClassifierOutputDataConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentClassifierOutputDataConfig.Builder,DocumentClassifierOutputDataConfig>

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

Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentClassifierOutputDataConfig.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentClassifierOutputDataConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flywheelStatsS3Prefix()	The Amazon S3 prefix for the data lake location of the flywheel statistics.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId()	ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
String	s3Uri()	When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentClassifierOutputDataConfig.Builder>	serializableBuilderClass()
DocumentClassifierOutputDataConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

s3Uri

public final String s3Uri()

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

Returns:

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

kmsKeyId

public final String kmsKeyId()

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

Returns:

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

flywheelStatsS3Prefix

public final String flywheelStatsS3Prefix()

The Amazon S3 prefix for the data lake location of the flywheel statistics.

Returns:

The Amazon S3 prefix for the data lake location of the flywheel statistics.

toBuilder

public DocumentClassifierOutputDataConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentClassifierOutputDataConfig.Builder,DocumentClassifierOutputDataConfig>

builder

public static DocumentClassifierOutputDataConfig.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentClassifierOutputDataConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo