View the details of a schema

This document shows you how to view schema details for Pub/Sub topics.

Before you begin

Understand how Pub/Sub schemas work .
Create a schema .

Required roles and permissions

To get the permissions that you need to view schema details 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 view schema details and manage them. To see the exact permissions that are required, expand the Required permissionssection:

Required permissions

The following permissions are required to view schema details 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 might also be able to get these permissions with custom roles or other predefined roles .

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.

View schema details

You can get the details of a schema using the Google Cloud console, the gcloud CLI, the Pub/Sub API, or the Cloud Client Libraries. The results return the details for the latest revision ID.

Console

In the Google Cloud console, go to the Pub/Sub schemaspage.

Go to Schemas
Click the name of the schema that you want to view.

The Schema detailspage for the schema opens.

gcloud

To view the latest revision for a schema:

gcloud pubsub schemas describe SCHEMA_NAME

To view a specific revision for a schema:

gcloud pubsub schemas describe SCHEMA_ID@REVISION_ID

Where:

REVISION_ID is the revision to which you want to roll back.

REST

To get the details of the latest revision of a schema, send a GET request like the following:

GET https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID

For example, for a schema with schema ID schema-inventory , send the following request: https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/schema-inventory

To get the details of a specific revision of a schema, send a GET request like the following:

GET https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID@REVISION_ID

For example, for a schema with schema ID schema-inventory and revision ID fa567a3e , send the following request: https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/schema-inventory@fa567a3e

Where:

PROJECT_ID is your project ID.
SCHEMA_ID is your schema ID.
REVISION_ID is the ID of the revision of the specific schema.

If successful, the response body contains an instance of the Schema class .

C++

Before trying this sample, follow the C++ setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub C++ API reference documentation .

  namespace 
  
 pubsub 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 pubsub 
 ; 
 []( 
 pubsub 
 :: 
 SchemaServiceClient 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 project_id 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 schema_id 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 revision_id 
 ) 
  
 { 
  
 std 
 :: 
 string 
  
 const 
  
 schema_id_with_revision 
  
 = 
  
 schema_id 
  
 + 
  
 "@" 
  
 + 
  
 revision_id 
 ; 
  
 google 
 :: 
 pubsub 
 :: 
 v1 
 :: 
 GetSchemaRequest 
  
 request 
 ; 
  
 request 
 . 
 set_name 
 ( 
  
 pubsub 
 :: 
 Schema 
 ( 
 project_id 
 , 
  
 schema_id_with_revision 
 ). 
 FullName 
 ()); 
  
 request 
 . 
 set_view 
 ( 
 google 
 :: 
 pubsub 
 :: 
 v1 
 :: 
 FULL 
 ); 
  
 auto 
  
 schema 
  
 = 
  
 client 
 . 
 GetSchema 
 ( 
 request 
 ); 
  
 if 
  
 ( 
 ! 
 schema 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 schema 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "The schema revision exists and its metadata is:" 
 << 
 " 
 \n 
 " 
 << 
 schema 
 - 
> DebugString 
 () 
 << 
 " 
 \n 
 " 
 ; 
 }

C#

Before trying this sample, follow the C# setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub C# API reference documentation .

  using 
  
  Google.Cloud.PubSub.V1 
 
 ; 
 public 
  
 class 
  
 GetSchemaSample 
 { 
  
 public 
  
 Schema 
  
 GetSchema 
 ( 
 string 
  
 projectId 
 , 
  
 string 
  
 schemaId 
 ) 
  
 { 
  
  SchemaServiceClient 
 
  
 schemaService 
  
 = 
  
  SchemaServiceClient 
 
 . 
  Create 
 
 (); 
  
  GetSchemaRequest 
 
  
 request 
  
 = 
  
 new 
  
  GetSchemaRequest 
 
  
 { 
  
 SchemaName 
  
 = 
  
  SchemaName 
 
 . 
  FromProjectSchema 
 
 ( 
 projectId 
 , 
  
 schemaId 
 ), 
  
 View 
  
 = 
  
  SchemaView 
 
 . 
  Full 
 
  
 }; 
  
 return 
  
 schemaService 
 . 
  GetSchema 
 
 ( 
 request 
 ); 
  
 } 
 }

Go

The following sample uses the major version of the Go Pub/Sub client library (v2). If you are still using the v1 library, see the migration guide to v2 . To see a list of v1 code samples, see the deprecated code samples .

Before trying this sample, follow the Go setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub Go API reference documentation .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 pubsub 
  
 "cloud.google.com/go/pubsub/v2/apiv1" 
  
 "cloud.google.com/go/pubsub/v2/apiv1/pubsubpb" 
 ) 
 func 
  
 getSchemaRevision 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 schemaID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // schemaID := my-schema@c7cfa2a8 // with revision 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 pubsub 
 . 
 NewSchemaClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "pubsub.NewSchemaClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& pubsubpb 
 . 
 GetSchemaRequest 
 { 
  
 Name 
 : 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/schemas/%s" 
 , 
  
 projectID 
 , 
  
 schemaID 
 ), 
  
 View 
 : 
  
 pubsubpb 
 . 
 SchemaView_FULL 
 , 
  
 } 
  
 s 
 , 
  
 err 
  
 := 
  
 client 
 . 
 GetSchema 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "client.GetSchema revision: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Got schema revision: %#v\n" 
 , 
  
 s 
 ) 
  
 return 
  
 nil 
 }

