AWS SDK for C++  1.9.2
AWS SDK for C++
Public Member Functions | List of all members
Aws::Athena::Model::DataCatalog Class Reference

#include <DataCatalog.h>

Public Member Functions

 DataCatalog ()
 
 DataCatalog (Aws::Utils::Json::JsonView jsonValue)
 
DataCatalogoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DataCatalogWithName (const Aws::String &value)
 
DataCatalogWithName (Aws::String &&value)
 
DataCatalogWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
DataCatalogWithDescription (const Aws::String &value)
 
DataCatalogWithDescription (Aws::String &&value)
 
DataCatalogWithDescription (const char *value)
 
const DataCatalogTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const DataCatalogType &value)
 
void SetType (DataCatalogType &&value)
 
DataCatalogWithType (const DataCatalogType &value)
 
DataCatalogWithType (DataCatalogType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
DataCatalogWithParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
DataCatalogWithParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
DataCatalogAddParameters (const Aws::String &key, const Aws::String &value)
 
DataCatalogAddParameters (Aws::String &&key, const Aws::String &value)
 
DataCatalogAddParameters (const Aws::String &key, Aws::String &&value)
 
DataCatalogAddParameters (Aws::String &&key, Aws::String &&value)
 
DataCatalogAddParameters (const char *key, Aws::String &&value)
 
DataCatalogAddParameters (Aws::String &&key, const char *value)
 
DataCatalogAddParameters (const char *key, const char *value)
 

Detailed Description

Contains information about a data catalog in an AWS account.

See Also:

AWS API Reference

Definition at line 34 of file DataCatalog.h.

Constructor & Destructor Documentation

◆ DataCatalog() [1/2]

Aws::Athena::Model::DataCatalog::DataCatalog ( )

◆ DataCatalog() [2/2]

Aws::Athena::Model::DataCatalog::DataCatalog ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddParameters() [1/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 388 of file DataCatalog.h.

◆ AddParameters() [2/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 348 of file DataCatalog.h.

◆ AddParameters() [3/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 428 of file DataCatalog.h.

◆ AddParameters() [4/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 368 of file DataCatalog.h.

◆ AddParameters() [5/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 328 of file DataCatalog.h.

◆ AddParameters() [6/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 408 of file DataCatalog.h.

◆ AddParameters() [7/7]

DataCatalog& Aws::Athena::Model::DataCatalog::AddParameters ( const char *  key,
const char *  value 
)
inline

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

Definition at line 448 of file DataCatalog.h.

◆ DescriptionHasBeenSet()

bool Aws::Athena::Model::DataCatalog::DescriptionHasBeenSet ( ) const
inline

An optional description of the data catalog.

Definition at line 108 of file DataCatalog.h.

◆ GetDescription()

const Aws::String& Aws::Athena::Model::DataCatalog::GetDescription ( ) const
inline

An optional description of the data catalog.

Definition at line 103 of file DataCatalog.h.

◆ GetName()

const Aws::String& Aws::Athena::Model::DataCatalog::GetName ( ) const
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 48 of file DataCatalog.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::Athena::Model::DataCatalog::GetParameters ( ) const
inline

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

Definition at line 208 of file DataCatalog.h.

◆ GetType()

const DataCatalogType& Aws::Athena::Model::DataCatalog::GetType ( ) const
inline

The type of data catalog: LAMBDA for a federated catalog or HIVE for an external hive metastore. GLUE refers to the AwsDataCatalog that already exists in your account, of which you can have only one.

Definition at line 147 of file DataCatalog.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Athena::Model::DataCatalog::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::Athena::Model::DataCatalog::NameHasBeenSet ( ) const
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 55 of file DataCatalog.h.

◆ operator=()

DataCatalog& Aws::Athena::Model::DataCatalog::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ParametersHasBeenSet()

bool Aws::Athena::Model::DataCatalog::ParametersHasBeenSet ( ) const
inline

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

Definition at line 228 of file DataCatalog.h.

◆ SetDescription() [1/3]

void Aws::Athena::Model::DataCatalog::SetDescription ( Aws::String &&  value)
inline

An optional description of the data catalog.

Definition at line 118 of file DataCatalog.h.

◆ SetDescription() [2/3]

void Aws::Athena::Model::DataCatalog::SetDescription ( const Aws::String value)
inline

An optional description of the data catalog.

Definition at line 113 of file DataCatalog.h.

◆ SetDescription() [3/3]

void Aws::Athena::Model::DataCatalog::SetDescription ( const char *  value)
inline

An optional description of the data catalog.

Definition at line 123 of file DataCatalog.h.

◆ SetName() [1/3]

void Aws::Athena::Model::DataCatalog::SetName ( Aws::String &&  value)
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 69 of file DataCatalog.h.

◆ SetName() [2/3]

void Aws::Athena::Model::DataCatalog::SetName ( const Aws::String value)
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 62 of file DataCatalog.h.

◆ SetName() [3/3]

void Aws::Athena::Model::DataCatalog::SetName ( const char *  value)
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 76 of file DataCatalog.h.

◆ SetParameters() [1/2]

void Aws::Athena::Model::DataCatalog::SetParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 268 of file DataCatalog.h.

◆ SetParameters() [2/2]

void Aws::Athena::Model::DataCatalog::SetParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 248 of file DataCatalog.h.

◆ SetType() [1/2]

void Aws::Athena::Model::DataCatalog::SetType ( const DataCatalogType value)
inline

The type of data catalog: LAMBDA for a federated catalog or HIVE for an external hive metastore. GLUE refers to the AwsDataCatalog that already exists in your account, of which you can have only one.

Definition at line 163 of file DataCatalog.h.

◆ SetType() [2/2]

void Aws::Athena::Model::DataCatalog::SetType ( DataCatalogType &&  value)
inline

The type of data catalog: LAMBDA for a federated catalog or HIVE for an external hive metastore. GLUE refers to the AwsDataCatalog that already exists in your account, of which you can have only one.

Definition at line 171 of file DataCatalog.h.

◆ TypeHasBeenSet()

bool Aws::Athena::Model::DataCatalog::TypeHasBeenSet ( ) const
inline

The type of data catalog: LAMBDA for a federated catalog or HIVE for an external hive metastore. GLUE refers to the AwsDataCatalog that already exists in your account, of which you can have only one.

Definition at line 155 of file DataCatalog.h.

◆ WithDescription() [1/3]

DataCatalog& Aws::Athena::Model::DataCatalog::WithDescription ( Aws::String &&  value)
inline

An optional description of the data catalog.

Definition at line 133 of file DataCatalog.h.

◆ WithDescription() [2/3]

DataCatalog& Aws::Athena::Model::DataCatalog::WithDescription ( const Aws::String value)
inline

An optional description of the data catalog.

Definition at line 128 of file DataCatalog.h.

◆ WithDescription() [3/3]

DataCatalog& Aws::Athena::Model::DataCatalog::WithDescription ( const char *  value)
inline

An optional description of the data catalog.

Definition at line 138 of file DataCatalog.h.

◆ WithName() [1/3]

DataCatalog& Aws::Athena::Model::DataCatalog::WithName ( Aws::String &&  value)
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 90 of file DataCatalog.h.

◆ WithName() [2/3]

DataCatalog& Aws::Athena::Model::DataCatalog::WithName ( const Aws::String value)
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 83 of file DataCatalog.h.

◆ WithName() [3/3]

DataCatalog& Aws::Athena::Model::DataCatalog::WithName ( const char *  value)
inline

The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

Definition at line 97 of file DataCatalog.h.

◆ WithParameters() [1/2]

DataCatalog& Aws::Athena::Model::DataCatalog::WithParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 308 of file DataCatalog.h.

◆ WithParameters() [2/2]

DataCatalog& Aws::Athena::Model::DataCatalog::WithParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 288 of file DataCatalog.h.

◆ WithType() [1/2]

DataCatalog& Aws::Athena::Model::DataCatalog::WithType ( const DataCatalogType value)
inline

The type of data catalog: LAMBDA for a federated catalog or HIVE for an external hive metastore. GLUE refers to the AwsDataCatalog that already exists in your account, of which you can have only one.

Definition at line 179 of file DataCatalog.h.

◆ WithType() [2/2]

DataCatalog& Aws::Athena::Model::DataCatalog::WithType ( DataCatalogType &&  value)
inline

The type of data catalog: LAMBDA for a federated catalog or HIVE for an external hive metastore. GLUE refers to the AwsDataCatalog that already exists in your account, of which you can have only one.

Definition at line 187 of file DataCatalog.h.


The documentation for this class was generated from the following file: