En este documento, se muestra cómo confirmar una revisión de esquema para temas de Pub/Sub.
Antes de comenzar
- Obtén información sobre cómo funcionan los esquemas de Pub/Sub.
- Crea un esquema.
Roles y permisos requeridos
A fin de obtener los permisos que necesitas para confirmar una revisión de esquema y administrarlos, haz lo siguiente:
solicita 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 confirmar una revisión de esquema y administrarlos. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:
Permisos necesarios
Se requieren los siguientes permisos para confirmar una revisión de esquema y administrar esquemas:
-
Crear esquema:
pubsub.schemas.create
-
Adjunta un esquema al tema:
pubsub.schemas.attach
-
Confirma una revisión del esquema:
pubsub.schemas.commit
-
Borra un esquema o una revisión de esquema:
pubsub.schemas.delete
-
Obtén un esquema o revisiones de esquema:
pubsub.schemas.get
-
Enumera los esquemas:
pubsub.schemas.list
-
Enumera las revisiones de esquema:
pubsub.schemas.listRevisions
-
Revierte un esquema:
pubsub.schemas.rollback
-
Valida un mensaje:
pubsub.schemas.validate
-
Obtén la política de IAM de 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 vincularlo a un tema ubicado en un proyecto diferente. Asegúrate de tener los permisos necesarios para cada proyecto.
Revisa un esquema
Puedes confirmar una revisión del esquema con el La consola de Google Cloud, la CLI de gcloud, la API de Pub/Sub, o las bibliotecas cliente de Cloud.
Los siguientes son algunos lineamientos para confirmar una revisión del esquema:
Puedes revisar un esquema con restricciones específicas:
En el caso de los esquemas de Protocol Buffer, puedes agregar o quitar campos opcionales. No puedes agregar ni borrar otros campos. Tampoco puedes editar campo existente.
En el caso de los esquemas Avro, consulta la documentación de Avro para conocer las reglas sobre la resolución de esquemas. Una revisión nueva debe seguir las reglas como si fuera el esquema del lector y el del escritor.
Un esquema puede tener un máximo de 20 revisiones a la vez. Si superas el límite, borra una revisión del esquema antes de crear otra.
Cada revisión tiene un ID único asociado. El ID de la revisión es un UUID de ocho caracteres generado automáticamente.
Cuando actualizas el rango de revisión o la revisión de un esquema utilizado validación de tema, es posible que los cambios tarden unos minutos en aplicarse.
Console
Para crear una revisión de esquema, sigue estos pasos:
En la consola de Google Cloud, ve a la página Esquemas de Pub/Sub.
Haz clic en el ID de esquema de un esquema existente.
Se abrirá la página Detalles del esquema del esquema.
Haz clic en Crear revisión.
Se abrirá la página Crear revisión del esquema.
Realiza los cambios necesarios.
Por ejemplo, para el esquema de muestra en Avro que creaste en Cómo crear un esquema, puedes agregar un campo opcional adicional llamado
Price
de la siguiente manera:{ "type": "record", "name": "Avro", "fields": [ { "name": "ProductName", "type": "string", "default": "" }, { "name": "SKU", "type": "int", "default": 0 }, { "name": "InStock", "type": "boolean", "default": false }, { "name": "Price", "type": "double", "default": "0.0" } ] }
Haz clic en Validar la definición para comprobar si la definición del esquema es correcta.
También puedes validar los mensajes del esquema.
Haz clic en Probar mensaje para probar un mensaje de muestra.
En la ventana Mensaje de prueba, selecciona un tipo de Codificación de mensajes.
En Cuerpo del mensaje, ingresa un mensaje de prueba.
Por ejemplo, este es un mensaje de muestra para el esquema de prueba. En este ejemplo, selecciona Codificación de mensajes como
JSON
.{"ProductName":"GreenOnions", "SKU":34543, "Price":12, "InStock":true}
Haga clic en Test.
Haz clic en Confirmar para guardar el esquema.
gcloud
gcloud pubsub schemas commit 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 de esquema en el archivo:
gcloud pubsub schemas commit 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 que elijas tipo de esquema.
REST
Para confirmar una revisión del esquema, envía una solicitud POST como la siguiente:
POST https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID:commit 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 "name": SCHEMA_NAME }
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.
- SCHEMA_NAME es el nombre de un esquema existente.
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 que generó el servidor para la revisión.
- REVISION_CREATE_TIME es la marca de tiempo ISO 8601 en la que se creó la revisión adicional.
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
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
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
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
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
Después de confirmar una revisión de esquema, puedes ver los detalles de la revisión nueva en la página Esquemas.
¿Qué sigue?
- Borra una revisión del esquema
- Enumera las revisiones de un esquema
- Revierte una revisión de esquema