パッケージ google.cloud.pubsublite.v1

索引

AdminService

クライアント アプリケーションがトピックとサブスクリプションの管理(トピックとサブスクリプションの作成、列挙、削除など)に使用するサービス。

CreateSubscription

rpc CreateSubscription(CreateSubscriptionRequest) returns (Subscription)

新しいサブスクリプションを作成します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

CreateTopic

rpc CreateTopic(CreateTopicRequest) returns (Topic)

新しいトピックを作成します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

DeleteSubscription

rpc DeleteSubscription(DeleteSubscriptionRequest) returns (Empty)

指定されたサブスクリプションを削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

DeleteTopic

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

指定されたトピックを削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

GetSubscription

rpc GetSubscription(GetSubscriptionRequest) returns (Subscription)

サブスクリプションの構成を返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

GetTopic

rpc GetTopic(GetTopicRequest) returns (Topic)

トピック構成を返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

GetTopicPartitions

rpc GetTopicPartitions(GetTopicPartitionsRequest) returns (TopicPartitions)

リクエストされたトピックのパーティション情報を返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

ListSubscriptions

rpc ListSubscriptions(ListSubscriptionsRequest) returns (ListSubscriptionsResponse)

指定されたプロジェクトのサブスクリプションのリストを返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

ListTopicSubscriptions

rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest) returns (ListTopicSubscriptionsResponse)

指定したトピックに関連付けられているサブスクリプションを列挙します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

ListTopics

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse)

指定されたプロジェクトのトピックのリストを返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

UpdateSubscription

rpc UpdateSubscription(UpdateSubscriptionRequest) returns (Subscription)

指定されたサブスクリプションのプロパティを更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

UpdateTopic

rpc UpdateTopic(UpdateTopicRequest) returns (Topic)

指定されたトピックのプロパティを更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

CursorService

サブスクライバー クライアント アプリケーションがメッセージの受信中に commit されたカーソルを管理するために使用するサービス。カーソルは、特定のサブスクリプションのトピック パーティション内でのサブスクライバーの進行状況を表します。

CommitCursor

rpc CommitCursor(CommitCursorRequest) returns (CommitCursorResponse)

コミットされたカーソルを更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

ListPartitionCursors

rpc ListPartitionCursors(ListPartitionCursorsRequest) returns (ListPartitionCursorsResponse)

サブスクリプションのすべての commit されたカーソルの情報を返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

StreamingCommitCursor

rpc StreamingCommitCursor(StreamingCommitCursorRequest) returns (StreamingCommitCursorResponse)

commit されたカーソルを管理するためのサーバーとのストリームを確立します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

PublisherService

パブリッシャー クライアント アプリケーションがメッセージをトピックにパブリッシュするために使用するサービス。パブリッシュされたメッセージは、それぞれのトピックに構成された保持期間中、サービスによって保持され、リクエストに応じてサブスクライバー クライアントに配信されます(SubscriberService を介して)。

公開

rpc Publish(PublishRequest) returns (PublishResponse)

メッセージをパブリッシュするためのサーバーとのストリームを確立します。ストリームが初期化されると、クライアントはストリームでパブリッシュ リクエストを送信してメッセージをパブリッシュします。サーバーは、クライアントから送信された PublishRequest ごとに、リクエストが送信された順序で PublishResponse で応答します。複数の PublishRequest を同時に処理することもできますが、これらは指定したストリームでクライアントにより送信された順序でサーバーが処理することに注意してください。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

SubscriberService

サブスクライバー クライアント アプリケーションがサブスクリプションからメッセージを受信するために使用するサービス。

登録

rpc Subscribe(SubscribeRequest) returns (SubscribeResponse)

メッセージを受信するためのサーバーとのストリームを確立します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

AttributeValues

属性のキーに関連付けられた値。

項目
values[]

bytes

キーに関連付けられた値のリスト。

CommitCursorRequest

CommitCursor のリクエスト。

項目
subscription

string

カーソルを更新するサブスクリプション。

partition

int64

カーソルを更新するパーティション。パーティションはゼロから始まるため、partition は [0, topic.num_partitions) の範囲内にある必要があります。

cursor

Cursor

commit されたカーソルの新しい値。

CommitCursorResponse

CommitCursor に対するレスポンス。

CreateSubscriptionRequest

CreateSubscription のリクエスト。

項目
parent

string

必須。サブスクリプションを作成する親の場所。projects/{project_number}/locations/{location} のような構造になっています。

subscription

Subscription

必須。作成するサブスクリプションの構成。name フィールドは無視されます。

subscription_id

string

必須。サブスクリプションに使用する ID。これはサブスクリプション名の最終的なコンポーネントになります。

この値は my-sub-name のような構造になっています。

CreateTopicRequest

CreateTopic のリクエスト。

項目
parent

string

