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.

    • toBuilder

      public GetCatalogsRequest.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<GetCatalogsRequest.Builder,GetCatalogsRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.