Method: projects.schemas.validateMessage

Validates a message against a schema.

HTTP request


Path parameters

Parameters
parent

string

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.

Request body

The request body contains data with the following structure:

JSON representation 
{
 "message": string,
 "encoding": enum (Encoding ),
 // Union field schema_spec can be only one of the following:
 "name": string,
 "schema": {
 object (Schema )
 }
 // End of list of possible types for union field schema_spec.
}
Fields
message

string (bytes format)

Message to validate against the provided schema_spec.

A base64-encoded string.
encoding

enum (Encoding )

The encoding expected for messages

Union field schema_spec.

schema_spec can be only one of the following:
name

string

Name of the schema against which to validate.

Format is projects/{project}/schemas/{schema}.
schema

object (Schema )

Ad-hoc schema against which to validate

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年08月22日 UTC.