- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- PartitionCursor
- Cursor
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 |
Obrigatório. A assinatura para a qual os cursores serão recuperados. Estruturado como |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
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 |
Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
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 ( |
Campos | |
---|---|
partitionCursors[] |
Os cursores de partição dessa solicitação. |
nextPageToken |
Um token, que pode ser enviado como |
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 ( |
Campos | |
---|---|
partition |
A partição para a qual se destina. |
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 |
O deslocamento de uma mensagem em uma partição de tópico. Precisa ser maior ou igual a 0. |