Method: admin.projects.locations.reservations.topics.list

Lists the topics attached to the specified reservation.

HTTP request

GET https://{endpoint}/v1/admin/{name=projects/*/locations/*/reservations/*}/topics

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservationId}

Authorization requires the following IAM permission on the specified resource name:

  • pubsublite.reservations.listTopics

Query parameters

Parameters
pageSize

integer

The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the given reservation will be returned.

pageToken

string

A page token, received from a previous topics.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to topics.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

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

Response for topics.list.

JSON representation
{
  "topics": [
    string
  ],
  "nextPageToken": string
}
Fields
topics[]

string

The names of topics attached to the reservation. The order of the topics is unspecified.

nextPageToken

string

A token that can be sent as pageToken to retrieve the next page of results. If this field is omitted, there are no more results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.