Console
Start free

Method: googleapis.pubsub.v1.projects.schemas.list

Lists schemas in a project.

Arguments

Parameters parent

string

Required. The name of the project in which to list schemas. Format is projects/{project-id}.

pageSize

integer (int32 format)

Maximum number of schemas to return.

pageToken

string

The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data.

view

enum

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.

Enum type. Can be one of the following: SCHEMA_VIEW_UNSPECIFIED The default / unset value. The API will default to the BASIC view. BASIC Include the name and type of the schema, but not the definition. FULL Include all Schema object fields.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListSchemasResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.pubsub.v1.projects.schemas.list
    args:
        parent: ...
        pageSize: ...
        pageToken: ...
        view: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.pubsub.v1.projects.schemas.list",
      "args": {
        "parent": "...",
        "pageSize": "...",
        "pageToken": "...",
        "view": "..."
      },
      "result": "listResult"
    }
  }
]