サブスクリプションのすべてのコミットされたカーソル情報を返します。
HTTP リクエスト
GET https://{endpoint}/v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors
ここで、{endpoint}
はサポートされているサービス エンドポイントのいずれかです。
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。カーソルを取得するサブスクリプション。 |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
返されるカーソルの最大数。サービスはこの値より少ない値を返すことがあります。未設定またはゼロの場合、親のすべてのカーソルが返されます。 |
pageToken |
前回の ページ分割を行う場合、 |
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
cursors.listの応答
JSON 表現 | |
---|---|
{
"partitionCursors": [
{
object ( |
項目 | |
---|---|
partitionCursors[] |
このリクエストからのパーティション カーソル。 |
nextPageToken |
次のページを取得するために |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要をご覧ください。
PartitionCursor
Cursor のペアとそのパーティション。
JSON 表現 | |
---|---|
{
"partition": string,
"cursor": {
object ( |
項目 | |
---|---|
partition |
対象となるパーティション。 |
cursor |
カーソルの値。 |
カーソル
トピック パーティション内のメッセージの位置を記述するカーソル。
JSON 表現 | |
---|---|
{ "offset": string } |
項目 | |
---|---|
offset |
トピック パーティション内のメッセージのオフセット。0 以上である必要があります。 |