Class Catalog

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

The catalog object represents a logical grouping of databases in the Glue Data Catalog or a federated source. You can now create a Redshift-federated catalog or a catalog containing resource links to Redshift databases in another account or region.

See Also:

  • Method Details

    • catalogId

      public final String catalogId()

      The ID of the catalog. To grant access to the default catalog, this field should not be provided.

      Returns:
      The ID of the catalog. To grant access to the default catalog, this field should not be provided.

    • name

      public final String name()

      The name of the catalog. Cannot be the same as the account ID.

      Returns:
      The name of the catalog. Cannot be the same as the account ID.

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) assigned to the catalog resource.

      Returns:
      The Amazon Resource Name (ARN) assigned to the catalog resource.

    • description

      public final String description()

      Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

      Returns:
      Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameters

      public final Map<String,String> parameters()

      A map array of key-value pairs that define parameters and properties of the catalog.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      A map array of key-value pairs that define parameters and properties of the catalog.

    • createTime

      public final Instant createTime()

      The time at which the catalog was created.

      Returns:
      The time at which the catalog was created.

    • updateTime

      public final Instant updateTime()

      The time at which the catalog was last updated.

      Returns:
      The time at which the catalog was last updated.

    • targetRedshiftCatalog

      public final TargetRedshiftCatalog targetRedshiftCatalog()

      A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

      Returns:
      A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

    • federatedCatalog

      public final FederatedCatalog federatedCatalog()

      A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

      Returns:
      A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

    • catalogProperties

      public final CatalogPropertiesOutput catalogProperties()

      A CatalogProperties object that specifies data lake access properties and other custom properties.

      Returns:
      A CatalogProperties object that specifies data lake access properties and other custom properties.

    • hasCreateTableDefaultPermissions

      public final boolean hasCreateTableDefaultPermissions()
      For responses, this returns true if the service returned a value for the CreateTableDefaultPermissions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • createTableDefaultPermissions

      public final List<PrincipalPermissions> createTableDefaultPermissions()

      An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCreateTableDefaultPermissions() method.

      Returns:
      An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

    • hasCreateDatabaseDefaultPermissions

      public final boolean hasCreateDatabaseDefaultPermissions()
      For responses, this returns true if the service returned a value for the CreateDatabaseDefaultPermissions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • createDatabaseDefaultPermissions

      public final List<PrincipalPermissions> createDatabaseDefaultPermissions()

      An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCreateDatabaseDefaultPermissions() method.

      Returns:
      An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

    • allowFullTableExternalDataAccess

      public final AllowFullTableExternalDataAccessEnum allowFullTableExternalDataAccess()

      Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

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

      Returns:
      Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
      See Also:

    • allowFullTableExternalDataAccessAsString

      public final String allowFullTableExternalDataAccessAsString()

      Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

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

      Returns:
      Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
      See Also:

    • toBuilder

      public Catalog.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<Catalog.Builder,Catalog>
      Returns:
      a builder for type T

    • builder

      public static Catalog.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Catalog.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.