このページでは、Lite サブスクリプションを作成、表示、削除する方法について説明します。
Lite サブスクリプションは、サブスクライバーが Lite トピックからメッセージを読み取るために使用するゾーンリソースです。Lite サブスクリプションを作成する際に、Lite トピックに追加します。1 つの Lite トピックに多数の Lite サブスクリプションを追加できます。
Lite トピックに Lite サブスクリプションを作成すると、Lite サブスクリプションからメッセージを受信できるようになります。
Lite サブスクリプションの作成
Lite サブスクリプションは、Lite サブスクリプションが関連付けられ Lite トピックと同じプロジェクトとゾーンに存在している必要があります。使用可能なゾーンのリストについては、Pub/Sub Lite のロケーションをご覧ください。
Lite サブスクリプションは、Cloud Console、gcloud
コマンドライン ツール、または Pub/Sub Lite API を使用して作成できます。
コンソール
Cloud Console で、[Lite サブスクリプション] ページに移動します。
[Lite サブスクリプションを作成] をクリックします。
Lite サブスクリプション ID を入力します。
メッセージを受信する Lite トピックを選択します。
[すぐにメッセージを配信] または [保存後にメッセージを配信] を選択します。
[作成] をクリック
gcloud
Lite サブスクリプションを作成するには、gcloud pubsub lite-subscriptions create
コマンドを使用します。
gcloud pubsub lite-subscriptions create SUBSCRIPTION_ID \ --zone=ZONE \ --topic=TOPIC_ID \ --delivery-requirement=DELIVERY_REQUIREMENT
以下を置き換えます。
SUBSCRIPTION_ID: Lite サブスクリプションの ID
ZONE: Pub/Sub Lite がサポートするゾーンの名前
TOPIC_ID: Lite サブスクリプションに関連付ける Lite トピックの ID。
DELIVERY_REQUIREMENT:
deliver-after-stored
またはdeliver-immediately
リクエストが成功すると、コマンドラインに確認メッセージが表示されます。
Created [SUBSCRIPTION_ID].
プロトコル
Lite サブスクリプションを作成するには、次のような POST
リクエストを送信します。
POST https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID Authorization: Bearer $(gcloud auth print-access-token)
以下を置き換えます。
REGION: Lite サブスクリプションを保存するゾーンのリージョン
PROJECT_NUMBER: Lite サブスクリプションを作成するプロジェクトのプロジェクト番号
ZONE: Pub/Sub Lite がサポートするゾーンの名前
SUBSCRIPTION_ID: Lite サブスクリプションの ID
リクエスト本文に次のフィールドを指定します。
{ "topic": projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID, "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } }
DELIVERY_REQUIREMENT は、deliver-after-stored
または deliver-immediately
に置き換えます。
リクエストが成功した場合のレスポンスは、JSON 形式の Lite サブスクリプションになります。
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID", }
Java
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Java の設定手順を実施してください。
Python
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Python の設定手順を実施してください。
Lite サブスクリプションには配信の要件プロパティがあります。Lite サブスクリプションは、Pub/Sub Lite サービスがメッセージを受信した直後、または Pub/Sub Lite サービスがパーティションにメッセージを保存した後にのみ、サブスクライバーにメッセージを配信できます。
配信の要件が deliver-immediately
で、Pub/Sub Lite サービスがストレージへのメッセージの書き込みに失敗した場合、Pub/Sub Lite サービスはパブリッシャーにエラーを返しますが、サブスクライバーは引き続きメッセージを受信する可能性があります。
Lite サブスクリプションの更新
Lite サブスクリプションは、Cloud Console、gcloud
コマンドライン ツール、または Pub/Sub Lite API を使用して更新できます。
コンソール
Cloud Console で、[Lite サブスクリプション] ページに移動します。
[Lite サブスクリプション ID] をクリックします。
[Lite サブスクリプションの詳細] ページで [編集] をクリックします。
gcloud
Lite サブスクリプションを更新するには、gcloud pubsub lite-subscriptions update
コマンドを使用します。
gcloud pubsub lite-subscriptions update SUBSCRIPTION_ID \ --zone=ZONE \ --delivery-requirement=DELIVERY_REQUIREMENT
以下を置き換えます。
SUBSCRIPTION_ID: Lite サブスクリプションの ID
ZONE: Lite サブスクリプションが含まれるゾーンの名前
DELIVERY_REQUIREMENT:
deliver-after-stored
またはdeliver-immediately
リクエストが成功すると、コマンドラインに Lite サブスクリプションが表示されます。
deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID
プロトコル
Lite サブスクリプションを更新するには、次のような PATCH
リクエストを送信します。
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)
以下を置き換えます。
REGION: Lite サブスクリプションを保存するゾーンのリージョン
PROJECT_NUMBER: Lite サブスクリプションを持つプロジェクトのプロジェクト番号
ZONE: Lite サブスクリプションが含まれるゾーンの名前
SUBSCRIPTION_ID: Lite サブスクリプションの ID
リクエスト本文に次のフィールドを指定します。
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } }
DELIVERY_REQUIREMENT は、deliver-after-stored
または deliver-immediately
に置き換えます。
リクエストが成功した場合のレスポンスは、JSON 形式の Lite サブスクリプションになります。
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID", }
Java
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Java の設定手順を実施してください。
Python
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Python の設定手順を実施してください。
Lite サブスクリプションの詳細を取得する
Lite サブスクリプションの詳細は、Cloud Console、gcloud
コマンドライン ツール、または Pub/Sub Lite API を使用して取得できます。
コンソール
Cloud Console で、[Lite サブスクリプション] ページに移動します。
[Lite サブスクリプション ID] をクリックします。
gcloud
Lite サブスクリプションの詳細を取得するには、gcloud pubsub lite-subscriptions describe
コマンドを使用します。
gcloud pubsub lite-subscriptions describe SUBSCRIPTION_ID \ --zone=ZONE
以下を置き換えます。
SUBSCRIPTION_ID: Lite サブスクリプションの ID
ZONE: Lite サブスクリプションが含まれるゾーンの名前
リクエストが成功すると、コマンドラインに Lite トピックが表示されます。
deliveryConfig: deliveryRequirement: DELIVERY_REQUIREMENT name: projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID topic: projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID
プロトコル
Lite サブスクリプションの詳細を取得するには、次のような GET
リクエストを送信します。
GET https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID Authorization: Bearer $(gcloud auth print-access-token)
以下を置き換えます。
REGION: Lite サブスクリプションを保存するゾーンのリージョン
PROJECT_NUMBER: Lite サブスクリプションを持つプロジェクトのプロジェクト番号
ZONE: Lite サブスクリプションが含まれるゾーンの名前
SUBSCRIPTION_ID: Lite サブスクリプションの ID
リクエストが成功すると、レスポンスは JSON 形式の Lite トピックになります。
{ "deliveryConfig": { "deliveryRequirement": DELIVERY_REQUIREMENT, } "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID", "topic": "projects/PROJECT_NUMBER/locations/ZONE/topics/TOPIC_ID", }
Java
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Java の設定手順を実施してください。
Python
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Python の設定手順を実施してください。
Lite サブスクリプションの一覧表示
プロジェクト内の Lite サブスクリプションまたは、Lite トピックの Lite サブスクリプションを一覧表示できます。
プロジェクト内の Lite サブスクリプションを一覧表示する
Cloud Console、gcloud
コマンドライン ツール、または Pub/Sub Lite API を使用して、プロジェクト内の Lite サブスクリプションを一覧表示できます。
Console
プロジェクト内の Lite サブスクリプションのリストを表示するには、[Lite サブスクリプション] ページに移動します。
gcloud
プロジェクト内の Lite サブスクリプションを一覧表示するには、gcloud pubsub lite-subscriptions list
コマンドを使用します。
gcloud pubsub lite-subscriptions list \ --zone=ZONE
ZONE は、Lite サブスクリプションが含まれるゾーンの名前に置き換えます。
リクエストが成功すると、コマンドラインに Lite サブスクリプションが表示されます。
--- 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
プロトコル
プロジェクト内の Lite サブスクリプションを一覧表示するには、次のように GET
リクエストを送信します。
GET https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/subscriptions Authorization: Bearer $(gcloud auth print-access-token)
以下を置き換えます。
REGION: Lite サブスクリプションを保存するゾーンのリージョン
PROJECT_NUMBER: Lite サブスクリプションを持つプロジェクトのプロジェクト番号
リクエストが成功すると、レスポンスは JSON 形式の Lite トピックになります。
{ "subscriptions": [ { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" }, { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" } ] }
Java
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Java の設定手順を実施してください。
Python
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Python の設定手順を実施してください。
Lite トピックの Lite サブスクリプションを一覧表示する
Cloud Console、gcloud
コマンドライン ツール、または Pub/Sub Lite API を使用して、Lite トピックの Lite サブスクリプションを一覧表示できます。
コンソール
Cloud Console で、[Lite トピック] ページに移動します。
[Lite トピック ID] を選択します。
[Lite トピック] 詳細ページの [Lite サブスクリプション] セクションに、Lite トピックの Lite サブスクリプションのリストが含まれます。
gcloud
トピックの Lite サブスクリプションを一覧表示するには、gcloud pubsub lite-topics list-subscriptions
コマンドを使用します。
gcloud pubsub lite-topics list-subscriptions TOPIC_ID \ --zone=ZONE
以下を置き換えます。
TOPIC_ID: Lite サブスクリプションが関連付けられた Lite トピックの ID
ZONE: Lite サブスクリプションが含まれるゾーンの名前
リクエストが成功すると、コマンドラインに Lite サブスクリプションが表示されます。
--- 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
プロトコル
Lite トピックの Lite サブスクリプションを一覧表示するには、次のような GET
リクエストを送信します。
GET https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/lite-topics/TOPIC_ID/subscriptions Authorization: Bearer $(gcloud auth print-access-token)
以下を置き換えます。
REGION: Lite サブスクリプションを保存するゾーンのリージョン
PROJECT_NUMBER: Lite サブスクリプションを持つプロジェクトのプロジェクト番号
ZONE: Lite サブスクリプションが含まれるゾーンの名前
TOPIC_ID: Lite サブスクリプションが関連付けられた Lite トピックの ID
リクエストが成功した場合、レスポンスは JSON 形式の Lite サブスクリプションのリストになります。
{ "subscriptions": [ { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" }, { "name": "projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID" } ] }
Java
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Java の設定手順を実施してください。
Python
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Python の設定手順を実施してください。
Lite サブスクリプションの削除
Lite サブスクリプションは、Cloud Console、gcloud
コマンドライン ツール、または Pub/Sub Lite API を使用して削除できます。
コンソール
Cloud Console で、[Lite サブスクリプション] ページに移動します。
[Lite サブスクリプション ID] をクリックします。
[Lite サブスクリプションの詳細] ページで [削除] をクリックします。
表示されたダイアログで [削除] をクリックして、削除する Lite サブスクリプションの削除を確定します。
gcloud
Lite サブスクリプションを削除するには、gcloud pubsub lite-subscriptions delete
コマンドを使用します。
delete
コマンドを実行します。gcloud pubsub lite-subscriptions delete SUBSCRIPTION_ID \ --zone=ZONE
以下を置き換えます。
SUBSCRIPTION_ID: Lite サブスクリプションの ID
ZONE: Lite サブスクリプションが含まれるゾーンの名前
確定するには「
Y
」と入力します。
リクエストが成功すると、コマンドラインに確認メッセージが表示されます。
Deleted subscription [SUBSCRIPTION_ID].
プロトコル
Lite トピックを削除するには、次のような DELETE
リクエストを送信します。
DELETE https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/ZONE/subscriptions/SUBSCRIPTION_ID Authorization: Bearer $(gcloud auth print-access-token)
以下を置き換えます。
REGION: Lite サブスクリプションを保存するゾーンのリージョン
PROJECT_NUMBER: Lite サブスクリプションを持つプロジェクトのプロジェクト番号
ZONE: Lite サブスクリプションが含まれるゾーンの名前
SUBSCRIPTION_ID: Lite サブスクリプションの ID
リクエストが成功した場合のレスポンスは空の JSON オブジェクトです。
Java
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Java の設定手順を実施してください。
Python
このサンプルを実行する前に、Pub/Sub Lite クライアント ライブラリの Python の設定手順を実施してください。