Class DataCatalogSummary

java.lang.Object
software.amazon.awssdk.services.athena.model.DataCatalogSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataCatalogSummary.Builder,DataCatalogSummary>
@Generated("software.amazon.awssdk:codegen") public final class DataCatalogSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataCatalogSummary.Builder,DataCatalogSummary>

The summary information for the data catalog, which includes its name and type.

See Also:

  • Method Details

    • catalogName

      public final 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.

      Returns:
      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.

    • type

      public final DataCatalogType type()

      The data catalog type.

      If the service returns an enum value that is not available in the current SDK version, type will return DataCatalogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The data catalog type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The data catalog type.

      If the service returns an enum value that is not available in the current SDK version, type will return DataCatalogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The data catalog type.
      See Also:

    • status

      public final DataCatalogStatus 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.

      If the service returns an enum value that is not available in the current SDK version, status will return DataCatalogStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return DataCatalogStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.

      See Also:

    • connectionType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

      Returns:
      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.
      See Also:

    • connectionTypeAsString

      public final String connectionTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

      Returns:
      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.
      See Also:

    • error

      public final String error()

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

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

    • toBuilder

      public DataCatalogSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataCatalogSummary.Builder,DataCatalogSummary>
      Returns:
      a builder for type T

    • builder

      public static DataCatalogSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DataCatalogSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.