Interface DataCatalogSummary.Builder

  • Method Details

    • catalogName

      DataCatalogSummary.Builder catalogName(String catalogName)

      The name of the data catalog. The catalog name is 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:
      catalogName - The name of the data catalog. The catalog name is 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

      The data catalog type.

      Parameters:
      type - The data catalog type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The data catalog type.

      Parameters:
      type - The data catalog type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of the creation or deletion of the data catalog.

      • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.

      • The FEDERATED data catalog type is created asynchronously.

      Data catalog creation status:

      • CREATE_IN_PROGRESS: Federated data catalog creation in progress.

      • CREATE_COMPLETE: Data catalog creation complete.

      • CREATE_FAILED: Data catalog could not be created.

      • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.

      • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.

      • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

      Data catalog deletion status:

      • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.

      • DELETE_COMPLETE: Federated data catalog deleted.

      • DELETE_FAILED: Federated data catalog could not be deleted.

      Parameters:
      status - The status of the creation or deletion of the data catalog.

      • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.

      • The FEDERATED data catalog type is created asynchronously.

      Data catalog creation status:

      • CREATE_IN_PROGRESS: Federated data catalog creation in progress.

      • CREATE_COMPLETE: Data catalog creation complete.

      • CREATE_FAILED: Data catalog could not be created.

      • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.

      • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.

      • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

      Data catalog deletion status:

      • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.

      • DELETE_COMPLETE: Federated data catalog deleted.

      • DELETE_FAILED: Federated data catalog could not be deleted.

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

      The status of the creation or deletion of the data catalog.

      • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.

      • The FEDERATED data catalog type is created asynchronously.

      Data catalog creation status:

      • CREATE_IN_PROGRESS: Federated data catalog creation in progress.

      • CREATE_COMPLETE: Data catalog creation complete.

      • CREATE_FAILED: Data catalog could not be created.

      • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.

      • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.

      • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

      Data catalog deletion status:

      • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.

      • DELETE_COMPLETE: Federated data catalog deleted.

      • DELETE_FAILED: Federated data catalog could not be deleted.

      Parameters:
      status - The status of the creation or deletion of the data catalog.

      • The LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED.

      • The FEDERATED data catalog type is created asynchronously.

      Data catalog creation status:

      • CREATE_IN_PROGRESS: Federated data catalog creation in progress.

      • CREATE_COMPLETE: Data catalog creation complete.

      • CREATE_FAILED: Data catalog could not be created.

      • CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog creation failed and is being removed.

      • CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation failed and was removed.

      • CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation failed but could not be removed.

      Data catalog deletion status:

      • DELETE_IN_PROGRESS: Federated data catalog deletion in progress.

      • DELETE_COMPLETE: Federated data catalog deleted.

      • DELETE_FAILED: Federated data catalog could not be deleted.

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

      DataCatalogSummary.Builder connectionType(String connectionType)

      The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.

      Parameters:
      connectionType - The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • connectionType

      DataCatalogSummary.Builder connectionType(ConnectionType connectionType)

      The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.

      Parameters:
      connectionType - The type of connection for a FEDERATED data catalog (for example, REDSHIFT, MYSQL, or SQLSERVER). For information about individual connectors, see Available data source connectors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • error

      Text of the error that occurred during data catalog creation or deletion.

      Parameters:
      error - Text of the error that occurred during data catalog creation or deletion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.