En este documento se explica cómo crear esquemas para temas de Pub/Sub.
Antes de empezar
Antes de crear un esquema, haz lo siguiente:
- Consulta información sobre los temas y el flujo de trabajo de publicación.
- Consulta cómo funcionan los esquemas de Pub/Sub.
- Crea un tema.
Roles y permisos necesarios
Para obtener los permisos que necesitas para crear y gestionar esquemas, pide a tu administrador que te conceda el rol de gestión de identidades y accesos Editor de Pub/Sub (roles/pubsub.editor
) en tu proyecto.
Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.
Este rol predefinido contiene los permisos necesarios para crear y gestionar esquemas. Para ver los permisos exactos que se necesitan, despliega la sección Permisos necesarios:
Permisos obligatorios
Para crear y gestionar esquemas, se necesitan los siguientes permisos:
-
Crea un esquema:
pubsub.schemas.create
-
Adjuntar un esquema a un tema:
pubsub.schemas.attach
-
Confirmar una revisión del esquema:
pubsub.schemas.commit
-
Eliminar un esquema o una revisión de un esquema:
pubsub.schemas.delete
-
Obtener un esquema o revisiones de un esquema:
pubsub.schemas.get
-
Ver esquemas:
pubsub.schemas.list
-
Lista de revisiones del esquema:
pubsub.schemas.listRevisions
-
Restaurar una versión anterior de un esquema:
pubsub.schemas.rollback
-
Validar un mensaje:
pubsub.schemas.validate
-
Obtener la política de gestión de identidades y accesos de un esquema:
pubsub.schemas.getIamPolicy
-
Configura la política de gestión de identidades y accesos de un esquema:
pubsub.schemas.setIamPolicy
También puedes obtener estos permisos con roles personalizados u otros roles predefinidos.
Puedes conceder roles y permisos a entidades principales, como usuarios, grupos, dominios o cuentas de servicio. Puedes crear un esquema en un proyecto y adjuntarlo a un tema ubicado en otro proyecto. Asegúrate de que tienes los permisos necesarios para cada proyecto.
Crear un esquema
Puedes crear un esquema con la Google Cloud consola, la CLI de gcloud, la API de Pub/Sub o las bibliotecas de cliente de Cloud.
Antes de crear un esquema, consulta esta información importante sobre los esquemas.
Consola
Para crear un esquema, sigue estos pasos:
En la Google Cloud consola, ve a la página Esquemas de Pub/Sub.
Haz clic en Crear esquema.
En el campo ID de esquema, introduce un ID para tu esquema.
Para consultar las directrices sobre cómo asignar un nombre a un esquema, consulta Directrices para asignar un nombre a un tema, una suscripción o una captura.
En Tipo de esquema, seleccione Avro o Búfer de protocolo.
En el campo Schema definition (Definición de esquema), introduce la definición de Avro o Protocol Buffer de tu esquema.
Por ejemplo, aquí se muestra un esquema de ejemplo en Avro.
{ "type": "record", "name": "Avro", "fields": [ { "name": "ProductName", "type": "string", "default": "" }, { "name": "SKU", "type": "int", "default": 0 }, { "name": "InStock", "type": "boolean", "default": false } ] }
Opcional: Haz clic en Validar definición para comprobar si la definición del esquema es correcta.
La comprobación de validación no comprueba la compatibilidad del esquema con los mensajes que se van a publicar. Prueba los mensajes en el siguiente paso.
Opcional: Puedes probar si se publican los mensajes con el esquema correcto.
Haz clic en Mensaje de prueba.
En la ventana Mensaje de prueba, selecciona un tipo de Codificación de mensaje.
En Cuerpo del mensaje, escribe un mensaje de prueba.
Haz clic en Test (Probar).
Por ejemplo, aquí tienes un mensaje de ejemplo para el esquema de prueba. En este ejemplo, selecciona Codificación de mensajes como
JSON
.{"ProductName":"GreenOnions", "SKU":34543, "InStock":true}
Sal de la página del mensaje de prueba.
Haz clic en Crear para guardar el esquema.
gcloud
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition=SCHEMA_DEFINITION
Donde:
- SCHEMA_TYPE puede ser
avro
oprotocol-buffer
. - SCHEMA_DEFINITION es un
string
que contiene la definición del esquema, con el formato del tipo de esquema elegido.
También puede especificar la definición del esquema en un archivo:
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition-file=SCHEMA_DEFINITION_FILE
Donde:
- SCHEMA_TYPE puede ser
avro
oprotocol-buffer
. - SCHEMA_DEFINITION_FILE es un
string
que contiene la ruta al archivo con la definición del esquema, con el formato del tipo de esquema elegido.
REST
Para crear un esquema, envía una solicitud POST como la siguiente:
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
Especifica los siguientes campos en el cuerpo de la solicitud:
{ "definition": SCHEMA_DEFINITION "type": SCHEMA_TYPE }
Donde:
- SCHEMA_TYPE puede ser
avro
oprotocol-buffer
. - SCHEMA_DEFINITION es una cadena que contiene la definición del esquema, con el formato del tipo de esquema elegido.
El cuerpo de la respuesta debe contener una representación JSON de un recurso de esquema. Por ejemplo:
{ "name": SCHEMA_NAME, "type": SCHEMA_TYPE, "definition": SCHEMA_DEFINITION "revisionId": REVISION_ID "revisionCreateTime": REVISION_CREATE_TIME }
Donde:
- REVISION_ID es el ID generado por el servidor de la revisión.
- REVISION_CREATE_TIME es la marca de tiempo ISO 8601 en la que se creó la revisión.
C++
Antes de probar este ejemplo, sigue las instrucciones de configuración de C++ que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de C++ de Pub/Sub.
Avro
Proto
C#
Antes de probar este ejemplo, sigue las instrucciones de configuración de C# que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de C# de Pub/Sub.
Avro
Proto
Go
En el siguiente ejemplo se usa la versión principal de la biblioteca de cliente de Pub/Sub de Go (v2). Si sigues usando la biblioteca v1, consulta la guía de migración a la versión 2. Para ver una lista de ejemplos de código de la versión 1, consulta los ejemplos de código obsoletos.
Antes de probar este ejemplo, sigue las instrucciones de configuración de Go que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API Go de Pub/Sub.
Avro
Proto
Java
Antes de probar este ejemplo, sigue las instrucciones de configuración de Java que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de Java de Pub/Sub.
Avro
Proto
Node.js
Antes de probar este ejemplo, sigue las instrucciones de configuración de Node.js que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de Node.js de Pub/Sub.
Avro
Proto
Node.js
Antes de probar este ejemplo, sigue las instrucciones de configuración de Node.js que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de Node.js de Pub/Sub.
Avro
Proto
PHP
Antes de probar este ejemplo, sigue las instrucciones de configuración de PHP que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de Pub/Sub para PHP.
Avro
Proto
Python
Antes de probar este ejemplo, sigue las instrucciones de configuración de Python que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de Python de Pub/Sub.
Avro
Proto
Ruby
En el siguiente ejemplo se usa la biblioteca de cliente de Ruby Pub/Sub v3. Si sigues usando la biblioteca v2, consulta la guía de migración a la versión 3. Para ver una lista de ejemplos de código de Ruby v2, consulta los ejemplos de código obsoletos.
Antes de probar este ejemplo, sigue las instrucciones de configuración de Ruby que se indican en la guía de inicio rápido sobre cómo usar bibliotecas de cliente. Para obtener más información, consulta la documentación de referencia de la API de Ruby de Pub/Sub.
Avro
Proto
Una vez creado un esquema, puedes ver sus detalles en la página Esquemas.
Puedes asociar el esquema a un tema.