必須。トピックを作成する親の場所。projects/{project_number}/locations/{location} のような構造になっています。

topic

Topic

必須。作成するトピックの構成。name フィールドは無視されます。

topic_id

string

必須。トピックに使用する ID。これはトピック名の最終的なコンポーネントになります。

この値は my-topic-name のような構造になっています。

カーソル

トピック パーティション内のメッセージの位置を記述するカーソル。

項目
offset

int64

トピック パーティション内のメッセージのオフセット。0 以上である必要があります。

DeleteSubscriptionRequest

DeleteSubscription のリクエスト。

項目
name

string

必須。削除するサブスクリプションの名前。

DeleteTopicRequest

DeleteTopic のリクエスト。

項目
name

string

必須。削除するトピックの名前。

FlowControlRequest

サーバーへのトークンの付与をリクエストし、使用可能になったときにメッセージの配信をリクエストします。

項目
allowed_messages

int64

付与するメッセージ トークンの数。0 以上で指定します。

allowed_bytes

int64

付与するバイトのトークンの数。0 以上で指定します。

GetSubscriptionRequest

GetSubscription のリクエスト。

項目
name

string

必須。構成を返すサブスクリプションの名前。

GetTopicPartitionsRequest

GetTopicPartitions のリクエスト。

項目
name

string

必須。そのパーティション情報を返すトピック。

GetTopicRequest

GetTopic のリクエスト。

項目
name

string

必須。その構成を返すトピックの名前。

InitialCommitCursorRequest

新しく開いたストリームで送信される必要がある最初のストリーミング リクエスト。クライアントは、ストリームで後続のリクエストを送信する前に、レスポンスを待機する必要があります。

項目
subscription

string

commit されたカーソルを管理するサブスクリプション。

partition

int64

commit されたカーソルを管理するパーティション。パーティションはゼロから始まるため、partition は [0, topic.num_partitions) の範囲内にある必要があります。

InitialCommitCursorResponse

InitialCommitCursorRequest へのレスポンス。

InitialPublishRequest

新しく開いたストリームで送信される必要がある最初のリクエスト。

項目
topic

string

メッセージが書き込まれるトピック。

partition

int64

メッセージが書き込まれるトピック内のパーティション。パーティションはゼロから始まるため、partition は [0, topic.num_partitions) の範囲内にある必要があります。

InitialPublishResponse

InitialPublishRequest へのレスポンス。

InitialSubscribeRequest

新しく開いたストリームで送信される必要がある最初のリクエスト。クライアントは、ストリームで後続のリクエストを送信する前に、レスポンスを待機する必要があります。

項目
subscription

string

メッセージの受信元のサブスクリプション。

partition

int64

メッセージの受信元のパーティション。パーティションはゼロから始まるため、partition は [0, topic.num_partitions) の範囲内にある必要があります。

InitialSubscribeResponse

InitialSubscribeRequest へのレスポンス。

項目
cursor

Cursor

フロー制御トークンが使用可能になったときにサブスクライバーがメッセージの受信を開始するカーソル。

ListPartitionCursorsRequest

ListPartitionCursor のリクエスト。

項目
parent

string

必須。カーソルを取得するサブスクリプション。projects/{project_number}/locations/{location}/subscriptions/{subscription_id} のような構造になっています。

page_size

int32

返されるカーソルの最大数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのカーソルが返されます。

page_token

string

前回の ListPartitionCursors 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分割を行う場合、ListPartitionCursors に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListPartitionCursorsResponse

ListPartitionCursor のレスポンス

項目
partition_cursors[]

PartitionCursor

このリクエストからのパーティション カーソル。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSubscriptionsRequest

ListSubscriptions のリクエスト。

項目
parent

string

必須。リストするサブスクリプションの親。projects/{project_number}/locations/{location} のような構造になっています。

page_size

int32

返されるサブスクリプションの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのサブスクリプションが返されます。

page_token

string

前回の ListSubscriptions 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分割を行う場合、ListSubscriptions に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListSubscriptionsResponse

ListSubscriptions のレスポンス。

項目
subscriptions[]

Subscription

リクエストされた親のサブスクリプションのリスト。サブスクリプションの順序は指定されていません。

next_page_token

string

結果の次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、それ以上結果は取得されません。

ListTopicSubscriptionsRequest

ListTopicSubscriptions のリクエスト。

項目
name

string

必須。サブスクリプションを列挙するトピックの名前。

page_size

int32

返されるサブスクリプションの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、指定したトピックのすべてのサブスクリプションが返されます。

page_token

string

前回の ListTopicSubscriptions 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分割を行う場合、ListTopicSubscriptions に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListTopicSubscriptionsResponse

ListTopicSubscriptions に対するレスポンス。

項目
subscriptions[]

string

