Interface ListCatalogsRequest

interface ListCatalogsRequest {
    includeBrowse?: boolean;
    includeUnbound?: boolean;
    maxResults?: number;
    pageToken?: string;
}

Properties

includeBrowse?: boolean

Whether to include catalogs in the response for which the principal can only access selective metadata for

includeUnbound?: boolean

Whether to include catalogs not bound to the workspace. Effective only if the user has permission to update the catalog–workspace binding.

maxResults?: number

Maximum number of catalogs to return.

when set to 0, the page length is set to a server configured value (recommended);
when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
when set to a value less than 0, an invalid parameter error is returned;
If not set, all valid catalogs are returned (not recommended).
Note: The number of returned catalogs might be less than the specified max_results size, even zero. The only definitive indication that no further catalogs can be fetched is when the next_page_token is unset from the response.

pageToken?: string

Opaque pagination token to go to next page based on previous query.