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

Class ExternalTableProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ExternalTableProps>

Enclosing interface:

ExternalTableProps

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

A builder for ExternalTableProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExternalTableProps	build()	Builds the configured instance.
ExternalTableProps.Builder	columns(List<? extends Column> columns)	Sets the value of TableBaseProps.getColumns()
ExternalTableProps.Builder	compressed(Boolean compressed)	Sets the value of TableBaseProps.getCompressed()
ExternalTableProps.Builder	connection(IConnection connection)	Sets the value of ExternalTableProps.getConnection()
ExternalTableProps.Builder	database(IDatabase database)	Sets the value of TableBaseProps.getDatabase()
ExternalTableProps.Builder	dataFormat(DataFormat dataFormat)	Sets the value of TableBaseProps.getDataFormat()
ExternalTableProps.Builder	description(String description)	Sets the value of TableBaseProps.getDescription()
ExternalTableProps.Builder	enablePartitionFiltering(Boolean enablePartitionFiltering)	Sets the value of TableBaseProps.getEnablePartitionFiltering()
ExternalTableProps.Builder	externalDataLocation(String externalDataLocation)	Sets the value of ExternalTableProps.getExternalDataLocation()
ExternalTableProps.Builder	parameters(Map<String,String> parameters)	Sets the value of TableBaseProps.getParameters()
ExternalTableProps.Builder	partitionIndexes(List<? extends PartitionIndex> partitionIndexes)	Sets the value of TableBaseProps.getPartitionIndexes()
ExternalTableProps.Builder	partitionKeys(List<? extends Column> partitionKeys)	Sets the value of TableBaseProps.getPartitionKeys()
ExternalTableProps.Builder	storageParameters(List<? extends StorageParameter> storageParameters)	Sets the value of TableBaseProps.getStorageParameters()
ExternalTableProps.Builder	storedAsSubDirectories(Boolean storedAsSubDirectories)	Sets the value of TableBaseProps.getStoredAsSubDirectories()
ExternalTableProps.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

connection

@Stability(Experimental)
public ExternalTableProps.Builder connection(IConnection connection)

Sets the value of ExternalTableProps.getConnection()

Parameters:

connection - The connection the table will use when performing reads and writes. This parameter is required.

Returns:

this

externalDataLocation

@Stability(Experimental)
public ExternalTableProps.Builder externalDataLocation(String externalDataLocation)

Sets the value of ExternalTableProps.getExternalDataLocation()

Parameters:

externalDataLocation - The data source location of the glue table, (e.g. default_db_public_example for Redshift). This parameter is required. If this property is set, it will override both bucket and s3Prefix.

Returns:

this

columns

@Stability(Experimental)
public ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.Builder description(String description)

Sets the value of TableBaseProps.getDescription()

Parameters:

description - Description of the table.

Returns:

this

enablePartitionFiltering

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

Sets the value of TableBaseProps.getEnablePartitionFiltering()

Parameters:

enablePartitionFiltering - Enables partition filtering.

Returns:

this

parameters

@Stability(Experimental)
public ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.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 ExternalTableProps.Builder tableName(String tableName)

Sets the value of TableBaseProps.getTableName()

Parameters:

tableName - Name of the table.

Returns:

this

build

@Stability(Experimental)
public ExternalTableProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ExternalTableProps

Throws:

NullPointerException - if any required attribute was not provided