Package software.amazon.awssdk.services.athena.model

Interface UpdateDataCatalogRequest.Builder

    • Method Detail

      • name

        UpdateDataCatalogRequest.Builder name​(String name)

        The name of the data catalog to update. 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 to update. 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.

      • type

        UpdateDataCatalogRequest.Builder type​(String type)

        Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

        Parameters:
        type - Specifies the type of data catalog to update. Specify 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

        UpdateDataCatalogRequest.Builder type​(DataCatalogType type)

        Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

        Parameters:
        type - Specifies the type of data catalog to update. Specify 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

      • description

        UpdateDataCatalogRequest.Builder description​(String description)

        New or modified text that describes the data catalog.

        Parameters:
        description - New or modified text that describes the data catalog.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parameters

        UpdateDataCatalogRequest.Builder parameters​(Map<String,​String> parameters)

        Specifies the Lambda function or functions to use for updating 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

        Parameters:
        parameters - Specifies the Lambda function or functions to use for updating 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

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