DataCatalog (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.athena.model.DataCatalog

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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 AWS account.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DataCatalog()

Constructors
Constructor and Description
`DataCatalog()`

Method Summary

All Methods Instance Methods Concrete Methods
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: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
`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: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
`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: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
`DataCatalog`	`withType(String type)` The type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DataCatalog
```
public DataCatalog()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    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.
    
    Parameters:
    
    name - 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.
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    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.
  - withName
```
public DataCatalog withName(String name)
```
    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.
    
    Parameters:
    
    name - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    An optional description of the data catalog.
    
    Parameters:
    
    description - An optional description of the data catalog.
  - getDescription
```
public String getDescription()
```
    An optional description of the data catalog.
    
    Returns:
    
    An optional description of the data catalog.
  - withDescription
```
public DataCatalog withDescription(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.
  - setType
```
public void setType(String type)
```
    The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    Parameters:
    
    type - The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    See Also:
    
    DataCatalogType
  - getType
```
public String getType()
```
    The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    Returns:
    
    The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    See Also:
    
    DataCatalogType
  - withType
```
public DataCatalog withType(String type)
```
    The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    Parameters:
    
    type - The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataCatalogType
  - withType
```
public DataCatalog withType(DataCatalogType type)
```
    The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    Parameters:
    
    type - The type of data catalog: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DataCatalogType
  - getParameters
```
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 has no parameters.
    Returns:
    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 has no parameters.
  - setParameters
```
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 has no parameters.
    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 has no parameters.
  - withParameters
```
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 has no parameters.
    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 has no parameters.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public DataCatalog addParametersEntry(String key,
                                      String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public DataCatalog clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DataCatalog clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DataCatalog

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataCatalog

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setType

getType

withType

withType

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

toString

equals

hashCode

clone

marshall