Class Database
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.Database
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Database.Builder,Database>
@Generated("software.amazon.awssdk:codegen") public final class Database extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Database.Builder,Database>
The
Database
object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Database.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Database.Builder
builder()
String
catalogId()
The ID of the Data Catalog in which the database resides.List<PrincipalPermissions>
createTableDefaultPermissions()
Creates a set of default permissions on the table for principals.Instant
createTime()
The time at which the metadata database was created in the catalog.String
description()
A description of the database.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
FederatedDatabase
federatedDatabase()
AFederatedDatabase
structure that references an entity outside the Glue Data Catalog.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasCreateTableDefaultPermissions()
For responses, this returns true if the service returned a value for the CreateTableDefaultPermissions property.int
hashCode()
boolean
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.String
locationUri()
The location of the database (for example, an HDFS path).String
name()
The name of the database.Map<String,String>
parameters()
These key-value pairs define parameters and properties of the database.List<SdkField<?>>
sdkFields()
static Class<? extends Database.Builder>
serializableBuilderClass()
DatabaseIdentifier
targetDatabase()
ADatabaseIdentifier
structure that describes a target database for resource linking.Database.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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 name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
- Returns:
- The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
-
description
public final String description()
A description of the database.
- Returns:
- A description of the database.
-
locationUri
public final String locationUri()
The location of the database (for example, an HDFS path).
- Returns:
- The location of the database (for example, an HDFS path).
-
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 parameters and properties of the database.
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 parameters and properties of the database.
-
createTime
public final Instant createTime()
The time at which the metadata database was created in the catalog.
- Returns:
- The time at which the metadata database was created in the catalog.
-
hasCreateTableDefaultPermissions
public final boolean hasCreateTableDefaultPermissions()
For responses, this returns true if the service returned a value for the CreateTableDefaultPermissions 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.
-
createTableDefaultPermissions
public final List<PrincipalPermissions> createTableDefaultPermissions()
Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
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
hasCreateTableDefaultPermissions()
method.- Returns:
- Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
-
targetDatabase
public final DatabaseIdentifier targetDatabase()
A
DatabaseIdentifier
structure that describes a target database for resource linking.- Returns:
- A
DatabaseIdentifier
structure that describes a target database for resource linking.
-
catalogId
public final String catalogId()
The ID of the Data Catalog in which the database resides.
- Returns:
- The ID of the Data Catalog in which the database resides.
-
federatedDatabase
public final FederatedDatabase federatedDatabase()
A
FederatedDatabase
structure that references an entity outside the Glue Data Catalog.- Returns:
- A
FederatedDatabase
structure that references an entity outside the Glue Data Catalog.
-
toBuilder
public Database.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Database.Builder,Database>
-
builder
public static Database.Builder builder()
-
serializableBuilderClass
public static Class<? extends Database.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-