@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DataCatalog extends Object implements Serializable, Cloneable, StructuredPojo
Contains information about a data catalog in an Amazon Web Services account.
In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.
Constructor and Description |
---|
DataCatalog() |
Modifier and Type | Method and Description |
---|---|
DataCatalog |
addParametersEntry(String key,
String value)
Add a single Parameters entry
|
DataCatalog |
clearParametersEntries()
Removes all the entries added into Parameters.
|
DataCatalog |
clone() |
boolean |
equals(Object obj) |
String |
getDescription()
An optional description of the data catalog.
|
String |
getName()
The name of the data catalog.
|
Map<String,String> |
getParameters()
Specifies the Lambda function or functions to use for the data catalog.
|
String |
getType()
The type of data catalog to create:
LAMBDA for a federated catalog, HIVE for an
external hive metastore, or GLUE for an Glue Data Catalog. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDescription(String description)
An optional description of the data catalog.
|
void |
setName(String name)
The name of the data catalog.
|
void |
setParameters(Map<String,String> parameters)
Specifies the Lambda function or functions to use for the data catalog.
|
void |
setType(String type)
The type of data catalog to create:
LAMBDA for a federated catalog, HIVE for an
external hive metastore, or GLUE for an Glue Data Catalog. |
String |
toString()
Returns a string representation of this object.
|
DataCatalog |
withDescription(String description)
An optional description of the data catalog.
|
DataCatalog |
withName(String name)
The name of the data catalog.
|
DataCatalog |
withParameters(Map<String,String> parameters)
Specifies the Lambda function or functions to use for the data catalog.
|
DataCatalog |
withType(DataCatalogType type)
The type of data catalog to create:
LAMBDA for a federated catalog, HIVE for an
external hive metastore, or GLUE for an Glue Data Catalog. |
DataCatalog |
withType(String type)
The type of data catalog to create:
LAMBDA for a federated catalog, HIVE for an
external hive metastore, or GLUE for an Glue Data Catalog. |
public void setName(String name)
The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
name
- The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can
use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length
constraint of 256 is reserved for use by Athena.public String getName()
The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
public DataCatalog withName(String name)
The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
name
- The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can
use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length
constraint of 256 is reserved for use by Athena.public void setDescription(String description)
An optional description of the data catalog.
description
- An optional description of the data catalog.public String getDescription()
An optional description of the data catalog.
public DataCatalog withDescription(String description)
An optional description of the data catalog.
description
- An optional description of the data catalog.public void setType(String type)
The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.
type
- The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.DataCatalogType
public String getType()
The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.
LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.DataCatalogType
public DataCatalog withType(String type)
The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.
type
- The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.DataCatalogType
public DataCatalog withType(DataCatalogType type)
The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.
type
- The type of data catalog to create: LAMBDA
for a federated catalog, HIVE
for an
external hive metastore, or GLUE
for an Glue Data Catalog.DataCatalogType
public Map<String,String> getParameters()
Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently supported
version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but not
both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The catalog_id
is
the account ID of the Amazon Web Services account to which the Glue catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that already
exists in your account, of which you can have only one and cannot modify.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently
supported version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but
not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The
catalog_id
is the account ID of the Amazon Web Services account to which the Glue
catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that
already exists in your account, of which you can have only one and cannot modify.
public void setParameters(Map<String,String> parameters)
Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently supported
version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but not
both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The catalog_id
is
the account ID of the Amazon Web Services account to which the Glue catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that already
exists in your account, of which you can have only one and cannot modify.
parameters
- Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values
depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently
supported version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but
not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The
catalog_id
is the account ID of the Amazon Web Services account to which the Glue
catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that
already exists in your account, of which you can have only one and cannot modify.
public DataCatalog withParameters(Map<String,String> parameters)
Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently supported
version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but not
both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The catalog_id
is
the account ID of the Amazon Web Services account to which the Glue catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that already
exists in your account, of which you can have only one and cannot modify.
parameters
- Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values
depend on the catalog type.
For the HIVE
data catalog type, use the following syntax. The metadata-function
parameter is required. The sdk-version
parameter is optional and defaults to the currently
supported version.
metadata-function=lambda_arn, sdk-version=version_number
For the LAMBDA
data catalog type, use one of the following sets of required parameters, but
not both.
If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
The GLUE
type takes a catalog ID parameter and is required. The
catalog_id
is the account ID of the Amazon Web Services account to which the Glue
catalog belongs.
catalog-id=catalog_id
The GLUE
data catalog type also applies to the default AwsDataCatalog
that
already exists in your account, of which you can have only one and cannot modify.
public DataCatalog addParametersEntry(String key, String value)
public DataCatalog clearParametersEntries()
public String toString()
toString
in class Object
Object.toString()
public DataCatalog clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.