Este documento apresenta uma visão geral de uma assinatura por pull, do fluxo de trabalho dela e das propriedades associadas.
Em uma assinatura pull, um cliente assinante solicita mensagens do servidor do Pub/Sub.
O modo pull pode usar uma das duas APIs de serviço, Pull ou StreamingPull. Para executar a API escolhida, selecione uma biblioteca de cliente de alto nível fornecida pelo Google ou uma biblioteca de cliente de baixo nível gerada automaticamente. Você também pode escolher entre o processamento de mensagens assíncrono e síncrono.
Antes de começar
Antes de ler este documento, confira se você conhece os seguintes conceitos:
Como o Pub/Sub funciona e os diferentes termos do Pub/Sub.
Os diferentes tipos de assinaturas que o Pub/Sub aceita e por que você pode querer usar uma assinatura de extração.
Fluxo de trabalho de assinatura de pull
Em uma assinatura de pull, o cliente assinante inicia solicitações para um servidor do Pub/Sub para recuperar mensagens. O cliente assinante usa uma das seguintes APIs:
A maioria dos clientes assinantes não faz essas solicitações diretamente. Em vez disso, os clientes dependem da biblioteca de cliente de alto nível fornecida pelo Trusted Cloud by S3NS, que realiza solicitações de pull de streaming internamente e entrega mensagens de forma assíncrona. Para um cliente assinante que precisa de mais controle sobre como as mensagens são extraídas, o Pub/Sub usa uma biblioteca gRPC de baixo nível gerada automaticamente. Essa biblioteca faz solicitações de extração ou de extração por streaming diretamente. Essas solicitações podem ser síncronas ou assíncronas.
As duas imagens a seguir mostram o fluxo de trabalho entre um cliente assinante e uma assinatura de extração.


