software.amazon.awssdk.services.comprehend.model

Class OutputDataConfig

java.lang.Object

software.amazon.awssdk.services.comprehend.model.OutputDataConfig

All Implemented Interfaces:

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

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

Provides configuration parameters for the output of topic detection jobs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutputDataConfig.Builder

Method Summary

Modifier and Type	Method and Description
static OutputDataConfig.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	s3Uri() When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
List<SdkField<?>>	sdkFields()
static Class<? extends OutputDataConfig.Builder>	serializableBuilderClass()
OutputDataConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

s3Uri

public String s3Uri()

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. 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 the output file.

When the topic detection job is finished, the service creates an 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 ouput of the operation.

Returns:

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. 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 the output file.

When the topic detection job is finished, the service creates an 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 ouput of the operation.

toBuilder

public OutputDataConfig.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<OutputDataConfig.Builder,OutputDataConfig>

Returns:

a builder for type T

builder

public static OutputDataConfig.Builder builder()

serializableBuilderClass

public static Class<? extends OutputDataConfig.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.