Package Classes (0.1.0)

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.

Request for CheckCompatibility.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response for CheckCompatibility.

Context represents an independent schema grouping in a schema registry instance.

Request to create a schema registry instance.

Request for CreateVersion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response for CreateVersion.

Request for deleting schema config.

Request for deleting schema mode.

Request for DeleteSchemaRegistry.

Request for DeleteSubject.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for DeleteVersion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for GetContext

Request for getting config.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for getting schema registry or subject mode.

Request for GetSchemaRegistry.

Request for GetSchema.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for GetVersion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for ListContexts.

Request for ListReferencedSchemas.

Request for ListSchemaRegistries.

Request for ListSchemaRegistries.

Request for ListSchemaTypes.

Request for ListSchemaVersions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for listing subjects.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for listing subjects.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for GetVersions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for LookupVersion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Schema for a Kafka message.

SchemaReference is a reference to a schema.

Schema types.

SchemaConfig represents configuration for a schema registry or a specific subject.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Compatibility type of the schemas.

SchemaMode represents the mode of a schema registry or a specific subject. Four modes are supported:

• NONE: deprecated. This was the default mode for a subject, but now the default is unset (which means use the global schema registry setting)
• READONLY: The schema registry is in read-only mode.
• 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.

Mode type of the schemas or subjects.

SchemaRegistry is a schema registry instance.

Subject defines the evolution scope of schemas as a holder of schema versions.

Version of a schema.

Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for updating schema registry or subject mode.