Pub/Sub Lite API

Service: pubsublite.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. The service might have multiple service endpoints. This Pub/Sub Lite service has the following regional service endpoints and all URIs below are relative to these service endpoints:

  • https://REGION_NAME-pubsublite.googleapis.com

REST Resource: v1.admin.projects.locations.operations

Methods
cancel POST /v1/admin/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/admin/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/admin/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/admin/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.admin.projects.locations.reservations

Methods
create POST /v1/admin/{parent=projects/*/locations/*}/reservations
Creates a new reservation.
delete DELETE /v1/admin/{name=projects/*/locations/*/reservations/*}
Deletes the specified reservation.
get GET /v1/admin/{name=projects/*/locations/*/reservations/*}
Returns the reservation configuration.
list GET /v1/admin/{parent=projects/*/locations/*}/reservations
Returns the list of reservations for the given project.
patch PATCH /v1/admin/{reservation.name=projects/*/locations/*/reservations/*}
Updates properties of the specified reservation.

REST Resource: v1.admin.projects.locations.reservations.topics

Methods
list GET /v1/admin/{name=projects/*/locations/*/reservations/*}/topics
Lists the topics attached to the specified reservation.

REST Resource: v1.admin.projects.locations.subscriptions

Methods
create POST /v1/admin/{parent=projects/*/locations/*}/subscriptions
Creates a new subscription.
delete DELETE /v1/admin/{name=projects/*/locations/*/subscriptions/*}
Deletes the specified subscription.
get GET /v1/admin/{name=projects/*/locations/*/subscriptions/*}
Returns the subscription configuration.
list GET /v1/admin/{parent=projects/*/locations/*}/subscriptions
Returns the list of subscriptions for the given project.
patch PATCH /v1/admin/{subscription.name=projects/*/locations/*/subscriptions/*}
Updates properties of the specified subscription.
seek POST /v1/admin/{name=projects/*/locations/*/subscriptions/*}:seek
Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog.

REST Resource: v1.admin.projects.locations.topics

Methods
create POST /v1/admin/{parent=projects/*/locations/*}/topics
Creates a new topic.
delete DELETE /v1/admin/{name=projects/*/locations/*/topics/*}
Deletes the specified topic.
get GET /v1/admin/{name=projects/*/locations/*/topics/*}
Returns the topic configuration.
getPartitions GET /v1/admin/{name=projects/*/locations/*/topics/*}/partitions
Returns the partition information for the requested topic.
list GET /v1/admin/{parent=projects/*/locations/*}/topics
Returns the list of topics for the given project.
patch PATCH /v1/admin/{topic.name=projects/*/locations/*/topics/*}
Updates properties of the specified topic.

REST Resource: v1.admin.projects.locations.topics.subscriptions

Methods
list GET /v1/admin/{name=projects/*/locations/*/topics/*}/subscriptions
Lists the subscriptions attached to the specified topic.

REST Resource: v1.cursor.projects.locations.subscriptions

Methods
commitCursor POST /v1/cursor/{subscription=projects/*/locations/*/subscriptions/*}:commitCursor
Updates the committed cursor.

REST Resource: v1.cursor.projects.locations.subscriptions.cursors

Methods
list GET /v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors
Returns all committed cursor information for a subscription.

REST Resource: v1.topicStats.projects.locations.topics

Methods
computeHeadCursor POST /v1/topicStats/{topic=projects/*/locations/*/topics/*}:computeHeadCursor
Compute the head cursor for the partition.
computeMessageStats POST /v1/topicStats/{topic=projects/*/locations/*/topics/*}:computeMessageStats
Compute statistics about a range of messages in a given topic and partition.
computeTimeCursor POST /v1/topicStats/{topic=projects/*/locations/*/topics/*}:computeTimeCursor
Compute the corresponding cursor for a publish or event time in a topic partition.