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

Interface GetCatalogsRequest.Builder

    • Method Detail

      • parentCatalogId

        GetCatalogsRequest.Builder parentCatalogId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        GetCatalogsRequest.Builder nextToken​(String nextToken)

        A continuation token, if this is a continuation call.

        Parameters:
        nextToken - A continuation token, if this is a continuation call.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        GetCatalogsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of catalogs to return in one response.

        Parameters:
        maxResults - The maximum number of catalogs to return in one response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recursive

        GetCatalogsRequest.Builder recursive​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • includeRoot

        GetCatalogsRequest.Builder includeRoot​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.