This page explains how to create, view, and delete Lite subscriptions.
Lite subscriptions are zonal resources that subscribers use to read messages from Lite topics. When you create a Lite subscription, you attach it to a Lite topic. You can attach many Lite subscriptions to one Lite topic.
After creating a Lite subscription to a Lite topic, you can receive messages from the Lite subscription.
Creating Lite subscriptions
A Lite subscription must be in the same project and zone as the Lite topic that the Lite subscription is attached to. For a list of the available zones, see Pub/Sub Lite locations.
You can create Lite subscriptions with the Cloud Console,
the gcloud
command-line tool, or the Pub/Sub Lite API.
Console
In the Cloud Console, go to the Lite Subscriptions page.
Click Create Lite subscription.
Enter a Lite subscription ID.
Choose a Lite topic to receive messages from.
Choose Deliver messages immediately or Deliver messages after stored.
Click Create.
gcloud
To create a Lite subscription, use the
gcloud pubsub lite-subscriptions create
command:
gcloud pubsub lite-subscriptions create SUBSCRIPTION_ID \ --zone=ZONE \ --topic=TOPIC_ID \ --delivery-requirement=DELIVERY_REQUIREMENT
Replace the following:
SUBSCRIPTION_ID: the ID of the Lite subscription
ZONE: the name of a zone that Pub/Sub Lite supports
TOPIC_ID: the ID of the Lite topic to attach to the Lite subscription
DELIVERY_REQUIREMENT:
deliver-after-stored
ordeliver-immediately
If the request is successful, the command line displays a confirmation:
Created [SUBSCRIPTION_ID].
Protocol
To create a Lite subscription, send a POST
request like the following:
POST https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID Authorization: Bearer $(gcloud auth print-access-token)
Replace the following:
REGION: the region of the zone to store the Lite subscription in
PROJECT_NUMBER: the project number of the project to create the Lite subscription in
ZONE: the name of a zone that Pub/Sub Lite supports
SUBSCRIPTION_ID: the ID of the Lite subscription
Specify the following fields in the request body:
{ "topic": projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID, "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } }
Replace DELIVERY_REQUIREMENT with deliver-after-stored
or
deliver-immediately
.
If the request is successful, the response is the Lite subscription in JSON format:
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID", }
Java
Before running this sample, follow the Java setup instructions in Pub/Sub Lite Client Libraries.
Python
Before running this sample, follow the Python setup instructions in Pub/Sub Lite Client Libraries.
Lite subscriptions have a delivery requirement property. Lite subscriptions can deliver messages to subscribers immediately after the Pub/Sub Lite service receives the messages or only after the Pub/Sub Lite service stores the message in a partition.
If the delivery requirement is deliver-immediately
and the
Pub/Sub Lite service fails to write a message to storage, the
Pub/Sub Lite service returns an error to the publisher but
subscribers might still receive the message.
Updating Lite subscriptions
You can update Lite subscriptions with the Cloud Console,
the gcloud
command-line tool, or the Pub/Sub Lite API.
Console
In the Cloud Console, go to the Lite Subscriptions page.
Click the Lite subscription ID.
In the Lite subscription details page, click Edit.
gcloud
To update a Lite subscription, use the
gcloud pubsub lite-subscriptions update
command:
gcloud pubsub lite-subscriptions update SUBSCRIPTION_ID \ --zone=ZONE \ --delivery-requirement=DELIVERY_REQUIREMENT
Replace the following:
SUBSCRIPTION_ID: the ID of the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
DELIVERY_REQUIREMENT:
deliver-after-stored
ordeliver-immediately
If the request is successful, the command line displays the Lite subscription:
deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID
Protocol
To update a Lite subscription, send a PATCH
request like the following:
PATCH https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID?updateMask=deliveryConfig.deliveryRequirement Authorization: Bearer $(gcloud auth print-access-token)
Replace the following:
REGION: the region of the zone to store the Lite subscription in
PROJECT_NUMBER: the project number of the project with the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
SUBSCRIPTION_ID: the ID of the Lite subscription
Specify the following fields in the request body:
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } }
Replace DELIVERY_REQUIREMENT with deliver-after-stored
or
deliver-immediately
.
If the request is successful, the response is the Lite subscription in JSON format:
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID", }
Java
Before running this sample, follow the Java setup instructions in Pub/Sub Lite Client Libraries.
Python
Before running this sample, follow the Python setup instructions in Pub/Sub Lite Client Libraries.
Getting Lite subscription details
You can get details about a Lite subscription using the
Cloud Console, the gcloud
command-line tool, or the Pub/Sub Lite API.
Console
In the Cloud Console, go to the Lite Subscriptions page.
Click the Lite subscription ID.
gcloud
To get details about a Lite subscription, use the
gcloud pubsub lite-subscriptions describe
command:
gcloud pubsub lite-subscriptions describe SUBSCRIPTION_ID \ --zone=ZONE
Replace the following:
SUBSCRIPTION_ID: the ID of the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
If the request is successful, the command line displays the Lite topic:
deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID
Protocol
To get details about a Lite subscription, send a GET
request like the
following:
GET https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID Authorization: Bearer $(gcloud auth print-access-token)
Replace the following:
REGION: the region of the zone to store the Lite subscription in
PROJECT_NUMBER: the project number of the project with the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
SUBSCRIPTION_ID: the ID of the Lite subscription
If the request is successful, the response is the Lite topic in JSON format:
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID", }
Java
Before running this sample, follow the Java setup instructions in Pub/Sub Lite Client Libraries.
Python
Before running this sample, follow the Python setup instructions in Pub/Sub Lite Client Libraries.
Listing Lite subscriptions
You can list the Lite subscriptions in a project or the Lite subscriptions to a Lite topic.
Listing Lite subscriptions in a project
You can list Lite subscriptions in a project using the Cloud Console,
the gcloud
command-line tool, or the Pub/Sub Lite API.
Console
To view a list of the Lite subscriptions in a project, go to the Lite Subscriptions page.
gcloud
To list the Lite subscriptions in a project, use the
gcloud pubsub lite-subscriptions list
command:
gcloud pubsub lite-subscriptions list \ --zone=ZONE
Replace ZONE with the name of the zone that the Lite subscriptions are in.
If the request is successful, the command line displays the Lite subscriptions:
--- deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID --- deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID
Protocol
To list the Lite subscriptions in a project, send a GET
request like the
following:
GET https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/subscriptions Authorization: Bearer $(gcloud auth print-access-token)
Replace the following:
REGION: the region of the zone to store the Lite subscription in
PROJECT_NUMBER: the project number of the project with the Lite subscription
If the request is successful, the response is the Lite topic in JSON format:
{ "subscriptions": [ { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" }, { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" } ] }
Java
Before running this sample, follow the Java setup instructions in Pub/Sub Lite Client Libraries.
Python
Before running this sample, follow the Python setup instructions in Pub/Sub Lite Client Libraries.
Listing Lite subscriptions to a Lite topic
You can list Lite subscriptions to a Lite topic using the
Cloud Console, the gcloud
command-line tool, or the Pub/Sub Lite API.
Console
In the Cloud Console, go to the Lite Topics page.
Select a Lite topic ID.
In the Lite topics details page, the Lite subscriptions section includes a list of Lite subscriptions to the Lite topic.
gcloud
To list the Lite subscriptions to a topic, use the
gcloud pubsub lite-topics list-subscriptions
command:
gcloud pubsub lite-topics list-subscriptions TOPIC_ID \ --zone=ZONE
Replace the following:
TOPIC_ID: the ID of the Lite topic that the Lite subscriptions are attached to
ZONE: the name of the zone that the Lite subscription is in
If the request is successful, the command line displays the Lite subscriptions:
--- deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID --- deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID
Protocol
To list the Lite subscriptions to a Lite topic, send a GET
request like the
following:
GET https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/lite-topics/TOPIC_ID/subscriptions Authorization: Bearer $(gcloud auth print-access-token)
Replace the following:
REGION: the region of the zone to store the Lite subscription in
PROJECT_NUMBER: the project number of the project with the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
TOPIC_ID: the ID of the Lite topic that the Lite subscriptions are attached to
If the request is successful, the response is a list of Lite subscriptions in JSON format:
{ "subscriptions": [ { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" }, { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" } ] }
Java
Before running this sample, follow the Java setup instructions in Pub/Sub Lite Client Libraries.
Python
Before running this sample, follow the Python setup instructions in Pub/Sub Lite Client Libraries.
Deleting Lite subscriptions
You can delete Lite subscriptions with the Cloud Console, the
gcloud
command-line tool, or the Pub/Sub Lite API.
Console
In the Cloud Console, go to the Lite Subscriptions page.
Click the Lite subscription ID.
In the Lite subscription details page, click Delete.
In the dialog that appears, click Delete to confirm that you want to delete the Lite subscription.
gcloud
To delete a Lite subscription, use the
gcloud pubsub lite-subscriptions delete
command:
Run the
delete
command:gcloud pubsub lite-subscriptions delete SUBSCRIPTION_ID \ --zone=ZONE
Replace the following:
SUBSCRIPTION_ID: the ID of the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
To confirm, type
Y
.
If the request is successful, the command line displays a confirmation:
Deleted subscription [SUBSCRIPTION_ID].
Protocol
To delete a Lite topic, send a DELETE
request like the following:
DELETE https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID Authorization: Bearer $(gcloud auth print-access-token)
Replace the following:
REGION: the region of the zone to store the Lite subscription in
PROJECT_NUMBER: the project number of the project with the Lite subscription
ZONE: the name of the zone that the Lite subscription is in
SUBSCRIPTION_ID: the ID of the Lite subscription
If the request is successful, the response is an empty JSON object.
Java
Before running this sample, follow the Java setup instructions in Pub/Sub Lite Client Libraries.
Python
Before running this sample, follow the Python setup instructions in Pub/Sub Lite Client Libraries.