software.amazon.awssdk.services.databasemigration.model

Class S3Settings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.S3Settings

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<S3Settings.Builder,S3Settings>

@Generated(value="software.amazon.awssdk:codegen")
public class S3Settings
extends Object
implements StructuredPojo, ToCopyableBuilder<S3Settings.Builder,S3Settings>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3Settings.Builder

Method Summary

Modifier and Type	Method and Description
String	bucketFolder() An optional parameter to set a folder name in the S3 bucket.
String	bucketName() The name of the S3 bucket.
static S3Settings.Builder	builder()
CompressionTypeValue	compressionType() An optional parameter to use GZIP to compress the target files.
String	compressionTypeAsString() An optional parameter to use GZIP to compress the target files.
String	csvDelimiter() The delimiter used to separate columns in the source files.
String	csvRowDelimiter() The delimiter used to separate rows in the source files.
boolean	equals(Object obj)
String	externalTableDefinition()
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends S3Settings.Builder>	serializableBuilderClass()
String	serviceAccessRoleArn() The Amazon Resource Name (ARN) used by the service access IAM role.
S3Settings.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

serviceAccessRoleArn

public String serviceAccessRoleArn()

The Amazon Resource Name (ARN) used by the service access IAM role.

Returns:

The Amazon Resource Name (ARN) used by the service access IAM role.

externalTableDefinition

public String externalTableDefinition()

Returns:

csvRowDelimiter

public String csvRowDelimiter()

The delimiter used to separate rows in the source files. The default is a carriage return (\n).

Returns:

The delimiter used to separate rows in the source files. The default is a carriage return (\n).

csvDelimiter

public String csvDelimiter()

The delimiter used to separate columns in the source files. The default is a comma.

Returns:

The delimiter used to separate columns in the source files. The default is a comma.

bucketFolder

public String bucketFolder()

An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.

Returns:

An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.

bucketName

public String bucketName()

The name of the S3 bucket.

Returns:

The name of the S3 bucket.

compressionType

public CompressionTypeValue compressionType()

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

If the service returns an enum value that is not available in the current SDK version, compressionType will return CompressionTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().

Returns:

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

See Also:

CompressionTypeValue

compressionTypeAsString

public String compressionTypeAsString()

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

If the service returns an enum value that is not available in the current SDK version, compressionType will return CompressionTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().

Returns:

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

See Also:

CompressionTypeValue

toBuilder

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

Returns:

a builder for type T

builder

public static S3Settings.Builder builder()

serializableBuilderClass

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

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.