software.amazon.awssdk.services.athena.model

Interface DataCatalog.Builder

All Superinterfaces:

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

Enclosing class:

DataCatalog

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

Method Summary

Modifier and Type	Method and Description
DataCatalog.Builder	description(String description) An optional description of the data catalog.
DataCatalog.Builder	name(String name) The name of the data catalog.
DataCatalog.Builder	parameters(Map<String,String> parameters) Specifies the Lambda function or functions to use for the data catalog.
DataCatalog.Builder	type(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.Builder	type(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.

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

DataCatalog.Builder name(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.

Parameters:

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.

Returns:

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

description

DataCatalog.Builder description(String description)

An optional description of the data catalog.

Parameters:

description - An optional description of the data catalog.

Returns:

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

type

DataCatalog.Builder type(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.

Parameters:

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.

Returns:

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

See Also:

DataCatalogType, DataCatalogType

type

DataCatalog.Builder type(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.

Parameters:

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.

Returns:

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

See Also:

DataCatalogType, DataCatalogType

parameters

DataCatalog.Builder parameters(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.

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

Parameters:

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.

  • Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.

Returns:

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