SchemaRegistry is a service that allows users to manage schemas for
their Kafka clusters. It provides APIs to register, list, and delete
schemas, as well as to get the schema for a given schema id or a
given version id under a subject, to update the global or
subject-specific compatibility mode, and to check the compatibility
of a schema against a subject or a version. The main resource
hierarchy is as follows:
SchemaRegistry
SchemaRegistry/Context
SchemaRegistry/Context/Schema
SchemaRegistry/Context/Subject
SchemaRegistry/Context/Subject/Version
SchemaRegistry/Config
SchemaRegistry/Mode
SchemaRegistry is the root resource to represent a schema
registry instance. A customer can have multiple schema registry
instances in a project.
Context is a context resource that represents a group of
schemas, subjects and versions. A schema registry instance can have
multiple contexts and always has a 'default' context. Contexts are
independent of each other. Context is optional and if not specified,
it falls back to the 'default' context.
Schema is a schema resource that represents a unique schema in a
context of a schema registry instance. Each schema has a unique
schema id, and can be referenced by a version of a subject.
Subject refers to the name under which the schema is registered.
A typical subject is the Kafka topic name. A schema registry
instance can have multiple subjects.
Version represents a version of a subject. A subject can have
multiple versions. Creation of new version of a subject is guarded
by the compatibility mode configured globally or for the subject
specifically.
Config represents a config at global level cross all registry
instances or at subject level. Currently, only compatibility is
supported in config.
Mode represents the mode of a schema registry or a specific
subject. Three modes are supported:
READONLY: The schema registry is in read-only mode, no write
operations allowed..
READWRITE: The schema registry is in read-write mode, which
allows limited write operations on the schema.
IMPORT: The schema registry is in import mode, which allows more
editing operations on the schema for data importing purposes.
SchemaRegistry is a service that allows users to manage schemas for
their Kafka clusters. It provides APIs to register, list, and delete
schemas, as well as to get the schema for a given schema id or a
given version id under a subject, to update the global or
subject-specific compatibility mode, and to check the compatibility
of a schema against a subject or a version. The main resource
hierarchy is as follows:
SchemaRegistry
SchemaRegistry/Context
SchemaRegistry/Context/Schema
SchemaRegistry/Context/Subject
SchemaRegistry/Context/Subject/Version
SchemaRegistry/Config
SchemaRegistry/Mode
SchemaRegistry is the root resource to represent a schema
registry instance. A customer can have multiple schema registry
instances in a project.
Context is a context resource that represents a group of
schemas, subjects and versions. A schema registry instance can have
multiple contexts and always has a 'default' context. Contexts are
independent of each other. Context is optional and if not specified,
it falls back to the 'default' context.
Schema is a schema resource that represents a unique schema in a
context of a schema registry instance. Each schema has a unique
schema id, and can be referenced by a version of a subject.
Subject refers to the name under which the schema is registered.
A typical subject is the Kafka topic name. A schema registry
instance can have multiple subjects.
Version represents a version of a subject. A subject can have
multiple versions. Creation of new version of a subject is guarded
by the compatibility mode configured globally or for the subject
specifically.
Config represents a config at global level cross all registry
instances or at subject level. Currently, only compatibility is
supported in config.
Mode represents the mode of a schema registry or a specific
subject. Three modes are supported:
READONLY: The schema registry is in read-only mode, no write
operations allowed..
READWRITE: The schema registry is in read-write mode, which
allows limited write operations on the schema.
IMPORT: The schema registry is in import mode, which allows more
editing operations on the schema for data importing purposes.
[[["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-09-04 UTC."],[],[],null,["# Package managed_schema_registry (0.1.0)\n\nAPI documentation for `managedkafka_schemaregistry_v1.services.managed_schema_registry` package. \n\nClasses\n-------\n\n### [ManagedSchemaRegistryAsyncClient](/python/docs/reference/google-cloud-managedkafka-schemaregistry/latest/google.cloud.managedkafka_schemaregistry_v1.services.managed_schema_registry.ManagedSchemaRegistryAsyncClient)\n\nSchemaRegistry is a service that allows users to manage schemas for\ntheir Kafka clusters. It provides APIs to register, list, and delete\nschemas, as well as to get the schema for a given schema id or a\ngiven version id under a subject, to update the global or\nsubject-specific compatibility mode, and to check the compatibility\nof a schema against a subject or a version. The main resource\nhierarchy is as follows:\n\n- SchemaRegistry\n- SchemaRegistry/Context\n- SchemaRegistry/Context/Schema\n- SchemaRegistry/Context/Subject\n- SchemaRegistry/Context/Subject/Version\n- SchemaRegistry/Config\n- SchemaRegistry/Mode\n\n**SchemaRegistry** is the root resource to represent a schema\nregistry instance. A customer can have multiple schema registry\ninstances in a project.\n\n**Context** is a context resource that represents a group of\nschemas, subjects and versions. A schema registry instance can have\nmultiple contexts and always has a 'default' context. Contexts are\nindependent of each other. Context is optional and if not specified,\nit falls back to the 'default' context.\n\n**Schema** is a schema resource that represents a unique schema in a\ncontext of a schema registry instance. Each schema has a unique\nschema id, and can be referenced by a version of a subject.\n\n**Subject** refers to the name under which the schema is registered.\nA typical subject is the Kafka topic name. A schema registry\ninstance can have multiple subjects.\n\n**Version** represents a version of a subject. A subject can have\nmultiple versions. Creation of new version of a subject is guarded\nby the compatibility mode configured globally or for the subject\nspecifically.\n\n**Config** represents a config at global level cross all registry\ninstances or at subject level. Currently, only compatibility is\nsupported in config.\n\n**Mode** represents the mode of a schema registry or a specific\nsubject. Three modes are supported:\n\n- READONLY: The schema registry is in read-only mode, no write operations allowed..\n- READWRITE: The schema registry is in read-write mode, which allows limited write operations on the schema.\n- IMPORT: The schema registry is in import mode, which allows more editing operations on the schema for data importing purposes.\n\n### [ManagedSchemaRegistryClient](/python/docs/reference/google-cloud-managedkafka-schemaregistry/latest/google.cloud.managedkafka_schemaregistry_v1.services.managed_schema_registry.ManagedSchemaRegistryClient)\n\nSchemaRegistry is a service that allows users to manage schemas for\ntheir Kafka clusters. It provides APIs to register, list, and delete\nschemas, as well as to get the schema for a given schema id or a\ngiven version id under a subject, to update the global or\nsubject-specific compatibility mode, and to check the compatibility\nof a schema against a subject or a version. The main resource\nhierarchy is as follows:\n\n- SchemaRegistry\n- SchemaRegistry/Context\n- SchemaRegistry/Context/Schema\n- SchemaRegistry/Context/Subject\n- SchemaRegistry/Context/Subject/Version\n- SchemaRegistry/Config\n- SchemaRegistry/Mode\n\n**SchemaRegistry** is the root resource to represent a schema\nregistry instance. A customer can have multiple schema registry\ninstances in a project.\n\n**Context** is a context resource that represents a group of\nschemas, subjects and versions. A schema registry instance can have\nmultiple contexts and always has a 'default' context. Contexts are\nindependent of each other. Context is optional and if not specified,\nit falls back to the 'default' context.\n\n**Schema** is a schema resource that represents a unique schema in a\ncontext of a schema registry instance. Each schema has a unique\nschema id, and can be referenced by a version of a subject.\n\n**Subject** refers to the name under which the schema is registered.\nA typical subject is the Kafka topic name. A schema registry\ninstance can have multiple subjects.\n\n**Version** represents a version of a subject. A subject can have\nmultiple versions. Creation of new version of a subject is guarded\nby the compatibility mode configured globally or for the subject\nspecifically.\n\n**Config** represents a config at global level cross all registry\ninstances or at subject level. Currently, only compatibility is\nsupported in config.\n\n**Mode** represents the mode of a schema registry or a specific\nsubject. Three modes are supported:\n\n- READONLY: The schema registry is in read-only mode, no write operations allowed..\n- READWRITE: The schema registry is in read-write mode, which allows limited write operations on the schema.\n- IMPORT: The schema registry is in import mode, which allows more editing operations on the schema for data importing purposes."]]
