En este documento se explica cómo asociar esquemas a temas de Pub/Sub.
Antes de empezar
- Consulta cómo funcionan los esquemas de Pub/Sub.
- Crea un esquema.
Roles y permisos necesarios
Para obtener los permisos que necesitas para asociar 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 asociar y gestionar esquemas. Para ver los permisos exactos que se necesitan, despliega la sección Permisos necesarios:
Permisos obligatorios
Para asociar 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.
Directrices para asociar un esquema a un tema
Puedes asociar un esquema a un tema cuando crees o edites un tema. Estas son las directrices para asociar un esquema a un tema:
Puede asociar un esquema a uno o varios temas.
Una vez que se asocia un esquema a un tema, todos los mensajes que reciba el tema de los editores deben seguir ese esquema.
Cuando asocias un esquema a un tema, también debes especificar la codificación de los mensajes que se van a publicar como
BINARY
oJSON
. Si usas JSON con un esquema Avro, presta especial atención a las reglas de codificación de las uniones.Si un esquema asociado a un tema tiene revisiones, los mensajes deben coincidir con la codificación y validarse con una revisión dentro del intervalo disponible. Si no se validan, el mensaje no se publicará.
Las revisiones se prueban en orden cronológico inverso según la hora de creación. Para crear una revisión de un esquema, consulta Confirmar una revisión de un esquema.
Lógica de validación de un esquema de mensaje
Cuando asocias un esquema a un tema y el esquema tiene revisiones, puedes especificar un intervalo de revisiones para usarlo. Si no especificas un intervalo, se usará todo el intervalo para la validación.
Si no especificas una revisión como Primera revisión permitida, se usará la revisión más antigua del esquema para la validación. Si no especificas una revisión como Última revisión permitida, se usará la revisión más reciente del esquema.
Tomemos como ejemplo el esquema S
, que está asociado al tema T
.
El esquema S
tiene los IDs de revisión A
, B
, C
y D
creados en orden, donde A
es la primera o la revisión más antigua. Ninguno de los esquemas es idéntico a otro ni es una reversión de un esquema ya creado.
Si solo define el campo Primera revisión permitida como
B
, los mensajes que solo se ajusten al esquemaA
se rechazarán, mientras que los mensajes que se ajusten a los esquemasB
,C
yD
se aceptarán.Si solo asigna el valor
C
al campo Última revisión permitida, se aceptarán los mensajes que cumplan los esquemasA
,B
yC
, y se rechazarán los mensajes que solo cumplan el esquemaD
.Si asignas el valor
B
al campo First revision allowed y el valorC
al campo Last revision allowed, se aceptarán los mensajes que se ajusten a los esquemasB
yC
.También puedes definir la primera y la última revisión con el mismo ID de revisión. En este caso, solo se aceptarán los mensajes que se ajusten a esa revisión.
Crear y asociar un esquema al crear un tema
Puedes crear un tema con un esquema mediante la Google Cloud consola, la CLI de gcloud, la API de Pub/Sub o las bibliotecas de cliente de Cloud.
Consola
En la Google Cloud consola, ve a la página Temas de Pub/Sub.
Haz clic en Crear tema.
En el campo ID de tema, introduce un ID para el tema.
Para poner nombre a un tema, consulta las directrices.
Marca la casilla Usar un esquema.
Mantenga la configuración predeterminada en los campos restantes.
Puedes crear un esquema o usar uno que ya tengas.
Si va a crear un esquema, siga estos pasos: `
- En Seleccionar un esquema de Pub/Sub, selecciona Crear un esquema.
La página Crear esquema se muestra en una pestaña secundaria.
Sigue los pasos que se indican en Crear un esquema.
Vuelve a la pestaña Crear tema y haz clic en Actualizar.
Busque su esquema en el campo Seleccionar un esquema de Pub/Sub.
Selecciona la codificación de mensajes JSON o Binario.
El esquema que acabas de crear tiene un ID de revisión. Puedes crear revisiones de esquema adicionales, tal como se explica en Confirmar una revisión de esquema.
Si va a asociar un esquema que ya ha creado, siga estos pasos:
En Seleccionar un esquema de Pub/Sub, elija un esquema.
Selecciona la codificación de mensajes JSON o Binario.
Opcional: Si el esquema seleccionado tiene revisiones, en Intervalo de revisiones, usa los menús desplegables Primera revisión permitida y Última revisión permitida.
Puedes especificar ambos campos, solo uno o conservar la configuración predeterminada según tus necesidades.
Mantenga la configuración predeterminada en los campos restantes.
Haz clic en Crear para guardar el tema y asignarlo al esquema seleccionado.
gcloud
Para crear un tema asignado a un esquema creado anteriormente, ejecuta el comando
gcloud pubsub topics create
gcloud pubsub topics create TOPIC_ID \ --message-encoding=ENCODING_TYPE \ --schema=SCHEMA_ID \ --first-revision-id=FIRST_REVISION_ID \ --last-revision-id=LAST_REVISION_ID \
Donde:
- TOPIC_ID es el ID del tema que estás creando.
- ENCODING_TYPE es la codificación de los mensajes validados con el esquema. Este valor debe ser
JSON
oBINARY
. - SCHEMA_ID es el ID de un esquema ya creado.
- FIRST_REVISION_ID es el ID de la revisión más antigua con la que se va a validar.
- LAST_REVISION_ID es el ID de la revisión más reciente con la que se va a validar.
Tanto --first-revision-id
como --last-revision-id
son opcionales.
También puedes asignar un esquema de otro proyecto de Google Cloud :
gcloud pubsub topics create TOPIC_ID \ --message-encoding=ENCODING_TYPE \ --schema=SCHEMA_ID \ --schema-project=SCHEMA_PROJECT \ --project=TOPIC_PROJECT
Donde:
- SCHEMA_PROJECT es el ID del proyecto del Google Cloud proyecto del esquema.
- TOPIC_PROJECT es el ID del proyecto del Google Cloud proyecto del tema.
REST
Para crear un tema, usa el método projects.topics.create
:
Solicitud:
La solicitud debe autenticarse con un token de acceso en el encabezado Authorization
. Para obtener un token de acceso de las credenciales de aplicación predeterminadas actuales, usa gcloud auth application-default print-access-token
.
PUT https://pubsub.googleapis.com/v1/projects/PROJECT_ID/topics/TOPIC_ID Authorization: Bearer ACCESS_TOKEN
Cuerpo de la solicitud:
{ "schemaSettings": { "schema": "SCHEMA_NAME", "encoding": "ENCODING_TYPE" "firstRevisionId": "FIRST_REVISION_ID" "lastRevisionId": "LAST_REVISION_ID" } }
Donde:
- PROJECT_ID es el ID del proyecto.
- El ID de tu tema es TOPIC_ID.
- SCHEMA_NAME es el nombre del esquema con el que se deben validar los mensajes publicados. El formato es:
projects/PROJECT_ID/schemas/SCHEMA_ID
. - ENCODING_TYPE es la codificación de los mensajes validados con el esquema. Debe ser
JSON
oBINARY
. - FIRST_REVISION_ID es el ID de la revisión más antigua con la que se va a validar.
- LAST_REVISION_ID es el ID de la revisión más reciente con la que se va a validar.
Tanto firstRevisionId
como lastRevisionId
son opcionales.
Respuesta:
{ "name": "projects/PROJECT_ID/topics/TOPIC_ID", "schemaSettings": { "schema": "SCHEMA_NAME", "encoding": "ENCODING_TYPE" "firstRevisionId": "FIRST_REVISION_ID" "lastRevisionId": "LAST_REVISION_ID" } }
Se omiten firstRevisionId
y lastRevisionId
si no se proporcionan en la solicitud.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Editar un esquema asociado a un tema
Puedes editar un tema para adjuntar un esquema, eliminarlo o actualizar el intervalo de revisión que se usa para validar mensajes. Por lo general, si tienes previsto hacer cambios en el esquema en uso, puedes confirmar una nueva revisión y actualizar el intervalo de revisiones que se usa en el tema.
Puedes editar un esquema asociado a un tema mediante laGoogle Cloud consola, la CLI de gcloud, la API de Pub/Sub o las bibliotecas de cliente de Cloud.
Consola
En la Google Cloud consola, ve a la página Temas de Pub/Sub.
Haz clic en el ID de tema de un tema.
En la página de detalles del tema, haz clic en Editar.
Puede hacer los siguientes cambios en el esquema.
Los cambios pueden tardar unos minutos en aplicarse.
Si quieres quitar el esquema del tema, en la página Editar tema, desmarca la casilla Usar un esquema.
Si quieres cambiar el esquema, en la sección Esquema, selecciona el nombre de un esquema.
Actualiza los demás campos según sea necesario.
- Si quieres actualizar el intervalo de revisiones, en Intervalo de revisiones, usa los menús desplegables Primera revisión permitida y Última revisión permitida.
Puedes especificar ambos campos, solo uno o conservar la configuración predeterminada según tus necesidades.
Haz clic en Actualizar para guardar los cambios.
gcloud
gcloud pubsub topics update TOPIC_ID \ --message-encoding=ENCODING_TYPE \ --schema=SCHEMA_NAME \ --first-revision-id=FIRST_REVISION_ID \ --last-revision-id=LAST_REVISION_ID \
Donde:
- TOPIC_ID es el ID del tema que estás creando.
- ENCODING_TYPE es la codificación de los mensajes validados con el esquema. Este valor debe ser
JSON
oBINARY
. - SCHEMA_NAME es el nombre de un esquema.
- FIRST_REVISION_ID es el ID de la revisión más antigua con la que se va a validar.
- LAST_REVISION_ID es el ID de la revisión más reciente con la que se va a validar.
Tanto --first-revision-id
como --last-revision-id
son opcionales.
REST
Para actualizar un tema, usa el método projects.topics.patch
:
Solicitud:
La solicitud debe autenticarse con un token de acceso en el encabezado Authorization
. Para obtener un token de acceso de las credenciales de aplicación predeterminadas actuales, usa gcloud auth application-default print-access-token
.
PATCH https://pubsub.googleapis.com/v1/projects/PROJECT_ID/topics/TOPIC_ID Authorization: Bearer ACCESS_TOKEN
Cuerpo de la solicitud:
{ "schemaSettings": { "schema": "SCHEMA_NAME", "encoding": "ENCODING_TYPE" "firstRevisionId": "FIRST_REVISION_ID" "lastRevisionId": "LAST_REVISION_ID" "update_mask": } }
Donde:
- PROJECT_ID es el ID del proyecto.
- El ID de tu tema es TOPIC_ID.
- SCHEMA_NAME es el nombre del esquema con el que se deben validar los mensajes publicados. El formato es:
projects/PROJECT_ID/schemas/SCHEMA_ID
. - ENCODING_TYPE es la codificación de los mensajes validados con el esquema. Debe ser
JSON
oBINARY
. - FIRST_REVISION_ID es el ID de la revisión más antigua con la que se va a validar.
- LAST_REVISION_ID es el ID de la revisión más reciente con la que se va a validar.
Tanto firstRevisionId
como lastRevisionId
son opcionales.
Respuesta:
{ "name": "projects/PROJECT_ID/topics/TOPIC_ID", "schemaSettings": { "schema": "SCHEMA_NAME", "encoding": "ENCODING_TYPE" "firstRevisionId": "FIRST_REVISION_ID" "lastRevisionId": "LAST_REVISION_ID" } }
Los valores de firstRevisionId
y lastRevisionId
no se definen después de la actualizació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.
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.
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.
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.
Siguientes pasos
- Confirmar una revisión de un esquema
- Publicar mensajes en un tema con un esquema
- Validar una definición de esquema
- Validar un mensaje para un esquema