software.amazon.awssdk.services.glue.model

Interface Table.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Table.Builder,Table>, SdkBuilder<Table.Builder,Table>, SdkPojo

Enclosing class:

Table

public static interface Table.Builder
extends SdkPojo, CopyableBuilder<Table.Builder,Table>

Method Summary

Modifier and Type	Method and Description
Table.Builder	catalogId(String catalogId) The ID of the Data Catalog in which the table resides.
Table.Builder	createdBy(String createdBy) The person or entity who created the table.
Table.Builder	createTime(Instant createTime) The time when the table definition was created in the Data Catalog.
Table.Builder	databaseName(String databaseName) The name of the database where the table metadata resides.
Table.Builder	description(String description) A description of the table.
default Table.Builder	federatedTable(Consumer<FederatedTable.Builder> federatedTable) A FederatedTable structure that references an entity outside the Glue Data Catalog.
Table.Builder	federatedTable(FederatedTable federatedTable) A FederatedTable structure that references an entity outside the Glue Data Catalog.
Table.Builder	isRegisteredWithLakeFormation(Boolean isRegisteredWithLakeFormation) Indicates whether the table has been registered with Lake Formation.
Table.Builder	lastAccessTime(Instant lastAccessTime) The last time that the table was accessed.
Table.Builder	lastAnalyzedTime(Instant lastAnalyzedTime) The last time that column statistics were computed for this table.
Table.Builder	name(String name) The table name.
Table.Builder	owner(String owner) The owner of the table.
Table.Builder	parameters(Map<String,String> parameters) These key-value pairs define properties associated with the table.
Table.Builder	partitionKeys(Collection<Column> partitionKeys) A list of columns by which the table is partitioned.
Table.Builder	partitionKeys(Column... partitionKeys) A list of columns by which the table is partitioned.
Table.Builder	partitionKeys(Consumer<Column.Builder>... partitionKeys) A list of columns by which the table is partitioned.
Table.Builder	retention(Integer retention) The retention time for this table.
default Table.Builder	storageDescriptor(Consumer<StorageDescriptor.Builder> storageDescriptor) A storage descriptor containing information about the physical storage of this table.
Table.Builder	storageDescriptor(StorageDescriptor storageDescriptor) A storage descriptor containing information about the physical storage of this table.
Table.Builder	tableType(String tableType) The type of this table.
default Table.Builder	targetTable(Consumer<TableIdentifier.Builder> targetTable) A TableIdentifier structure that describes a target table for resource linking.
Table.Builder	targetTable(TableIdentifier targetTable) A TableIdentifier structure that describes a target table for resource linking.
Table.Builder	updateTime(Instant updateTime) The last time that the table was updated.
Table.Builder	versionId(String versionId) The ID of the table version.
Table.Builder	viewExpandedText(String viewExpandedText) Included for Apache Hive compatibility.
Table.Builder	viewOriginalText(String viewOriginalText) Included for Apache Hive compatibility.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

Table.Builder name(String name)

The table name. For Hive compatibility, this must be entirely lowercase.

Parameters:

name - The table name. For Hive compatibility, this must be entirely lowercase.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseName

Table.Builder databaseName(String databaseName)

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

Parameters:

databaseName - The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

Table.Builder description(String description)

A description of the table.

Parameters:

description - A description of the table.

Returns:

Returns a reference to this object so that method calls can be chained together.

owner

Table.Builder owner(String owner)

The owner of the table.

Parameters:

owner - The owner of the table.

Returns:

Returns a reference to this object so that method calls can be chained together.

createTime

Table.Builder createTime(Instant createTime)

The time when the table definition was created in the Data Catalog.

Parameters:

createTime - The time when the table definition was created in the Data Catalog.

Returns:

Returns a reference to this object so that method calls can be chained together.

updateTime

Table.Builder updateTime(Instant updateTime)

The last time that the table was updated.

Parameters:

updateTime - The last time that the table was updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastAccessTime

Table.Builder lastAccessTime(Instant lastAccessTime)

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

Parameters:

lastAccessTime - The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastAnalyzedTime

Table.Builder lastAnalyzedTime(Instant lastAnalyzedTime)

The last time that column statistics were computed for this table.

Parameters:

lastAnalyzedTime - The last time that column statistics were computed for this table.

Returns:

Returns a reference to this object so that method calls can be chained together.

retention