トピックに関連付けられているサブスクリプションの名前。サブスクリプションの順序は指定されていません。

next_page_token

string

結果の次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、それ以上結果は取得されません。

ListTopicsRequest

ListTopics のリクエスト。

項目
parent

string

必須。リストするトピックの親。projects/{project_number}/locations/{location} のような構造になっています。

page_size

int32

返されるトピックの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのトピックが返されます。

page_token

string

前回の ListTopics 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得します。

ページ分割を行う場合、ListTopics に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListTopicsResponse

ListTopics のレスポンス。

項目
topics[]

Topic

リクエストされた親のトピックのリスト。トピックの順序は指定されません。

next_page_token

string

結果の次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、それ以上結果は取得されません。

MessagePublishRequest

トピックにメッセージをパブリッシュするリクエスト。

項目
messages[]

PubSubMessage

MessagePublishResponse

MessagePublishRequest へのレスポンス。

項目
start_cursor

Cursor

バッチ内で最初にパブリッシュされたメッセージのカーソル。バッチ内の残りのメッセージのカーソルは順次的であることが保証されます。

MessageResponse

メッセージのリストを含むレスポンス。MessageResponse をクライアントに配信する際に、サーバーは次のことを行います。* ストリームの配信カーソルを、リストにある最後のメッセージのカーソルよりも大きいものに更新します。* サーバーで使用可能なトークンから合計バイト数とメッセージ数を差し引きます。

項目
messages[]

SequencedMessage

トピック パーティションからのメッセージ。

PartitionCursor

Cursor のペアとそのパーティション。

項目
partition

int64

対象となるパーティション。

cursor

Cursor

カーソルの値。

PubSubMessage

パブリッシャーによってパブリッシュされ、サブスクライバーに配信されるメッセージ。

項目
key

bytes

パーティションへのメッセージのルーティングやコンパクションに使用されるキー(たとえば、キーごとに最後の n 個のメッセージを保持します)。キーが空の場合、メッセージは任意のパーティションにルーティングされます。

data

bytes

メッセージのペイロード。

attributes

map<string, AttributeValues>

メッセージのメタデータまたはヘッダーに使用できるオプション属性。

event_time

Timestamp

ユーザー指定のイベント時間(オプション)。

PublishRequest

ストリームでクライアントからサーバーに送信されるリクエスト。

項目

共用体フィールド request_type

request_type は次のいずれかになります。

initial_request

InitialPublishRequest

ストリームでの最初のリクエスト。

message_publish_request

MessagePublishRequest

メッセージのパブリッシュをリクエストします。

PublishResponse

PublishRequest へのレスポンス。

項目

共用体フィールド response_type

response_type は次のいずれかになります。

initial_response

InitialPublishResponse

ストリームでの最初のレスポンス。

message_response

MessagePublishResponse

メッセージのパブリッシュに対するレスポンス。

SeekRequest

指定されたターゲットに基づいてストリームの配信カーソルを更新するリクエスト。サーバーで使用可能なトークンを 0 にリセットします。同じストリームで別の SeekRequests が未処理の場合(つまり、SeekResponse を受信していない場合)は、SeekRequests が送信されない可能性があります。SeekRequests が上限を超えると、ストリームが中断されます。

項目
共用体フィールド target。シークするターゲットです。これは設定する必要があります。target は次のいずれかになります。
named_target

NamedTarget

名前付きターゲット。

cursor

Cursor

カーソルに対応するターゲット。トピック パーティション内の任意の場所を指します。

NamedTarget

他のパラメータを受け取らないパーティション内の特別なターゲット。

列挙型
NAMED_TARGET_UNSPECIFIED デフォルト値。この値は使用されません。
HEAD パーティション内で最も最近パブリッシュされたメッセージに対応するターゲット。
COMMITTED_CURSOR 指定されたサブスクリプションとトピック パーティションの commit されたカーソルに対応するターゲット。

SeekResponse

SeekRequest へのレスポンス。

項目
cursor

Cursor

現在のストリームの新しい配信カーソル。

SequencedCommitCursorRequest

commit されたカーソルを更新するストリーミング リクエスト。後続の SequencedCommitCursorRequest は未処理のリクエストをオーバーライドします。

項目
cursor

Cursor

commit されたカーソルの新しい値。

SequencedCommitCursorResponse

SequencedCommitCursorRequest に対するレスポンス。

項目
acknowledged_commits

int64

このレスポンスによって確認された未処理の SequencedCommitCursorRequest の数。SequencedCommitCursorRequests は、受信された順に確認されます。

SequencedMessage

項目
cursor

Cursor

メッセージが格納されているパーティション内での位置。

publish_time

Timestamp

メッセージが最初にパブリッシュされたときにサーバーが受信した時刻。

message

PubSubMessage

ユーザー メッセージ。

size_bytes

int64

