Package software.amazon.awssdk.services.glue.model

Class GetCatalogsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.glue.model.GlueRequest
software.amazon.awssdk.services.glue.model.GetCatalogsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCatalogsRequest.Builder,GetCatalogsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetCatalogsRequest extends GlueRequest implements ToCopyableBuilder<GetCatalogsRequest.Builder,GetCatalogsRequest>

  • Method Details

    • parentCatalogId

      public final String parentCatalogId()

      The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.

      Returns:
      The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.

    • nextToken

      public final String nextToken()

      A continuation token, if this is a continuation call.

      Returns:
      A continuation token, if this is a continuation call.

    • maxResults

      public final Integer maxResults()

      The maximum number of catalogs to return in one response.

      Returns:
      The maximum number of catalogs to return in one response.

    • recursive

      public final Boolean recursive()

      Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId. Defaults to false . When true, all catalog objects in the ParentCatalogID hierarchy are enumerated in the response.

      Returns:
      Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId . Defaults to false . When true, all catalog objects in the ParentCatalogID hierarchy are enumerated in the response.

    • includeRoot

      public final Boolean includeRoot()

      Whether to list the default catalog in the account and region in the response. Defaults to false. When true and ParentCatalogId = NULL | Amazon Web Services Account ID, all catalogs and the default catalog are enumerated in the response.

      When the ParentCatalogId is not equal to null, and this attribute is passed as false or true, an InvalidInputException is thrown.

      Returns:
      Whether to list the default catalog in the account and region in the response. Defaults to false. When true and ParentCatalogId = NULL | Amazon Web Services Account ID, all catalogs and the default catalog are enumerated in the response.

      When the ParentCatalogId is not equal to null, and this attribute is passed as false or true, an InvalidInputException is thrown.

    • hasDatabases

      public final Boolean hasDatabases()

      When true, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to true, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to false.

      Returns:
      When true, the response only includes catalogs that can contain databases. Some catalogs are organizational containers that hold only other catalogs, not databases. When this parameter is set to true, those container-only catalogs are excluded, and only catalogs capable of containing databases are returned. Defaults to false.

    • toBuilder

      public GetCatalogsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetCatalogsRequest.Builder,GetCatalogsRequest>
      Specified by:
      toBuilder in class GlueRequest

    • builder

      public static GetCatalogsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo