Package software.amazon.awscdk.services.glue.alpha

Class S3TableProps.Builder

java.lang.Object

software.amazon.awscdk.services.glue.alpha.S3TableProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3TableProps>

Enclosing interface:

S3TableProps

@Stability(Experimental)
public static final class S3TableProps.Builder
extends Object
implements software.amazon.jsii.Builder<S3TableProps>

A builder for S3TableProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3TableProps.Builder	bucket(IBucket bucket)	Sets the value of S3TableProps.getBucket()
S3TableProps	build()	Builds the configured instance.
S3TableProps.Builder	columns(List<? extends Column> columns)	Sets the value of TableBaseProps.getColumns()
S3TableProps.Builder	compressed(Boolean compressed)	Sets the value of TableBaseProps.getCompressed()
S3TableProps.Builder	database(IDatabase database)	Sets the value of TableBaseProps.getDatabase()
S3TableProps.Builder	dataFormat(DataFormat dataFormat)	Sets the value of TableBaseProps.getDataFormat()
S3TableProps.Builder	description(String description)	Sets the value of TableBaseProps.getDescription()
S3TableProps.Builder	enablePartitionFiltering(Boolean enablePartitionFiltering)	Sets the value of TableBaseProps.getEnablePartitionFiltering()
S3TableProps.Builder	encryption(TableEncryption encryption)	Sets the value of S3TableProps.getEncryption()
S3TableProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of S3TableProps.getEncryptionKey()
S3TableProps.Builder	parameters(Map<String,String> parameters)	Sets the value of TableBaseProps.getParameters()
S3TableProps.Builder	partitionIndexes(List<? extends PartitionIndex> partitionIndexes)	Sets the value of TableBaseProps.getPartitionIndexes()
S3TableProps.Builder	partitionKeys(List<? extends Column> partitionKeys)	Sets the value of TableBaseProps.getPartitionKeys()
S3TableProps.Builder	s3Prefix(String s3Prefix)	Sets the value of S3TableProps.getS3Prefix()
S3TableProps.Builder	storageParameters(List<? extends StorageParameter> storageParameters)	Sets the value of TableBaseProps.getStorageParameters()
S3TableProps.Builder	storedAsSubDirectories(Boolean storedAsSubDirectories)	Sets the value of TableBaseProps.getStoredAsSubDirectories()
S3TableProps.Builder	tableName(String tableName)	Sets the value of TableBaseProps.getTableName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

bucket

@Stability(Experimental)
public S3TableProps.Builder bucket(IBucket bucket)

Sets the value of S3TableProps.getBucket()

Parameters:

bucket - S3 bucket in which to store data.

Returns:

this

encryption

@Stability(Experimental)
public S3TableProps.Builder encryption(TableEncryption encryption)

Sets the value of S3TableProps.getEncryption()

Parameters:

encryption - The kind of encryption to secure the data with. You can only provide this option if you are not explicitly passing in a bucket.

If you choose SSE-KMS, you can provide an un-managed KMS key with encryptionKey. If you choose CSE-KMS, you must provide an un-managed KMS key with encryptionKey.

Returns:

this

encryptionKey

@Stability(Experimental)
public S3TableProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of S3TableProps.getEncryptionKey()

Parameters:

encryptionKey - External KMS key to use for bucket encryption. The encryption property must be SSE-KMS or CSE-KMS.

Returns:

this

s3Prefix

@Stability(Experimental)
public S3TableProps.Builder s3Prefix(String s3Prefix)

Sets the value of S3TableProps.getS3Prefix()

Parameters:

s3Prefix - S3 prefix under which table objects are stored.

Returns:

this

columns

@Stability(Experimental)
public S3TableProps.Builder columns(List<? extends Column> columns)

Sets the value of TableBaseProps.getColumns()

Parameters:

columns - Columns of the table. This parameter is required.

Returns:

this

database

@Stability(Experimental)
public S3TableProps.Builder database(IDatabase database)

Sets the value of TableBaseProps.getDatabase()

Parameters:

database - Database in which to store the table. This parameter is required.

Returns:

this

dataFormat

@Stability(Experimental)
public S3TableProps.Builder dataFormat(DataFormat dataFormat)

Sets the value of TableBaseProps.getDataFormat()

Parameters:

dataFormat - Storage type of the table's data. This parameter is required.

Returns:

this

compressed

@Stability(Experimental)
public S3TableProps.Builder compressed(Boolean compressed)

Sets the value of TableBaseProps.getCompressed()

Parameters:

compressed - Indicates whether the table's data is compressed or not.

Returns:

this

description

@Stability(Experimental)
public S3TableProps.Builder description(String description)

Sets the value of TableBaseProps.getDescription()

Parameters:

description - Description of the table.

Returns:

this

enablePartitionFiltering

@Stability(Experimental)
public S3TableProps.Builder enablePartitionFiltering(Boolean enablePartitionFiltering)

Sets the value of TableBaseProps.getEnablePartitionFiltering()

Parameters:

enablePartitionFiltering - Enables partition filtering.

Returns:

this

parameters

@Stability(Experimental)
public S3TableProps.Builder parameters(Map<String,String> parameters)

Sets the value of TableBaseProps.getParameters()

Parameters:

parameters - The key/value pairs define properties associated with the table. The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

Returns:

this

partitionIndexes

@Stability(Experimental)
public S3TableProps.Builder partitionIndexes(List<? extends PartitionIndex> partitionIndexes)

Sets the value of TableBaseProps.getPartitionIndexes()

Parameters:

partitionIndexes - Partition indexes on the table. A maximum of 3 indexes are allowed on a table. Keys in the index must be part of the table's partition keys.

Returns:

this

partitionKeys

@Stability(Experimental)
public S3TableProps.Builder partitionKeys(List<? extends Column> partitionKeys)

Sets the value of TableBaseProps.getPartitionKeys()

Parameters:

partitionKeys - Partition columns of the table.

Returns:

this

storageParameters

@Stability(Experimental)
public S3TableProps.Builder storageParameters(List<? extends StorageParameter> storageParameters)

Sets the value of TableBaseProps.getStorageParameters()

Parameters:

storageParameters - The user-supplied properties for the description of the physical storage of this table. These properties help describe the format of the data that is stored within the crawled data sources.

The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.

Some keys will be auto-populated by glue crawlers, however, you can override them by specifying the key and value in this property.

Returns:

this

storedAsSubDirectories

@Stability(Experimental)
public S3TableProps.Builder storedAsSubDirectories(Boolean storedAsSubDirectories)

Sets the value of TableBaseProps.getStoredAsSubDirectories()

Parameters:

storedAsSubDirectories - Indicates whether the table data is stored in subdirectories.

Returns:

this

tableName

@Stability(Experimental)
public S3TableProps.Builder tableName(String tableName)

Sets the value of TableBaseProps.getTableName()

Parameters:

tableName - Name of the table.

Returns:

this

build

@Stability(Experimental)
public S3TableProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<S3TableProps>

Returns:

a new instance of S3TableProps

Throws:

NullPointerException - if any required attribute was not provided