フロー制御と割り当てを目的としたこのメッセージのサイズ(バイト単位)。

StreamingCommitCursorRequest

ストリームでクライアントからサーバーに送信されるリクエスト。

項目

共用体フィールド request

request は次のいずれかになります。

initial

InitialCommitCursorRequest

ストリームでの最初のリクエスト。

commit

SequencedCommitCursorRequest

新しいカーソル値を commit するリクエスト。

StreamingCommitCursorResponse

StreamingCommitCursorRequest へのレスポンス。

項目

共用体フィールド request

request は次のいずれかになります。

initial

InitialCommitCursorResponse

ストリームでの最初のレスポンス。

commit

SequencedCommitCursorResponse

新しいカーソル値を commit するレスポンス。

SubscribeRequest

ストリームでクライアントからサーバーに送信されるリクエスト。

項目

共用体フィールド request

request は次のいずれかになります。

initial

InitialSubscribeRequest

ストリームでの最初のリクエスト。

seek

SeekRequest

ストリームの配信カーソルを更新するリクエスト。

flow_control

FlowControlRequest

サーバーへのトークンの付与をリクエストします。

SubscribeResponse

SubscribeRequest へのレスポンス。

項目

共用体フィールド response

response は次のいずれかになります。

initial

InitialSubscribeResponse

ストリームでの最初のレスポンス。

seek

SeekResponse

Seek オペレーションへのレスポンス。

messages

MessageResponse

トピック パーティションからのメッセージを含むレスポンス。

登録

サブスクリプション リソースに関するメタデータ。

項目
name

string

サブスクリプションの名前。 次のような構造になっています: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

topic

string

このサブスクリプションが関連付けられたトピックの名前。次のような構造になっています。projects/{project_number}/locations/{location}/topics/{topic_id}

delivery_config

DeliveryConfig

このサブスクリプションのメッセージ配信の設定。

DeliveryConfig

サブスクリプションのメッセージ配信の設定。

項目
delivery_requirement

DeliveryRequirement

このサブスクリプションの DeliveryRequirement。

DeliveryRequirement

このサブスクリプションが、ストレージ内のメッセージの永続性に関連して、サブスクライバーにメッセージを送信するタイミング。 詳しくは、Lite サブスクリプションの作成をご覧ください。

列挙型
DELIVERY_REQUIREMENT_UNSPECIFIED デフォルト値。この値は使用されません。
DELIVER_IMMEDIATELY サーバーは、サブスクライバーに配信される前に、パブリッシュされたメッセージが正常にストレージに書き込まれるのを待機しません。
DELIVER_AFTER_STORED サーバーは、メッセージがストレージに正常に書き込まれるまで、パブリッシュされたメッセージをサブスクライバーに配信しません。これにより、エンドツーエンドのレイテンシが高くなりますが、一貫性のある配信が行われます。

トピック

トピック リソースに関するメタデータ。

項目
name

string

トピックの名前。次のような構造になっています。projects/{project_number}/locations/{location}/topics/{topic_id}

partition_config

PartitionConfig

このトピックのパーティションの設定。

retention_config

RetentionConfig

このトピックのメッセージ保持期間の設定。

PartitionConfig

トピックのパーティションの設定。

項目
count

int64

トピック内のパーティションの数。1 以上の値を指定してください。

scale

int32

トピック内のすべてのパーティションに、標準パーティション スループット(4 MiB/秒)の scale 倍に相当するスループットが割り当てられます。これは、このトピックの費用にも反映されます。scaleが 2 で、count が 10 のトピックは、20 パーティションに対して課金されます。この値は [1,4] の範囲内である必要があります。

RetentionConfig

トピックのメッセージ保持期間の設定。

項目
per_partition_bytes

int64

パーティションごとにプロビジョニングされたストレージ(バイト単位)。トピックのいずれかのパーティションに格納されているバイト数がこの値を超えると、period の値に関係なく、新しいメッセージ用の場所を確保するために古いメッセージが破棄されます。

period

Duration

パブリッシュされたメッセージの保持時間。設定しない場合、各パーティションの保持バイト数が per_partition_bytes 未満である限り、メッセージは保持されます。

TopicPartitions

GetTopicPartitions に対するレスポンス。

項目
partition_count

int64

トピック内のパーティションの数。

UpdateSubscriptionRequest

UpdateSubscription のリクエスト。

項目
subscription

Subscription

必須。更新するサブスクリプション。name フィールドに入力する必要があります。トピック フィールドには入力しないでください。

update_mask

FieldMask

必須。変更するサブスクリプション フィールドを指定するマスク。

UpdateTopicRequest

UpdateTopic のリクエスト。

項目
topic

Topic

必須。更新するトピック。name フィールドに入力する必要があります。

update_mask

FieldMask

必須。変更するトピック フィールドを指定するマスク。