Neste documento, mostramos como criar esquemas para tópicos do Pub/Sub.
Antes de começar
Antes de criar um esquema, faça o seguinte:
- Saiba mais sobre tópicos e o fluxo de trabalho de publicação.
- Entenda como os esquemas do Pub/Sub funcionam.
- Crie um tópico.
Papéis e permissões necessárias
Para ter as permissões necessárias para criar e gerenciar esquemas,
peça ao administrador para conceder a você o
papel do IAM de
Editor do Pub/Sub (roles/pubsub.editor
) no seu projeto.
Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.
Esse papel predefinido contém as permissões necessárias para criar e gerenciar esquemas. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:
Permissões necessárias
As permissões a seguir são necessárias para criar e gerenciar esquemas:
-
Criar esquema:
pubsub.schemas.create
-
Anexar esquema ao tópico:
pubsub.schemas.attach
-
Confirmar uma revisão de esquema:
pubsub.schemas.commit
-
Excluir um esquema ou uma revisão de esquema:
pubsub.schemas.delete
-
Receber uma revisão de esquema ou esquema:
pubsub.schemas.get
-
Listar esquemas:
pubsub.schemas.list
-
Listar revisões de esquema:
pubsub.schemas.listRevisions
-
Reverter um esquema:
pubsub.schemas.rollback
-
Validar uma mensagem:
pubsub.schemas.validate
-
Consiga a política do IAM para um esquema:
pubsub.schemas.getIamPolicy
-
Configure a política do IAM para um esquema:
pubsub.schemas.setIamPolicy
Talvez você também consiga receber essas permissões com papéis personalizados ou outros papéis predefinidos.
É possível conceder papéis e permissões a principais como usuários, grupos, domínios ou contas de serviço. É possível criar um esquema em um projeto e anexá-lo a um tópico localizado em outro projeto. Verifique se você tem as permissões necessárias para cada projeto.
criar um esquema
É possível criar um esquema usando o console do Google Cloud, a CLI gcloud, a API Pub/Sub ou as bibliotecas de cliente do Cloud. Veja a seguir algumas diretrizes para criar um esquema:
Para que um esquema funcione com o Pub/Sub, você precisa definir apenas um tipo de nível superior. Instruções de importação que se referem a outros tipos não são aceitas.
É possível associar o mesmo esquema a vários tópicos.
É possível testar manualmente se uma mensagem é validada em um esquema.
Console
Para criar um esquema, siga estas etapas:
No console do Google Cloud, acesse a página Esquemas do Pub/Sub.
Clique em Criar esquema.
No campo Schema ID, insira um ID para seu esquema.
Para saber como nomear um esquema, consulte Diretrizes para nomear um tópico, uma assinatura ou um snapshot.
Em Tipo de esquema, selecione Avro ou o buffer de protocolo.
Saiba mais sobre os tipos de esquema.
No campo Definição do esquema, insira a definição do Avro ou do buffer de protocolo do seu esquema.
Por exemplo, aqui está um esquema de amostra no Avro.
{ "type": "record", "name": "Avro", "fields": [ { "name": "ProductName", "type": "string", "default": "" }, { "name": "SKU", "type": "int", "default": 0 }, { "name": "InStock", "type": "boolean", "default": false } ] }
Opcional: clique em Validar definição para verificar se a definição do esquema está correta.
A verificação de validação não confere a compatibilidade do esquema com as mensagens a serem publicadas. Teste as mensagens na próxima etapa.
Opcional: é possível testar se as mensagens com o esquema correto são publicadas.
Clique em Mensagem de teste.
Na janela Mensagem de teste, selecione um tipo de Codificação de mensagens.
Em Corpo da mensagem, digite uma mensagem de teste.
Clique em Teste.
Por exemplo, veja uma mensagem de amostra para o esquema de teste. Neste exemplo, selecione a Codificação de mensagens como
JSON
.{"ProductName":"GreenOnions", "SKU":34543, "InStock":true}
Saia da página da mensagem de teste.
Clique em Criar para salvar o esquema.
gcloud
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition=SCHEMA_DEFINITION
Em que:
- SCHEMA_TYPE é
avro
ouprotocol-buffer
. - SCHEMA_DEFINITION é um
string
que contém a definição do esquema, formatado de acordo com o tipo de esquema escolhido.
Também é possível especificar a definição do esquema em um arquivo:
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition-file=SCHEMA_DEFINITION_FILE
Em que:
- SCHEMA_TYPE é
avro
ouprotocol-buffer
. - SCHEMA_DEFINITION_FILE é um
string
que contém o caminho para o arquivo com a definição do esquema, formatado de acordo com o tipo de esquema escolhido.
REST
Para criar um esquema, envie uma solicitação POST como a seguinte:
POST https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID Authorization: Bearer $(gcloud auth application-default print-access-token) Content-Type: application/json --data @response-body.json
Especifique os campos a seguir no corpo da solicitação:
{ "definition": SCHEMA_DEFINITION "type": SCHEMA_TYPE }
Em que:
- SCHEMA_TYPE é
avro
ouprotocol-buffer
. - SCHEMA_DEFINITION é uma string que contém a definição do esquema, formatado de acordo com o tipo de esquema escolhido.
O corpo da resposta precisa conter uma representação JSON de um recurso de esquema. Exemplo:
{ "name": SCHEMA_NAME, "type": SCHEMA_TYPE, "definition": SCHEMA_DEFINITION "revisionId": REVISION_ID "revisionCreateTime": REVISION_CREATE_TIME }
Em que:
- REVISION_ID é o ID gerado pelo servidor para a revisão.
- REVISION_CREATE_TIME é o carimbo de data/hora ISO 8601 em que a revisão foi criada.
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++.
Avro
Proto
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#.
Avro
Proto
Go
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.
Avro
Proto
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.
Avro
Proto
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.
Avro
Proto
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.
Avro
Proto
PHP
Antes de tentar esse exemplo, siga as instruções de configuração do PHP 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 PHP.
Avro
Proto
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.
Avro
Proto
Ruby
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.
Avro
Proto
Após a criação de um esquema, é possível ver os detalhes dele na página Esquemas.
É possível associar o esquema a um tópico.