Table.Builder retention(Integer retention)

The retention time for this table.

Parameters:

retention - The retention time for this table.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageDescriptor

Table.Builder storageDescriptor(StorageDescriptor storageDescriptor)

A storage descriptor containing information about the physical storage of this table.

Parameters:

storageDescriptor - A storage descriptor containing information about the physical storage of this table.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageDescriptor

default Table.Builder storageDescriptor(Consumer<StorageDescriptor.Builder> storageDescriptor)

A storage descriptor containing information about the physical storage of this table.

This is a convenience method that creates an instance of the StorageDescriptor.Builder avoiding the need to create one manually via StorageDescriptor.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageDescriptor(StorageDescriptor).

Parameters:

storageDescriptor - a consumer that will call methods on StorageDescriptor.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

storageDescriptor(StorageDescriptor)

partitionKeys

Table.Builder partitionKeys(Collection<Column> partitionKeys)

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

Parameters:

partitionKeys - A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

Returns:

Returns a reference to this object so that method calls can be chained together.

partitionKeys

Table.Builder partitionKeys(Column... partitionKeys)

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

Parameters:

partitionKeys - A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

Returns:

Returns a reference to this object so that method calls can be chained together.

partitionKeys

Table.Builder partitionKeys(Consumer<Column.Builder>... partitionKeys)

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

This is a convenience method that creates an instance of the Column.Builder avoiding the need to create one manually via Column.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #partitionKeys(List).

Parameters:

partitionKeys - a consumer that will call methods on Column.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#partitionKeys(java.util.Collection)

viewOriginalText

Table.Builder viewOriginalText(String viewOriginalText)

Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

Parameters:

viewOriginalText - Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

Returns:

Returns a reference to this object so that method calls can be chained together.

viewExpandedText

Table.Builder viewExpandedText(String viewExpandedText)

Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

Parameters:

viewExpandedText - Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

tableType

Table.Builder tableType(String tableType)

The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

Parameters:

tableType - The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

Table.Builder parameters(Map<String,String> parameters)

These key-value pairs define properties associated with the table.

Parameters:

parameters - These key-value pairs define properties associated with the table.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

Table.Builder createdBy(String createdBy)

The person or entity who created the table.

Parameters:

createdBy - The person or entity who created the table.

Returns:

Returns a reference to this object so that method calls can be chained together.

isRegisteredWithLakeFormation

Table.Builder isRegisteredWithLakeFormation(Boolean isRegisteredWithLakeFormation)

Indicates whether the table has been registered with Lake Formation.

Parameters:

isRegisteredWithLakeFormation - Indicates whether the table has been registered with Lake Formation.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetTable

Table.Builder targetTable(TableIdentifier targetTable)

A TableIdentifier structure that describes a target table for resource linking.

Parameters:

targetTable - A TableIdentifier structure that describes a target table for resource linking.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetTable

default Table.Builder targetTable(Consumer<TableIdentifier.Builder> targetTable)

A TableIdentifier structure that describes a target table for resource linking.

This is a convenience method that creates an instance of the TableIdentifier.Builder avoiding the need to create one manually via TableIdentifier.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetTable(TableIdentifier).

Parameters:

targetTable - a consumer that will call methods on TableIdentifier.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

targetTable(TableIdentifier)

catalogId

Table.Builder catalogId(String catalogId)

The ID of the Data Catalog in which the table resides.

Parameters:

catalogId - The ID of the Data Catalog in which the table resides.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionId

Table.Builder versionId(String versionId)

The ID of the table version.

Parameters:

versionId - The ID of the table version.

Returns:

Returns a reference to this object so that method calls can be chained together.

federatedTable

Table.Builder federatedTable(FederatedTable federatedTable)

A FederatedTable structure that references an entity outside the Glue Data Catalog.

Parameters:

federatedTable - A FederatedTable structure that references an entity outside the Glue Data Catalog.

Returns:

Returns a reference to this object so that method calls can be chained together.

federatedTable

default Table.Builder federatedTable(Consumer<FederatedTable.Builder> federatedTable)

A FederatedTable structure that references an entity outside the Glue Data Catalog.

This is a convenience method that creates an instance of the FederatedTable.Builder avoiding the need to create one manually via FederatedTable.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to federatedTable(FederatedTable).

Parameters:

federatedTable - a consumer that will call methods on FederatedTable.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

federatedTable(FederatedTable)