gcloud pubsub schemas validate-message Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud pubsub schemas validate-message - validate a message against a Pub/Sub schema
- SYNOPSIS
gcloud pubsub schemas validate-message--message=MESSAGE--message-encoding=MESSAGE_ENCODING(--schema-name=SCHEMA_NAME|--type=TYPE(--definition=DEFINITION|--definition-file=PATH_TO_FILE))[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Validate a message against a Pub/Sub schema.
- EXAMPLES
- To validate message against provided PROTOCOL_BUFFER schema, run:
gcloudpubsubschemasvalidate-message--message="{\"key\": \"my-key\"}"--message-encoding=JSON--definition="syntax = 'proto3'; message Message { optional string key = 1; }"--type=PROTOCOL_BUFFERTo validate an equivalent AVRO schema, run:
gcloudpubsubschemasvalidate-message--definition='{ "type": "record", "namespace": "my.ns", "name":"KeyMsg", "fields": [ { "name": "key", "type": "string" } ] }'\--type=AVRO - REQUIRED FLAGS
--message=MESSAGE- The message to validate against the schema.
--message-encoding=MESSAGE_ENCODING- The encoding of the message.
MESSAGE_ENCODINGmust beone of:binary,json. - Schema definition.Exactly one of these must be specified:
--schema-name=SCHEMA_NAME- Name or full path of an existing schema.
- Or at least one of these can be specified:
--type=TYPE- Type of inline schema.
TYPEmust be one of:avro,protocol-buffer.This flag argument must be specified if any of the other arguments in this groupare specified.
- Schema specification.Exactly one of these must be specified:
--definition=DEFINITION- Inline schema definition.
--definition-file=PATH_TO_FILE- File containing schema definition. Use a full or relative path to a local filecontaining the value of definition_file.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - API REFERENCE
- This command uses the
pubsub/v1API. The full documentation forthis API can be found at:https://cloud.google.com/pubsub/docs - NOTES
- These variants are also available:
gcloudalphapubsubschemasvalidate-messagegcloudbetapubsubschemasvalidate-message
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.