Cloud Pub/Sub API (pubsub:v1)

2023-01-19

4 new methods

Additions

    Methods
  • pubsub.projects.schemas.rollback

      Parameter Order: name

      HTTP Method: POST

      Path: v1/{+name}:rollback

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/pubsub
    • Flat Path: v1/projects/{projectsId}/schemas/{schemasId}:rollback

      Parameters:

        name

          Pattern: ^projects/[^/]+/schemas/[^/]+$

          Type: string

          Location: path

          Description: Required. The schema being rolled back with revision id.

          Required: Yes

      Description: Creates a new schema revision that is a copy of the provided revision_id.

  • pubsub.projects.schemas.listRevisions

      Path: v1/{+name}:listRevisions

      HTTP Method: GET

      Scopes:

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

        pageSize

          Type: integer

          Format: int32

          Location: query

          Description: The maximum number of revisions to return per page.

        view

          Enum Descriptions:

        • The default / unset value. The API will default to the BASIC view.
        • Include the name and type of the schema, but not the definition.
        • Include all Schema object fields.
        • Type: string

          Enum:

        • SCHEMA_VIEW_UNSPECIFIED
        • BASIC
        • FULL
        • Location: query

          Description: 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.

        pageToken

          Description: The page token, received from a previous ListSchemaRevisions call. Provide this to retrieve the subsequent page.

          Location: query

          Type: string

        name

          Location: path

          Pattern: ^projects/[^/]+/schemas/[^/]+$

          Type: string

          Required: Yes

          Description: Required. The name of the schema to list revisions for.

      Description: Lists all schema revisions for the named schema.

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/schemas/{schemasId}:listRevisions

  • pubsub.projects.schemas.commit

      Scopes:

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

        name

          Pattern: ^projects/[^/]+/schemas/[^/]+$

          Required: Yes

          Type: string

          Description: Required. The name of the schema we are revising. Format is `projects/{project}/schemas/{schema}`.

          Location: path

      Description: Commits a new schema revision to an existing schema.

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/schemas/{schemasId}:commit

      Parameter Order: name

      Path: v1/{+name}:commit

  • pubsub.projects.schemas.deleteRevision

      HTTP Method: DELETE

      Parameters:

        revisionId

          Type: string

          Description: Required. The revision ID to roll back to. It must be a revision of the same schema. Example: c7cfa2a8

          Location: query

        name

          Description: Required. The name of the schema revision to be deleted, with a revision ID explicitly included. Example: projects/123/schemas/my-schema@c7cfa2a8

          Location: path

          Pattern: ^projects/[^/]+/schemas/[^/]+$

          Type: string

          Required: Yes

      Flat Path: v1/projects/{projectsId}/schemas/{schemasId}:deleteRevision

      Description: Deletes a specific schema revision.

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/pubsub
    • Path: v1/{+name}:deleteRevision

      Parameter Order: name