索引
AdminService
(インターフェース)CursorService
(インターフェース)PublisherService
(インターフェース)SubscriberService
(インターフェース)AttributeValues
(メッセージ)CommitCursorRequest
(メッセージ)CommitCursorResponse
(メッセージ)CreateSubscriptionRequest
(メッセージ)CreateTopicRequest
(メッセージ)Cursor
(メッセージ)DeleteSubscriptionRequest
(メッセージ)DeleteTopicRequest
(メッセージ)FlowControlRequest
(メッセージ)GetSubscriptionRequest
(メッセージ)GetTopicPartitionsRequest
(メッセージ)GetTopicRequest
(メッセージ)InitialCommitCursorRequest
(メッセージ)InitialCommitCursorResponse
(メッセージ)InitialPublishRequest
(メッセージ)InitialPublishResponse
(メッセージ)InitialSubscribeRequest
(メッセージ)InitialSubscribeResponse
(メッセージ)ListPartitionCursorsRequest
(メッセージ)ListPartitionCursorsResponse
(メッセージ)ListSubscriptionsRequest
(メッセージ)ListSubscriptionsResponse
(メッセージ)ListTopicSubscriptionsRequest
(メッセージ)ListTopicSubscriptionsResponse
(メッセージ)ListTopicsRequest
(メッセージ)ListTopicsResponse
(メッセージ)MessagePublishRequest
(メッセージ)MessagePublishResponse
(メッセージ)MessageResponse
(メッセージ)PartitionCursor
(メッセージ)PubSubMessage
(メッセージ)PublishRequest
(メッセージ)PublishResponse
(メッセージ)SeekRequest
(メッセージ)SeekRequest.NamedTarget
(enum)SeekResponse
(メッセージ)SequencedCommitCursorRequest
(メッセージ)SequencedCommitCursorResponse
(メッセージ)SequencedMessage
(メッセージ)StreamingCommitCursorRequest
(メッセージ)StreamingCommitCursorResponse
(メッセージ)SubscribeRequest
(メッセージ)SubscribeResponse
(メッセージ)Subscription
(メッセージ)Subscription.DeliveryConfig
(メッセージ)Subscription.DeliveryConfig.DeliveryRequirement
(enum)Topic
(メッセージ)Topic.PartitionConfig
(メッセージ)Topic.RetentionConfig
(メッセージ)TopicPartitions
(メッセージ)UpdateSubscriptionRequest
(メッセージ)UpdateTopicRequest
(メッセージ)
AdminService
クライアント アプリケーションがトピックとサブスクリプションの管理(トピックとサブスクリプションの作成、列挙、削除など)に使用するサービス。
CreateSubscription | |
---|---|
新しいサブスクリプションを作成します。
|
CreateTopic | |
---|---|
新しいトピックを作成します。
|
DeleteSubscription | |
---|---|
指定されたサブスクリプションを削除します。
|
DeleteTopic | |
---|---|
指定されたトピックを削除します。
|
GetSubscription | |
---|---|
サブスクリプションの構成を返します。
|
GetTopic | |
---|---|
トピック構成を返します。
|
GetTopicPartitions | |
---|---|
リクエストされたトピックのパーティション情報を返します。
|
ListSubscriptions | |
---|---|
指定されたプロジェクトのサブスクリプションのリストを返します。
|
ListTopicSubscriptions | |
---|---|
指定したトピックに関連付けられているサブスクリプションを列挙します。
|
ListTopics | |
---|---|
指定されたプロジェクトのトピックのリストを返します。
|
UpdateSubscription | |
---|---|
指定されたサブスクリプションのプロパティを更新します。
|
UpdateTopic | |
---|---|
指定されたトピックのプロパティを更新します。
|
CursorService
サブスクライバー クライアント アプリケーションがメッセージの受信中に commit されたカーソルを管理するために使用するサービス。カーソルは、特定のサブスクリプションのトピック パーティション内でのサブスクライバーの進行状況を表します。
CommitCursor | |
---|---|
コミットされたカーソルを更新します。
|
ListPartitionCursors | |
---|---|
サブスクリプションのすべての commit されたカーソルの情報を返します。
|
StreamingCommitCursor | |
---|---|
commit されたカーソルを管理するためのサーバーとのストリームを確立します。
|
PublisherService
パブリッシャー クライアント アプリケーションがメッセージをトピックにパブリッシュするために使用するサービス。パブリッシュされたメッセージは、それぞれのトピックに構成された保持期間中、サービスによって保持され、リクエストに応じてサブスクライバー クライアントに配信されます(SubscriberService
を介して)。
公開 | |
---|---|
メッセージをパブリッシュするためのサーバーとのストリームを確立します。ストリームが初期化されると、クライアントはストリームでパブリッシュ リクエストを送信してメッセージをパブリッシュします。サーバーは、クライアントから送信された PublishRequest ごとに、リクエストが送信された順序で PublishResponse で応答します。複数の PublishRequest を同時に処理することもできますが、これらは指定したストリームでクライアントにより送信された順序でサーバーが処理することに注意してください。
|
SubscriberService
サブスクライバー クライアント アプリケーションがサブスクリプションからメッセージを受信するために使用するサービス。
登録 | |
---|---|
メッセージを受信するためのサーバーとのストリームを確立します。
|
AttributeValues
属性のキーに関連付けられた値。
項目 | |
---|---|
values[] |
キーに関連付けられた値のリスト。 |
CommitCursorRequest
CommitCursor のリクエスト。
項目 | |
---|---|
subscription |
カーソルを更新するサブスクリプション。 |
partition |
カーソルを更新するパーティション。パーティションはゼロから始まるため、 |
cursor |
commit されたカーソルの新しい値。 |
CommitCursorResponse
CommitCursor に対するレスポンス。
CreateSubscriptionRequest
CreateSubscription のリクエスト。
項目 | |
---|---|
parent |
必須。サブスクリプションを作成する親の場所。 |
subscription |
必須。作成するサブスクリプションの構成。 |
subscription_id |
必須。サブスクリプションに使用する ID。これはサブスクリプション名の最終的なコンポーネントになります。 この値は |
CreateTopicRequest
CreateTopic のリクエスト。
項目 | |
---|---|
parent |
必須。トピックを作成する親の場所。 |
topic |
必須。作成するトピックの構成。 |
topic_id |
必須。トピックに使用する ID。これはトピック名の最終的なコンポーネントになります。 この値は |
カーソル
トピック パーティション内のメッセージの位置を記述するカーソル。
項目 | |
---|---|
offset |
トピック パーティション内のメッセージのオフセット。0 以上である必要があります。 |
DeleteSubscriptionRequest
DeleteSubscription のリクエスト。
項目 | |
---|---|
name |
必須。削除するサブスクリプションの名前。 |
DeleteTopicRequest
DeleteTopic のリクエスト。
項目 | |
---|---|
name |
必須。削除するトピックの名前。 |
FlowControlRequest
サーバーへのトークンの付与をリクエストし、使用可能になったときにメッセージの配信をリクエストします。
項目 | |
---|---|
allowed_messages |
付与するメッセージ トークンの数。0 以上で指定します。 |
allowed_bytes |
付与するバイトのトークンの数。0 以上で指定します。 |
GetSubscriptionRequest
GetSubscription のリクエスト。
項目 | |
---|---|
name |
必須。構成を返すサブスクリプションの名前。 |
GetTopicPartitionsRequest
GetTopicPartitions のリクエスト。
項目 | |
---|---|
name |
必須。そのパーティション情報を返すトピック。 |
GetTopicRequest
GetTopic のリクエスト。
項目 | |
---|---|
name |
必須。その構成を返すトピックの名前。 |
InitialCommitCursorRequest
新しく開いたストリームで送信される必要がある最初のストリーミング リクエスト。クライアントは、ストリームで後続のリクエストを送信する前に、レスポンスを待機する必要があります。
項目 | |
---|---|
subscription |
commit されたカーソルを管理するサブスクリプション。 |
partition |
commit されたカーソルを管理するパーティション。パーティションはゼロから始まるため、 |
InitialCommitCursorResponse
InitialCommitCursorRequest へのレスポンス。
InitialPublishRequest
新しく開いたストリームで送信される必要がある最初のリクエスト。
項目 | |
---|---|
topic |
メッセージが書き込まれるトピック。 |
partition |
メッセージが書き込まれるトピック内のパーティション。パーティションはゼロから始まるため、 |
InitialPublishResponse
InitialPublishRequest へのレスポンス。
InitialSubscribeRequest
新しく開いたストリームで送信される必要がある最初のリクエスト。クライアントは、ストリームで後続のリクエストを送信する前に、レスポンスを待機する必要があります。
項目 | |
---|---|
subscription |
メッセージの受信元のサブスクリプション。 |
partition |
メッセージの受信元のパーティション。パーティションはゼロから始まるため、 |
InitialSubscribeResponse
InitialSubscribeRequest へのレスポンス。
項目 | |
---|---|
cursor |
フロー制御トークンが使用可能になったときにサブスクライバーがメッセージの受信を開始するカーソル。 |
ListPartitionCursorsRequest
ListPartitionCursor のリクエスト。
項目 | |
---|---|
parent |
必須。カーソルを取得するサブスクリプション。 |
page_size |
返されるカーソルの最大数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのカーソルが返されます。 |
page_token |
前回の ページ分割を行う場合、 |
ListPartitionCursorsResponse
ListPartitionCursor のレスポンス
項目 | |
---|---|
partition_cursors[] |
このリクエストからのパーティション カーソル。 |
next_page_token |
次のページを取得するために |
ListSubscriptionsRequest
ListSubscriptions のリクエスト。
項目 | |
---|---|
parent |
必須。リストするサブスクリプションの親。 |
page_size |
返されるサブスクリプションの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのサブスクリプションが返されます。 |
page_token |
前回の ページ分割を行う場合、 |
ListSubscriptionsResponse
ListSubscriptions のレスポンス。
項目 | |
---|---|
subscriptions[] |
リクエストされた親のサブスクリプションのリスト。サブスクリプションの順序は指定されていません。 |
next_page_token |
結果の次のページを取得するために |
ListTopicSubscriptionsRequest
ListTopicSubscriptions のリクエスト。
項目 | |
---|---|
name |
必須。サブスクリプションを列挙するトピックの名前。 |
page_size |
返されるサブスクリプションの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、指定したトピックのすべてのサブスクリプションが返されます。 |
page_token |
前回の ページ分割を行う場合、 |
ListTopicSubscriptionsResponse
ListTopicSubscriptions に対するレスポンス。
項目 | |
---|---|
subscriptions[] |
トピックに関連付けられているサブスクリプションの名前。サブスクリプションの順序は指定されていません。 |
next_page_token |
結果の次のページを取得するために |
ListTopicsRequest
ListTopics のリクエスト。
項目 | |
---|---|
parent |
必須。リストするトピックの親。 |
page_size |
返されるトピックの最大件数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのトピックが返されます。 |
page_token |
前回の ページ分割を行う場合、 |
ListTopicsResponse
ListTopics のレスポンス。
項目 | |
---|---|
topics[] |
リクエストされた親のトピックのリスト。トピックの順序は指定されません。 |
next_page_token |
結果の次のページを取得するために |
MessagePublishRequest
トピックにメッセージをパブリッシュするリクエスト。
項目 | |
---|---|
messages[] |
MessagePublishResponse
MessagePublishRequest へのレスポンス。
項目 | |
---|---|
start_cursor |
バッチ内で最初にパブリッシュされたメッセージのカーソル。バッチ内の残りのメッセージのカーソルは順次的であることが保証されます。 |
MessageResponse
メッセージのリストを含むレスポンス。MessageResponse をクライアントに配信する際に、サーバーは次のことを行います。* ストリームの配信カーソルを、リストにある最後のメッセージのカーソルよりも大きいものに更新します。* サーバーで使用可能なトークンから合計バイト数とメッセージ数を差し引きます。
項目 | |
---|---|
messages[] |
トピック パーティションからのメッセージ。 |
PartitionCursor
Cursor のペアとそのパーティション。
項目 | |
---|---|
partition |
対象となるパーティション。 |
cursor |
カーソルの値。 |
PubSubMessage
パブリッシャーによってパブリッシュされ、サブスクライバーに配信されるメッセージ。
項目 | |
---|---|
key |
パーティションへのメッセージのルーティングやコンパクションに使用されるキー(たとえば、キーごとに最後の n 個のメッセージを保持します)。キーが空の場合、メッセージは任意のパーティションにルーティングされます。 |
data |
メッセージのペイロード。 |
attributes |
メッセージのメタデータまたはヘッダーに使用できるオプション属性。 |
event_time |
ユーザー指定のイベント時間(オプション)。 |
PublishRequest
ストリームでクライアントからサーバーに送信されるリクエスト。
項目 | ||
---|---|---|
共用体フィールド
|
||
initial_request |
ストリームでの最初のリクエスト。 |
|
message_publish_request |
メッセージのパブリッシュをリクエストします。 |
PublishResponse
PublishRequest へのレスポンス。
項目 | ||
---|---|---|
共用体フィールド
|
||
initial_response |
ストリームでの最初のレスポンス。 |
|
message_response |
メッセージのパブリッシュに対するレスポンス。 |
SeekRequest
指定されたターゲットに基づいてストリームの配信カーソルを更新するリクエスト。サーバーで使用可能なトークンを 0 にリセットします。同じストリームで別の SeekRequests が未処理の場合(つまり、SeekResponse を受信していない場合)は、SeekRequests が送信されない可能性があります。SeekRequests が上限を超えると、ストリームが中断されます。
項目 | ||
---|---|---|
共用体フィールド target 。シークするターゲットです。これは設定する必要があります。target は次のいずれかになります。 |
||
named_target |
名前付きターゲット。 |
|
cursor |
カーソルに対応するターゲット。トピック パーティション内の任意の場所を指します。 |
NamedTarget
他のパラメータを受け取らないパーティション内の特別なターゲット。
列挙型 | |
---|---|
NAMED_TARGET_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
HEAD |
パーティション内で最も最近パブリッシュされたメッセージに対応するターゲット。 |
COMMITTED_CURSOR |
指定されたサブスクリプションとトピック パーティションの commit されたカーソルに対応するターゲット。 |
SeekResponse
SeekRequest へのレスポンス。
項目 | |
---|---|
cursor |
現在のストリームの新しい配信カーソル。 |
SequencedCommitCursorRequest
commit されたカーソルを更新するストリーミング リクエスト。後続の SequencedCommitCursorRequest は未処理のリクエストをオーバーライドします。
項目 | |
---|---|
cursor |
commit されたカーソルの新しい値。 |
SequencedCommitCursorResponse
SequencedCommitCursorRequest に対するレスポンス。
項目 | |
---|---|
acknowledged_commits |
このレスポンスによって確認された未処理の SequencedCommitCursorRequest の数。SequencedCommitCursorRequests は、受信された順に確認されます。 |
SequencedMessage
項目 | |
---|---|
cursor |
メッセージが格納されているパーティション内での位置。 |
publish_time |
メッセージが最初にパブリッシュされたときにサーバーが受信した時刻。 |
message |
ユーザー メッセージ。 |
size_bytes |
フロー制御と割り当てを目的としたこのメッセージのサイズ(バイト単位)。 |
StreamingCommitCursorRequest
ストリームでクライアントからサーバーに送信されるリクエスト。
項目 | ||
---|---|---|
共用体フィールド
|
||
initial |
ストリームでの最初のリクエスト。 |
|
commit |
新しいカーソル値を commit するリクエスト。 |
StreamingCommitCursorResponse
StreamingCommitCursorRequest へのレスポンス。
項目 | ||
---|---|---|
共用体フィールド
|
||
initial |
ストリームでの最初のレスポンス。 |
|
commit |
新しいカーソル値を commit するレスポンス。 |
SubscribeRequest
ストリームでクライアントからサーバーに送信されるリクエスト。
項目 | ||
---|---|---|
共用体フィールド
|
||
initial |
ストリームでの最初のリクエスト。 |
|
seek |
ストリームの配信カーソルを更新するリクエスト。 |
|
flow_control |
サーバーへのトークンの付与をリクエストします。 |
SubscribeResponse
SubscribeRequest へのレスポンス。
項目 | ||
---|---|---|
共用体フィールド
|
||
initial |
ストリームでの最初のレスポンス。 |
|
seek |
Seek オペレーションへのレスポンス。 |
|
messages |
トピック パーティションからのメッセージを含むレスポンス。 |
登録
サブスクリプション リソースに関するメタデータ。
項目 | |
---|---|
name |
サブスクリプションの名前。 次のような構造になっています: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
topic |
このサブスクリプションが関連付けられたトピックの名前。次のような構造になっています。projects/{project_number}/locations/{location}/topics/{topic_id} |
delivery_config |
このサブスクリプションのメッセージ配信の設定。 |
DeliveryConfig
サブスクリプションのメッセージ配信の設定。
項目 | |
---|---|
delivery_requirement |
このサブスクリプションの DeliveryRequirement。 |
DeliveryRequirement
このサブスクリプションが、ストレージ内のメッセージの永続性に関連して、サブスクライバーにメッセージを送信するタイミング。 詳しくは、Lite サブスクリプションの作成をご覧ください。
列挙型 | |
---|---|
DELIVERY_REQUIREMENT_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
DELIVER_IMMEDIATELY |
サーバーは、サブスクライバーに配信される前に、パブリッシュされたメッセージが正常にストレージに書き込まれるのを待機しません。 |
DELIVER_AFTER_STORED |
サーバーは、メッセージがストレージに正常に書き込まれるまで、パブリッシュされたメッセージをサブスクライバーに配信しません。これにより、エンドツーエンドのレイテンシが高くなりますが、一貫性のある配信が行われます。 |
トピック
トピック リソースに関するメタデータ。
項目 | |
---|---|
name |
トピックの名前。次のような構造になっています。projects/{project_number}/locations/{location}/topics/{topic_id} |
partition_config |
このトピックのパーティションの設定。 |
retention_config |
このトピックのメッセージ保持期間の設定。 |
PartitionConfig
トピックのパーティションの設定。
項目 | |
---|---|
count |
トピック内のパーティションの数。1 以上の値を指定してください。 |
scale |
トピック内のすべてのパーティションに、標準パーティション スループット(4 MiB/秒)の |
RetentionConfig
トピックのメッセージ保持期間の設定。
項目 | |
---|---|
per_partition_bytes |
パーティションごとにプロビジョニングされたストレージ(バイト単位)。トピックのいずれかのパーティションに格納されているバイト数がこの値を超えると、 |
period |
パブリッシュされたメッセージの保持時間。設定しない場合、各パーティションの保持バイト数が |
TopicPartitions
GetTopicPartitions に対するレスポンス。
項目 | |
---|---|
partition_count |
トピック内のパーティションの数。 |
UpdateSubscriptionRequest
UpdateSubscription のリクエスト。
項目 | |
---|---|
subscription |
必須。更新するサブスクリプション。 |
update_mask |
必須。変更するサブスクリプション フィールドを指定するマスク。 |
UpdateTopicRequest
UpdateTopic のリクエスト。
項目 | |
---|---|
topic |
必須。更新するトピック。 |
update_mask |
必須。変更するトピック フィールドを指定するマスク。 |