Método: cursor.projects.locations.subscriptions.cursors.list

Retorna todas as informações do cursor confirmado para uma assinatura.

Solicitação HTTP

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

Em que {endpoint} é um dos endpoints de serviço compatíveis.

Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. A assinatura para a qual os cursores serão recuperados. Estruturado como projects/{project_number}/locations/{location}/subscriptions/{subscriptionId}.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de cursores a serem retornados. O serviço pode retornar menos que esse valor. Se não for definido ou for zero, todos os cursores do pai serão retornados.

pageToken

string

Um token de página recebido de uma chamada cursors.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para cursors.list precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Resposta para cursors.list

Representação JSON

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

object (PartitionCursor)

Os cursores de partição dessa solicitação.

nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

PartitionCursor

Um par de um Cursor e a partição para a qual ele se destina.

Representação JSON

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

string (int64 format)

A partição para a qual se destina.

cursor

object (Cursor)

O valor do cursor.

Cursor

Um cursor que descreve a posição de uma mensagem dentro de uma partição de tópico.

Representação JSON

{
  "offset": string
}
Campos
offset

string (int64 format)

O deslocamento de uma mensagem em uma partição de tópico. Precisa ser maior ou igual a 0.