Class Table
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.Table
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Table.Builder,Table>
@Generated("software.amazon.awssdk:codegen") public final class Table extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Table.Builder,Table>
Represents a collection of related data organized in columns and rows.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceTable.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Table.Builderbuilder()StringcatalogId()The ID of the Data Catalog in which the table resides.StringcreatedBy()The person or entity who created the table.InstantcreateTime()The time when the table definition was created in the Data Catalog.StringdatabaseName()The name of the database where the table metadata resides.Stringdescription()A description of the table.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FederatedTablefederatedTable()AFederatedTablestructure that references an entity outside the Glue Data Catalog.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasParameters()For responses, this returns true if the service returned a value for the Parameters property.booleanhasPartitionKeys()For responses, this returns true if the service returned a value for the PartitionKeys property.BooleanisMultiDialectView()Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.BooleanisRegisteredWithLakeFormation()Indicates whether the table has been registered with Lake Formation.InstantlastAccessTime()The last time that the table was accessed.InstantlastAnalyzedTime()The last time that column statistics were computed for this table.Stringname()The table name.Stringowner()The owner of the table.Map<String,String>parameters()These key-value pairs define properties associated with the table.List<Column>partitionKeys()A list of columns by which the table is partitioned.Integerretention()The retention time for this table.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Table.Builder>serializableBuilderClass()TableStatusstatus()Returns the value of the Status property for this object.StorageDescriptorstorageDescriptor()A storage descriptor containing information about the physical storage of this table.StringtableType()The type of this table.TableIdentifiertargetTable()ATableIdentifierstructure that describes a target table for resource linking.Table.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdateTime()The last time that the table was updated.StringversionId()The ID of the table version.ViewDefinitionviewDefinition()A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.StringviewExpandedText()Included for Apache Hive compatibility.StringviewOriginalText()Included for Apache Hive compatibility.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The table name. For Hive compatibility, this must be entirely lowercase.
- Returns:
- The table name. For Hive compatibility, this must be entirely lowercase.
-
databaseName
public final String databaseName()
The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
- Returns:
- The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
-
description
public final String description()
A description of the table.
- Returns:
- A description of the table.
-
owner
public final String owner()
The owner of the table.
- Returns:
- The owner of the table.
-
createTime
public final Instant createTime()
The time when the table definition was created in the Data Catalog.
- Returns:
- The time when the table definition was created in the Data Catalog.
-
updateTime
public final Instant updateTime()
The last time that the table was updated.
- Returns:
- The last time that the table was updated.
-
lastAccessTime
public final Instant lastAccessTime()
The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
- Returns:
- The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
-
lastAnalyzedTime
public final Instant lastAnalyzedTime()
The last time that column statistics were computed for this table.
- Returns:
- The last time that column statistics were computed for this table.
-
retention
public final Integer retention()
The retention time for this table.
- Returns:
- The retention time for this table.
-
storageDescriptor
public final StorageDescriptor storageDescriptor()
A storage descriptor containing information about the physical storage of this table.
- Returns:
- A storage descriptor containing information about the physical storage of this table.
-
hasPartitionKeys
public final boolean hasPartitionKeys()
For responses, this returns true if the service returned a value for the PartitionKeys property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
partitionKeys
public final List<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 ofpartitionKeysto an empty list. For example:"PartitionKeys": []Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPartitionKeys()method.- Returns:
- 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 ofpartitionKeysto an empty list. For example:"PartitionKeys": []
-
viewOriginalText
public final 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.- Returns:
- 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.
-
viewExpandedText
public final String viewExpandedText()
Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
- Returns:
- Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
-
tableType
public final String tableType()
The type of this table. Glue will create tables with the
EXTERNAL_TABLEtype. 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:
- The type of this table. Glue will create tables with the
EXTERNAL_TABLEtype. 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.
-
hasParameters
public final boolean hasParameters()
For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
parameters
public final Map<String,String> parameters()
These key-value pairs define properties associated with the table.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasParameters()method.- Returns:
- These key-value pairs define properties associated with the table.
-
createdBy
public final String createdBy()
The person or entity who created the table.
- Returns:
- The person or entity who created the table.
-
isRegisteredWithLakeFormation
public final Boolean isRegisteredWithLakeFormation()
Indicates whether the table has been registered with Lake Formation.
- Returns:
- Indicates whether the table has been registered with Lake Formation.
-
targetTable
public final TableIdentifier targetTable()
A
TableIdentifierstructure that describes a target table for resource linking.- Returns:
- A
TableIdentifierstructure that describes a target table for resource linking.
-
catalogId
public final String catalogId()
The ID of the Data Catalog in which the table resides.
- Returns:
- The ID of the Data Catalog in which the table resides.
-
versionId
public final String versionId()
The ID of the table version.
- Returns:
- The ID of the table version.
-
federatedTable
public final FederatedTable federatedTable()
A
FederatedTablestructure that references an entity outside the Glue Data Catalog.- Returns:
- A
FederatedTablestructure that references an entity outside the Glue Data Catalog.
-
viewDefinition
public final ViewDefinition viewDefinition()
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
- Returns:
- A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
-
isMultiDialectView
public final 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.
- Returns:
- Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
-
status
public final TableStatus status()
Returns the value of the Status property for this object.- Returns:
- The value of the Status property for this object.
-
toBuilder
public Table.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Table.Builder,Table>
-
builder
public static Table.Builder builder()
-
serializableBuilderClass
public static Class<? extends Table.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-