En este documento, se muestra cómo crear esquemas para temas de Pub/Sub.
Antes de comenzar
Antes de crear un esquema, completa los siguientes pasos:
- Obtén más información sobre los temas y el flujo de trabajo de publicación.
- Comprende cómo funcionan los esquemas de Pub/Sub.
- Crea un tema.
Roles y permisos requeridos
Para obtener los permisos que necesitas para crear y administrar esquemas,
pídele a tu administrador que te otorgue el rol de IAM de
editor de Pub/Sub (roles/pubsub.editor
)
en tu proyecto.
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
Este rol predefinido contiene los permisos necesarios para crear y administrar esquemas. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:
Permisos necesarios
Se requieren los siguientes permisos para crear y administrar esquemas:
-
Crea un esquema:
pubsub.schemas.create
-
Adjunta el esquema al tema:
pubsub.schemas.attach
-
Confirma una revisión del esquema:
pubsub.schemas.commit
-
Borra un esquema o una revisión del esquema:
pubsub.schemas.delete
-
Obtén un esquema o revisiones de esquemas:
pubsub.schemas.get
-
Esquemas de lista:
pubsub.schemas.list
-
Enumera las revisiones del esquema:
pubsub.schemas.listRevisions
-
Cómo revertir un esquema:
pubsub.schemas.rollback
-
Valida un mensaje:
pubsub.schemas.validate
-
Obtén la política de IAM para un esquema:
pubsub.schemas.getIamPolicy
-
Configura la política de IAM para un esquema:
pubsub.schemas.setIamPolicy
También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.
Puedes otorgar roles y permisos a 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 tener los permisos necesarios para cada proyecto.
Crea un esquema
Puedes crear un esquema con la consola de Google Cloud , gcloud CLI, la API de Pub/Sub o las bibliotecas cliente de Cloud.
Antes de crear un esquema, revisa esta información importante sobre los esquemas.
Console
Para crear un esquema, sigue estos pasos:
En la consola de Google Cloud , ve a la página Esquemas de Pub/Sub.
Haz clic en Create schema (Crear esquema).
En el campo ID de esquema, ingresa un ID para tu esquema.
Para obtener lineamientos sobre cómo asignar un nombre a un esquema, consulta Lineamientos para asignar un nombre a un tema, una suscripción o una instantánea.
En Tipo de esquema, selecciona Avro o búfer de protocolo.
Obtén más información sobre los tipos de esquemas.
En el campo Definición del esquema, ingresa la definición del búfer de protocolo de Avro para tu esquema.
Por ejemplo, aquí tienes un esquema de muestra 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 verificar si la definición del esquema es correcta.
La verificación de validación no comprueba la compatibilidad del esquema con los mensajes que se publicarán. Probarás los mensajes en el siguiente paso.
Opcional: Puedes probar si se publican mensajes con el esquema correcto.
Haz clic en Probar mensaje.
En la ventana Test message, selecciona un tipo de Codificación de mensajes.
En el Cuerpo del mensaje, ingresa un mensaje de prueba.
Haga clic en Probar.
Por ejemplo, este es un mensaje de muestra para el esquema de prueba. En este ejemplo, selecciona la Codificación de mensajes como
JSON
.{"ProductName":"GreenOnions", "SKU":34543, "InStock":true}
Sal de la página de mensajes de prueba.
Haz clic en Crear para guardar el esquema.
gcloud
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition=SCHEMA_DEFINITION
Aquí:
- SCHEMA_TYPE es
avro
oprotocol-buffer
. - SCHEMA_DEFINITION es una
string
que contiene la definición del esquema, con el formato del tipo de esquema seleccionado.
También puedes especificar la definición del esquema en un archivo:
gcloud pubsub schemas create SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition-file=SCHEMA_DEFINITION_FILE
Aquí:
- SCHEMA_TYPE es
avro
oprotocol-buffer
. - SCHEMA_DEFINITION_FILE es un
string
que contiene la ruta de acceso al archivo con la definición del esquema, con el formato del tipo de esquema seleccionado.
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 }
Aquí:
- SCHEMA_TYPE es
avro
oprotocol-buffer
. - SCHEMA_DEFINITION es una string que contiene la definición del esquema, con el formato correspondiente al tipo de esquema seleccionado.
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 }
Aquí:
- REVISION_ID es el ID generado por el servidor para 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 esta muestra, sigue las instrucciones de configuración de C++ en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C++.
Avro
Proto
C#
Antes de probar esta muestra, sigue las instrucciones de configuración de C# en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C#.
Avro
Proto
Go
Antes de probar esta muestra, sigue las instrucciones de configuración de Go en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Go.
Avro
Proto
Java
Antes de probar esta muestra, sigue las instrucciones de configuración de Java en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Java.
Avro
Proto
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Avro
Proto
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Avro
Proto
PHP
Antes de probar esta muestra, sigue las instrucciones de configuración de PHP en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres 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 esta muestra, sigue las instrucciones de configuración de Python en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Python.
Avro
Proto
Ruby
Antes de probar esta muestra, sigue las instrucciones de configuración de Ruby en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Ruby.
Avro
Proto
Después de crear un esquema, puedes ver sus detalles en la página Esquemas.
Puedes asociar el esquema a un tema.