メソッド:cursor.projects.locations.subscriptions.cursors.list

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

HTTP リクエスト

GET https://{endpoint}/v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors

ここで、{endpoint}サポートされているサービス エンドポイントのいずれかです。

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

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

クエリ パラメータ

パラメータ
pageSize

integer

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

pageToken

string

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

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

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

cursors.listの応答

JSON 表現

{
  "partitionCursors": [
    {
      object (PartitionCursor)
    }
  ],
  "nextPageToken": string
}
項目
partitionCursors[]

object (PartitionCursor)

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

nextPageToken

string

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

認可スコープ

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

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

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

PartitionCursor

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

JSON 表現

{
  "partition": string,
  "cursor": {
    object (Cursor)
  }
}
項目
partition

string (int64 format)

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

cursor

object (Cursor)

カーソルの値。

カーソル

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

JSON 表現

{
  "offset": string
}
項目
offset

string (int64 format)

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