Method: admin.projects.locations.topics.getPartitions

Returns the partition information for the requested topic.

HTTP request

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

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The topic whose partition information to return.

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

  • pubsublite.topics.getPartitions

Request body

The request body must be empty.

Response body

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

Response for topics.getPartitions.

JSON representation 
{
  "partitionCount": string
}
Fields
partitionCount

string (int64 format)

The number of partitions in the topic.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.