Stay organized with collections
Save and categorize content based on your preferences.
This document shows you how to validate schemas for Pub/Sub topics.
You can validate that messages adhere to a certain schema,
before or after you create a schema resource. This step ensures that
the messages you intend to send through a topic associated with a
schema actually match before applying the schema.
To get the permissions that
you need to validate schema messages and manage them,
ask your administrator to grant you the
Pub/Sub Editor (roles/pubsub.editor)
IAM role on your project.
For more information about granting roles, see Manage access to projects, folders, and organizations.
This predefined role contains
the permissions required to validate schema messages and manage them. To see the exact permissions that are
required, expand the Required permissions section:
Required permissions
The following permissions are required to validate schema messages and manage them:
Create schema:
pubsub.schemas.create
Attach schema to topic:
pubsub.schemas.attach
Commit a schema revision:
pubsub.schemas.commit
Delete a schema or a schema revision:
pubsub.schemas.delete
Get a schema or schema revisions:
pubsub.schemas.get
List schemas:
pubsub.schemas.list
List schema revisions:
pubsub.schemas.listRevisions
Rollback a schema:
pubsub.schemas.rollback
Validate a message:
pubsub.schemas.validate
Get the IAM policy for a schema:
pubsub.schemas.getIamPolicy
Configure the IAM policy for a schema:
pubsub.schemas.setIamPolicy
You can grant roles and permissions to principals such as users, groups,
domains, or service accounts. You can create a schema in one project and
attach it to a topic located in a different project.
Ensure that you have the required permissions for
each project.
Validate a message for a schema
Console
In the Google Cloud console, go to the Pub/Sub schemas page.
At the bottom of the Google Cloud console, a
Cloud Shell
session starts and displays a command-line prompt. Cloud Shell is a shell environment
with the Google Cloud CLI
already installed and with values already set for
your current project. It can take a few seconds for the session to initialize.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["This document shows you how to validate schemas for Pub/Sub topics.\n\nYou can validate that messages adhere to a certain schema,\nbefore or after you create a schema resource. This step ensures that\nthe messages you intend to send through a topic associated with a\nschema actually match before applying the schema.\n\nBefore you begin\n\n- Understand how [Pub/Sub schemas work](/pubsub/docs/schemas).\n- [Create a schema](/pubsub/docs/create-schemas).\n\nRequired roles and permissions\n\n\nTo get the permissions that\nyou need to validate schema messages and manage them,\n\nask your administrator to grant you the\n\n\n[Pub/Sub Editor](/iam/docs/roles-permissions/pubsub#pubsub.editor) (`roles/pubsub.editor`)\nIAM role on your project.\n\n\nFor more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\nThis predefined role contains\n\nthe permissions required to validate schema messages and manage them. To see the exact permissions that are\nrequired, expand the **Required permissions** section:\n\n\nRequired permissions\n\nThe following permissions are required to validate schema messages and manage them:\n\n- Create schema: ` ``pubsub.schemas.create`\n- Attach schema to topic: ` ``pubsub.schemas.attach`\n- Commit a schema revision: ` ``pubsub.schemas.commit`\n- Delete a schema or a schema revision: ` ``pubsub.schemas.delete`\n- Get a schema or schema revisions: ` ``pubsub.schemas.get`\n- List schemas: ` ``pubsub.schemas.list`\n- List schema revisions: ` ``pubsub.schemas.listRevisions`\n- Rollback a schema: ` ``pubsub.schemas.rollback`\n- Validate a message: ` ``pubsub.schemas.validate`\n- Get the IAM policy for a schema: ` ``pubsub.schemas.getIamPolicy`\n- Configure the [IAM policy](/iam/docs/reference/rest/v1/Policy) for a schema: ` ``pubsub.schemas.setIamPolicy`\n\n\nYou might also be able to get\nthese permissions\nwith [custom roles](/iam/docs/creating-custom-roles) or\nother [predefined roles](/iam/docs/roles-overview#predefined).\n\nYou can grant roles and permissions to principals such as users, groups,\ndomains, or service accounts. You can create a schema in one project and\nattach it to a topic located in a different project.\nEnsure that you have the required permissions for\neach project.\n\nValidate a message for a schema \n\nConsole\n\n1. In the Google Cloud console, go to the **Pub/Sub schemas** page.\n\n [Go to Schemas](https://console.cloud.google.com/cloudpubsub/schema)\n\n The list of schemas is displayed.\n2. Click the **Schema ID** of an existing schema.\n\n The **Schema details** page for the schema opens.\n3. In the **Revisions** section, click the revision for which you want to\n validate a message.\n\n4. In the **Details** section, click **Test message**.\n\n5. In the **Test message** window, select a type of **Message encoding**.\n\n6. In the **Message** body, enter a test message.\n\n7. Click **Test**.\n\ngcloud\n\n\n1. In the Google Cloud console, activate Cloud Shell.\n\n [Activate Cloud Shell](https://console.cloud.google.com/?cloudshell=true)\n\n\n At the bottom of the Google Cloud console, a\n [Cloud Shell](/shell/docs/how-cloud-shell-works)\n session starts and displays a command-line prompt. Cloud Shell is a shell environment\n with the Google Cloud CLI\n already installed and with values already set for\n your current project. It can take a few seconds for the session to initialize.\n2. To validate a message against a schema use the [gcloud pubsub schemas validate-message](/sdk/gcloud/reference/pubsub/schemas/validate-message) command.\n\n \u003cbr /\u003e\n\n ```\n gcloud pubsub schemas validate-message --message=MESSAGE \\\n --message-encoding=MESSAGE_ENCODING \\\n (--schema-name=SCHEMA_NAME | \\\n --type=TYPE \\\n (--definition=DEFINITION | \\\n --definition-file=DEFINITION_FILE))\n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eMESSAGE\u003c/var\u003e: message to validate against the schema\n\n - \u003cvar translate=\"no\"\u003eMESSAGE_ENCODING\u003c/var\u003e: encoding of the message. Specify\n one of the following values: `binary` or `json`.\n\n - \u003cvar translate=\"no\"\u003eSCHEMA_NAME\u003c/var\u003e: name or full path of an existing schema.\n\n - \u003cvar translate=\"no\"\u003eTYPE\u003c/var\u003e: type of inline schema. Specify one of the\n following values: `avro`or `protocol-buffer`.\n\n - \u003cvar translate=\"no\"\u003eDEFINITION\u003c/var\u003e: inline schema definition.\n\n - \u003cvar translate=\"no\"\u003eDEFINITION_FILE\u003c/var\u003e: file containing the schema definition.\n\n\u003cbr /\u003e\n\nWhat's next\n\n- [Validate a schema definition when you create a topic](/pubsub/docs/create-schemas#create-schema)"]]