Fluxo de trabalho de pull
O fluxo de trabalho de extração é o seguinte e faz referência à Figura 1:
- O cliente assinante chama explicitamente o método
pull
, que solicita mensagens para entrega. Essa solicitação é oPullRequest
, conforme mostrado na imagem. O servidor do Pub/Sub responde com zero ou mais mensagens e IDs de confirmação. Uma resposta com zero mensagens ou com um erro não indica necessariamente que não há mensagens disponíveis para receber. Essa resposta é o
PullResponse
, conforme mostrado na imagem.O cliente assinante chama explicitamente o método
acknowledge
. O cliente usa o ID de confirmação retornado para confirmar que a mensagem foi processada e não precisa ser entregue novamente.
Para uma única solicitação de envio de streaming, um cliente assinante pode ter várias respostas retornadas devido à conexão aberta. Em contraste, apenas uma resposta é retornada para cada solicitação de envio.
Propriedades de uma assinatura por pull
As propriedades configuradas para uma assinatura de pull determinam como você grava mensagens na assinatura. Para mais informações, consulte propriedades de assinatura.
APIs de serviço do Pub/Sub
A assinatura por pull do Pub/Sub pode usar uma das duas APIs a seguir para recuperar mensagens:
- Pull
- StreamingPull
Use RPCs unários Acknowledge e ModifyAckDeadline ao receber mensagens usando essas APIs. As duas APIs Pub/Sub são descritas nas seções a seguir.
API StreamingPull
Sempre que possível, as bibliotecas de cliente do Pub/Sub usam StreamingPull para máxima capacidade e menor latência. Embora seja possível que o uso da API StreamingPull diretamente nunca venha a acontecer, é importante saber como ela difere da API Pull.
A API StreamingPull depende de uma conexão bidirecional persistente para receber várias mensagens à medida que elas são disponibilizadas. O fluxo de trabalho é o seguinte:
O cliente envia uma solicitação ao servidor para estabelecer uma conexão. Se a cota de conexão for excedida, o servidor vai retornar um erro de recurso esgotado. A biblioteca de cliente tenta novamente os erros de falta de cota automaticamente.
Se não houver erro ou se a cota de conexão estiver disponível novamente, o servidor enviará mensagens continuamente para o cliente conectado.
Se ou quando a cota de capacidade de processamento for excedida, o servidor vai parar de enviar mensagens. No entanto, a conexão não é interrompida. Quando houver de novo uma cota de capacidade de processamento suficiente, o stream será retomado.
O cliente ou o servidor encerra a conexão.
A API StreamingPull mantém uma conexão aberta. Os servidores do Pub/Sub fecham a conexão recorrentemente após um período para evitar uma conexão fixa de longa duração. A biblioteca de cliente reabre automaticamente uma conexão StreamingPull.
As mensagens são enviadas para a conexão quando estão disponíveis. Assim, a API StreamingPull minimiza a latência e maximiza a capacidade de processamento das mensagens.
Leia mais sobre os métodos RPC StreamingPull: StreamingPullRequest e StreamingPullResponse.
API Pull
Essa API é um RPC unário tradicional baseado em um modelo de solicitação e resposta. Uma única resposta de extração corresponde a uma única solicitação de envio. Este é o fluxo de trabalho:
O cliente envia uma solicitação de mensagens ao servidor. Se a cota de capacidade de processamento for excedida, o servidor vai retornar um erro de recurso esgotado.
Se não houver erro ou se a cota de capacidade de processamento estiver disponível novamente, o servidor responderá com zero ou mais mensagens e IDs de confirmação.
Ao usar a API Pull unária, uma resposta com zero mensagens ou com um erro não indica necessariamente que não há mensagens disponíveis para receber.
O uso da API Pull não garante baixa latência e alta taxa de transferência de mensagens. Para conseguir alta capacidade de processamento e baixa latência com a API Pull, você precisa ter várias solicitações pendentes simultâneas. Novas solicitações são criadas quando as antigas recebem uma resposta. Arquitetar uma solução assim é propenso a erros e difícil de manter. Recomendamos usar a API StreamingPull para esses casos de uso.
Use a API Pull em vez da API StreamingPull somente se você precisar de controle estrito sobre o seguinte:
- O número de mensagens que o cliente assinante pode processar
- A memória e os recursos do cliente
Também é possível usar essa API quando o assinante é um proxy entre o Pub/Sub e outro serviço que opera de maneira mais orientada a pull.
Leia mais sobre os métodos REST de pull: Método: projects.subscriptions.pull.
Leia mais sobre os métodos Pull RPC: PullRequest e PullResponse.
Tipos de modos de processamento de mensagens
Escolha um dos seguintes modos de extração para os clientes assinantes.
Modo de pull assíncrono
O modo de recebimento assíncrono separa o recebimento do processamento de mensagens em um cliente assinante. Esse modo é o padrão para a maioria dos clientes assinantes. O modo de extração assíncrono pode usar a API StreamingPull ou a API Pull unária. O pull assíncrono também pode usar a biblioteca de cliente de alto nível ou a biblioteca de cliente de baixo nível gerada automaticamente.
Você vai saber mais sobre as bibliotecas de cliente mais adiante neste documento.
Modo de pull síncrono
No modo de extração síncrona, o recebimento e o processamento de mensagens ocorrem em sequência e não são separados. Portanto, assim como as APIs StreamingPull e Pull unárias, o processamento assíncrono oferece menor latência e maior capacidade do que o processamento síncrono.
Use o modo de extração síncrona apenas para aplicativos em que a baixa latência e a alta capacidade de processamento não são os fatores mais importantes em comparação com outros requisitos. Por exemplo, um aplicativo pode ser limitado a usar apenas o modelo de programação síncrona. Ou um aplicativo com restrições de recursos pode exigir um controle mais exato sobre memória, rede ou CPU. Nesses casos, use o modo síncrono com a API Pull unária.
Bibliotecas de cliente do Pub/Sub
O Pub/Sub oferece uma biblioteca de cliente de alto e baixo nível gerada automaticamente.
Biblioteca de cliente de alto nível do Pub/Sub
A biblioteca de cliente de alto nível oferece opções para controlar os prazos de confirmação usando o gerenciamento de concessão. Essas opções são mais granulares do que quando você configura os prazos de confirmação usando o console ou a CLI no nível da assinatura. A biblioteca de cliente de alto nível também implementa suporte para recursos como entrega ordenada, entrega exatamente uma vez e controle de fluxo.
Recomendamos usar o pull assíncrono e a API StreamingPull com a biblioteca de cliente de alto nível. Nem todas as linguagens compatíveis com Trusted Cloud by S3NS também são compatíveis com a API Pull na biblioteca de cliente de alto nível.
Para usar as bibliotecas de cliente de alto nível, consulte Bibliotecas de cliente do Pub/Sub.
Biblioteca de cliente do Pub/Sub de baixo nível gerada automaticamente.
Uma biblioteca de cliente de baixo nível está disponível para casos em que é necessário usar a API Pull diretamente. É possível usar o processamento síncrono ou assíncrono com a biblioteca de cliente de baixo nível gerada automaticamente. É necessário codificar manualmente recursos como entrega ordenada, entrega exatamente uma vez, controle de fluxo e gerenciamento de concessão ao usar a biblioteca de cliente de baixo nível gerada automaticamente.
É possível usar o modelo de processamento síncrono com a biblioteca de cliente de baixo nível gerada automaticamente para todas as linguagens compatíveis. Você pode usar a biblioteca de cliente de baixo nível gerada automaticamente e o pull síncrono em casos em que faz sentido usar a API Pull diretamente. Por exemplo, você pode ter uma lógica de aplicativo que depende desse modelo.
Para usar diretamente as bibliotecas de cliente de baixo nível geradas automaticamente, consulte Visão geral das APIs Pub/Sub.
Exemplos de código da biblioteca de cliente
Exemplos de código de biblioteca de cliente de alto nível e StreamingPull
C++
Antes de tentar esse exemplo, siga as instruções de configuração do C++ em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C++.
C#
Antes de tentar esse exemplo, siga as instruções de configuração do C# em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C#.
Go
O exemplo a seguir usa a versão principal da biblioteca de cliente do Go Pub/Sub (v2). Se você ainda estiver usando a biblioteca v1, consulte o guia de migração para a v2. Para conferir uma lista de exemplos de código da v1, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Go em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Go.
Java
Antes de tentar essa amostra, siga as instruções de configuração do Java em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Java.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Python
Antes de tentar esse exemplo, siga as instruções de configuração do Python em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Python.
Ruby
O exemplo a seguir usa a biblioteca de cliente do Ruby Pub/Sub v3. Se você ainda estiver usando a biblioteca v2, consulte o guia de migração para a v3. Para conferir uma lista de exemplos de código do Ruby v2, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Ruby em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Ruby.
Recuperar atributos personalizados usando a biblioteca de cliente de alto nível
Os exemplos a seguir mostram como enviar mensagens pull de maneira assíncrona e recuperar os atributos personalizados dos metadados.
C++
Antes de tentar esse exemplo, siga as instruções de configuração do C++ em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C++.
C#
Antes de tentar esse exemplo, siga as instruções de configuração do C# em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C#.
Go
O exemplo a seguir usa a versão principal da biblioteca de cliente do Go Pub/Sub (v2). Se você ainda estiver usando a biblioteca v1, consulte o guia de migração para a v2. Para conferir uma lista de exemplos de código da v1, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Go em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Go.
Java
Antes de tentar essa amostra, siga as instruções de configuração do Java em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Java.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Python
Antes de tentar esse exemplo, siga as instruções de configuração do Python em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Python.
Ruby
O exemplo a seguir usa a biblioteca de cliente do Ruby Pub/Sub v3. Se você ainda estiver usando a biblioteca v2, consulte o guia de migração para a v3. Para conferir uma lista de exemplos de código do Ruby v2, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Ruby em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Ruby.
Tratar erros usando a biblioteca de cliente de alto nível
Os exemplos a seguir mostram como lidar com erros que ocorrem ao assinar mensagens.
C++
Antes de tentar esse exemplo, siga as instruções de configuração do C++ em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C++.
Go
O exemplo a seguir usa a versão principal da biblioteca de cliente do Go Pub/Sub (v2). Se você ainda estiver usando a biblioteca v1, consulte o guia de migração para a v2. Para conferir uma lista de exemplos de código da v1, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Go em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Go.
Java
Antes de tentar essa amostra, siga as instruções de configuração do Java em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Java.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Python
Antes de tentar esse exemplo, siga as instruções de configuração do Python em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Python.
Ruby
O exemplo a seguir usa a versão principal da biblioteca de cliente do Go Pub/Sub (v2). Se você ainda estiver usando a biblioteca v1, consulte o guia de migração para a v2. Para conferir uma lista de exemplos de código da v1, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Go em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Go.
Exemplos de código de solicitação unária
Confira um exemplo de código para enviar por pull e confirmar um número fixo de mensagens.
C++
Antes de tentar esse exemplo, siga as instruções de configuração do C++ em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C++.
C#
Antes de tentar esse exemplo, siga as instruções de configuração do C# em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C#.
Java
Antes de tentar essa amostra, siga as instruções de configuração do Java em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Java.
Node.js
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
PHP
Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.
Ruby
O exemplo a seguir usa a biblioteca de cliente do Ruby Pub/Sub v3. Se você ainda estiver usando a biblioteca v2, consulte o guia de migração para a v3. Para conferir uma lista de exemplos de código do Ruby v2, consulte os exemplos de código descontinuados.
Antes de tentar esse exemplo, siga as instruções de configuração do Ruby em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Ruby.
Protocolo
Solicitação:
POST https://pubsub.googleapis.com/v1/projects/myproject/subscriptions/mysubscription:pull
{
"returnImmediately": "false",
"maxMessages": "1"
}
Resposta:
200 OK
{
"receivedMessages": [{
"ackId": "dQNNHlAbEGEIBERNK0EPKVgUWQYyODM2LwgRHFEZDDsLRk1SK...",
"message": {
"data": "SGVsbG8gQ2xvdWQgUHViL1N1YiEgSGVyZSBpcyBteSBtZXNzYWdlIQ==",
"messageId": "19917247034"
}
}]
}
Solicitação:
POST https://pubsub.googleapis.com/v1/projects/myproject/subscriptions/mysubscription:acknowledge
{
"ackIds": [
"dQNNHlAbEGEIBERNK0EPKVgUWQYyODM2LwgRHFEZDDsLRk1SK..."
]
}
Python
Antes de tentar esse exemplo, siga as instruções de configuração do Python em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Python.
O Pub/Sub entrega uma lista de mensagens. Se a lista tiver várias mensagens, o Pub/Sub as ordenará com a mesma chave de ordenação. Confira algumas advertências importantes:
Definir um valor para
max_messages
na solicitação não garante quemax_messages
sejam retornadas, mesmo que haja muitas mensagens no backlog. A API Pub/Sub Pull pode retornar menos demax_messages
para reduzir a latência de entrega de mensagens que estão disponíveis para entrega.Uma resposta de pull com zero mensagens não pode ser usada como um indicador de que não há mensagens no backlog. É possível receber uma resposta com zero mensagens e ter uma solicitação subsequente que retorne mensagens.
Para conseguir baixa latência de entrega de mensagens com o modo de pull unário, é essencial ter muitas solicitações de pull pendentes ao mesmo tempo. À medida que a capacidade do tópico aumenta, mais solicitações de pull são necessárias. Em geral, o modo StreamingPull é preferível para aplicativos sensíveis à latência.
Cotas e limites
As conexões Pull e StreamingPull estão sujeitas a cotas e limites. Para mais informações, consulte Cotas e limites do Pub/Sub.
A seguir
Crie uma assinatura de pull para seu tópico.
Solucione problemas com uma assinatura de pull.
Crie ou modifique uma assinatura com a CLI gcloud.
Crie ou modifique uma assinatura com APIs REST.
Crie ou modifique uma assinatura com as APIs RPC.