Java

Before trying this sample, follow the Java setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub Java API reference documentation .

  import 
  
 com.google.api.gax.rpc. NotFoundException 
 
 ; 
 import 
  
 com.google.cloud.pubsub.v1. SchemaServiceClient 
 
 ; 
 import 
  
 com.google.pubsub.v1. Schema 
 
 ; 
 import 
  
 com.google.pubsub.v1. SchemaName 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 GetSchemaRevisionExample 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 ... 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 schemaId 
  
 = 
  
 "your-schema-id[@your-schema-revision]" 
 ; 
  
 getSchemaRevisionExample 
 ( 
 projectId 
 , 
  
 schemaId 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 getSchemaRevisionExample 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 schemaId 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
  SchemaName 
 
  
 schemaName 
  
 = 
  
  SchemaName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 schemaId 
 ); 
  
 try 
  
 ( 
  SchemaServiceClient 
 
  
 schemaServiceClient 
  
 = 
  
  SchemaServiceClient 
 
 . 
 create 
 ()) 
  
 { 
  
  Schema 
 
  
 schema 
  
 = 
  
 schemaServiceClient 
 . 
 getSchema 
 ( 
 schemaName 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Got a schema:\n" 
  
 + 
  
 schema 
 ); 
  
 } 
  
 catch 
  
 ( 
  NotFoundException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 schemaName 
  
 + 
  
 "not found." 
 ); 
  
 } 
  
 } 
 }

Node.js

Before trying this sample, follow the Node.js setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub Node.js API reference documentation .

  /** 
 * TODO(developer): Uncomment this variable before running the sample. 
 */ 
 // const schemaNameOrId = 'YOUR_SCHEMA_NAME_OR_ID'; 
 // Imports the Google Cloud client library 
 const 
  
 { 
 PubSub 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/pubsub 
' 
 ); 
 // Creates a client; cache this for further use 
 const 
  
 pubSubClient 
  
 = 
  
 new 
  
  PubSub 
 
 (); 
 async 
  
 function 
  
 getSchema 
 ( 
 schemaNameOrId 
 ) 
  
 { 
  
 const 
  
 schema 
  
 = 
  
 pubSubClient 
 . 
 schema 
 ( 
 schemaNameOrId 
 ); 
  
 const 
  
 info 
  
 = 
  
 await 
  
 schema 
 . 
 get 
 (); 
  
 const 
  
 fullName 
  
 = 
  
 await 
  
 schema 
 . 
  getName 
 
 (); 
  
 console 
 . 
 log 
 ( 
 `Schema 
 ${ 
 fullName 
 } 
 info: 
 ${ 
  JSON 
 
 . 
 stringify 
 ( 
 info 
 , 
  
 null 
 , 
  
 4 
 ) 
 } 
 .` 
 ); 
 }

Node.js

