Method: projects.locations.spaces.catalogs.list

Lists catalogs in a given space.

HTTP request

GET https://designcenter.googleapis.com/v1alpha/{parent=projects/*/locations/*/spaces/*}/catalogs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent space from which catalogs are listed. Format: projects/$project/locations/$location/spaces/$space

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

pageToken

string

Optional. If present, retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

filter

string

Optional. A filter that chooses which catalogs to return.

orderBy

string

Optional. How the results should be sorted.

Request body

The request body must be empty.

Response body

Results returned from catalogs.list.

If successful, the response body contains data with the following structure:

JSON representation
{
  "catalogs": [
    {
      object (Catalog)
    }
  ],
  "nextPageToken": string
}
Fields
catalogs[]

object (Catalog)

A list of catalogs

nextPageToken

string

If there might be more results than those appearing in this response, nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogs.list

For more information, see the IAM documentation.