Interface Table.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Table.Builder,
,Table> SdkBuilder<Table.Builder,
,Table> SdkPojo
- Enclosing class:
Table
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the Data Catalog in which the table resides.The person or entity who created the table.createTime
(Instant createTime) The time when the table definition was created in the Data Catalog.databaseName
(String databaseName) The name of the database where the table metadata resides.description
(String description) A description of the table.default Table.Builder
federatedTable
(Consumer<FederatedTable.Builder> federatedTable) AFederatedTable
structure that references an entity outside the Glue Data Catalog.federatedTable
(FederatedTable federatedTable) AFederatedTable
structure that references an entity outside the Glue Data Catalog.isMultiDialectView
(Boolean isMultiDialectView) Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.isRegisteredWithLakeFormation
(Boolean isRegisteredWithLakeFormation) Indicates whether the table has been registered with Lake Formation.lastAccessTime
(Instant lastAccessTime) The last time that the table was accessed.lastAnalyzedTime
(Instant lastAnalyzedTime) The last time that column statistics were computed for this table.The table name.The owner of the table.parameters
(Map<String, String> parameters) These key-value pairs define properties associated with the table.partitionKeys
(Collection<Column> partitionKeys) A list of columns by which the table is partitioned.partitionKeys
(Consumer<Column.Builder>... partitionKeys) A list of columns by which the table is partitioned.partitionKeys
(Column... partitionKeys) A list of columns by which the table is partitioned.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.storageDescriptor
(StorageDescriptor storageDescriptor) A storage descriptor containing information about the physical storage of this table.The type of this table.default Table.Builder
targetTable
(Consumer<TableIdentifier.Builder> targetTable) ATableIdentifier
structure that describes a target table for resource linking.targetTable
(TableIdentifier targetTable) ATableIdentifier
structure that describes a target table for resource linking.updateTime
(Instant updateTime) The last time that the table was updated.The ID of the table version.default Table.Builder
viewDefinition
(Consumer<ViewDefinition.Builder> viewDefinition) A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.viewDefinition
(ViewDefinition viewDefinition) A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.viewExpandedText
(String viewExpandedText) Included for Apache Hive compatibility.viewOriginalText
(String viewOriginalText) Included for Apache Hive compatibility.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
A storage descriptor containing information about the physical storage of this table.
This is a convenience method that creates an instance of theStorageDescriptor.Builder
avoiding the need to create one manually viaStorageDescriptor.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostorageDescriptor(StorageDescriptor)
.- Parameters:
storageDescriptor
- a consumer that will call methods onStorageDescriptor.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 ofpartitionKeys
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 ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofpartitionKeys
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 ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Column.Builder
avoiding the need to create one manually viaColumn.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topartitionKeys(List<Column>)
.- Parameters:
partitionKeys
- a consumer that will call methods onColumn.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 aVIRTUAL_VIEW
, certain Athena configuration encoded in base64.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 theEXTERNAL_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
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
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
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
A
TableIdentifier
structure that describes a target table for resource linking.- Parameters:
targetTable
- ATableIdentifier
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
A
This is a convenience method that creates an instance of theTableIdentifier
structure that describes a target table for resource linking.TableIdentifier.Builder
avoiding the need to create one manually viaTableIdentifier.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetTable(TableIdentifier)
.- Parameters:
targetTable
- a consumer that will call methods onTableIdentifier.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
A
FederatedTable
structure that references an entity outside the Glue Data Catalog.- Parameters:
federatedTable
- AFederatedTable
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
A
This is a convenience method that creates an instance of theFederatedTable
structure that references an entity outside the Glue Data Catalog.FederatedTable.Builder
avoiding the need to create one manually viaFederatedTable.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofederatedTable(FederatedTable)
.- Parameters:
federatedTable
- a consumer that will call methods onFederatedTable.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
viewDefinition
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
- Parameters:
viewDefinition
- A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
viewDefinition
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
This is a convenience method that creates an instance of theViewDefinition.Builder
avoiding the need to create one manually viaViewDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toviewDefinition(ViewDefinition)
.- Parameters:
viewDefinition
- a consumer that will call methods onViewDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isMultiDialectView
Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
- Parameters:
isMultiDialectView
- Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-