Before trying this sample, follow the Node.js setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub Node.js API reference documentation .

  /** 
 * TODO(developer): Uncomment this variable before running the sample. 
 */ 
 // const schemaNameOrId = 'YOUR_SCHEMA_NAME_OR_ID'; 
 // Imports the Google Cloud client library 
 import 
  
 { 
 PubSub 
 } 
  
 from 
  
 '@google-cloud/pubsub' 
 ; 
 // Creates a client; cache this for further use 
 const 
  
 pubSubClient 
  
 = 
  
 new 
  
 PubSub 
 (); 
 async 
  
 function 
  
 getSchema 
 ( 
 schemaNameOrId 
 : 
  
 string 
 ) 
  
 { 
  
 const 
  
 schema 
  
 = 
  
 pubSubClient 
 . 
 schema 
 ( 
 schemaNameOrId 
 ); 
  
 const 
  
 info 
  
 = 
  
 await 
  
 schema 
 . 
 get 
 (); 
  
 const 
  
 fullName 
  
 = 
  
 await 
  
 schema 
 . 
 getName 
 (); 
  
 console 
 . 
 log 
 ( 
 `Schema 
 ${ 
 fullName 
 } 
 info: 
 ${ 
 JSON 
 . 
 stringify 
 ( 
 info 
 , 
  
 null 
 , 
  
 4 
 ) 
 } 
 .` 
 ); 
 }

PHP

Before trying this sample, follow the PHP setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub PHP API reference documentation .

  use Google\Cloud\PubSub\PubSubClient; 
 /** 
 * Get a schema. 
 * 
 * @param string $projectId 
 * @param string $schemaId 
 */ 
 function get_schema($projectId, $schemaId) 
 { 
 $pubsub = new PubSubClient([ 
 'projectId' => $projectId, 
 ]); 
 $schema = $pubsub->schema($schemaId); 
 $schema->info(); 
 printf('Schema %s retrieved', $schema->name()); 
 }

Python

Before trying this sample, follow the Python setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub Python API reference documentation .

  from 
  
 google.api_core.exceptions 
  
 import 
 NotFound 
 from 
  
 google.cloud.pubsub 
  
 import 
 SchemaServiceClient 
 # TODO(developer): Replace these variables before running the sample. 
 # project_id = "your-project-id" 
 # schema_id = "your-schema-id" 
 # schema_revision_id = "your-schema-revision-id" 
 schema_client 
 = 
 SchemaServiceClient 
 () 
 schema_path 
 = 
 schema_client 
 . 
  schema_path 
 
 ( 
 project_id 
 , 
 schema_id 
 + 
 "@" 
 + 
 schema_revision_id 
 ) 
 try 
 : 
 result 
 = 
 schema_client 
 . 
 get_schema 
 ( 
 request 
 = 
 { 
 "name" 
 : 
 schema_path 
 }) 
 print 
 ( 
 f 
 "Got a schema revision: 
 \n 
 { 
 result 
 } 
 " 
 ) 
 except 
 NotFound 
 : 
 print 
 ( 
 f 
 " 
 { 
 schema_id 
 } 
 not found." 
 )

Ruby

The following sample uses Ruby Pub/Sub client library v3. If you are still using the v2 library, see the migration guide to v3 . To see a list of Ruby v2 code samples, see the deprecated code samples .

Before trying this sample, follow the Ruby setup instructions in Quickstart: Using Client Libraries . For more information, see the Pub/Sub Ruby API reference documentation .

  # schema_id = "your-schema-id" 
 pubsub 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  PubSub 
 
 . 
  new 
 
 schemas 
  
 = 
  
 pubsub 
 . 
 schemas 
 schema 
  
 = 
  
 schemas 
 . 
 get_schema 
  
 name 
 : 
  
 pubsub 
 . 
 schema_path 
 ( 
 schema_id 
 ) 
 puts 
  
 "Schema 
 #{ 
 schema 
 . 
 name 
 } 
 retrieved."

View the details of a schema Stay organized with collections Save and categorize content based on your preferences.

Before you begin

Required roles and permissions

Required permissions

View schema details

Console

gcloud

REST

C++

C#

Go

Java

Node.js

Node.js

PHP

Python

Ruby

What's next

View the details of a schema