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. v1

Variables

_default

_default: {
    v1: typeof v1;
    ManagedSchemaRegistryClient: typeof v1.ManagedSchemaRegistryClient;
}

ManagedSchemaRegistryClient

ManagedSchemaRegistryClient: typeof v1.ManagedSchemaRegistryClient

Type Aliases

ManagedSchemaRegistryClient

type ManagedSchemaRegistryClient = v1.ManagedSchemaRegistryClient;

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.CheckCompatibilityCallback

type CheckCompatibilityCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.CheckCompatibilityResponse) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.CreateSchemaRegistryCallback

type CreateSchemaRegistryCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaRegistry) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.CreateVersionCallback

type CreateVersionCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.CreateVersionResponse) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.DeleteSchemaConfigCallback

type DeleteSchemaConfigCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaConfig) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.DeleteSchemaModeCallback

type DeleteSchemaModeCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaMode) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.DeleteSchemaRegistryCallback

type DeleteSchemaRegistryCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.DeleteSubjectCallback

type DeleteSubjectCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.DeleteVersionCallback

type DeleteVersionCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetContextCallback

type GetContextCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.Context) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetRawSchemaCallback

type GetRawSchemaCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetRawSchemaVersionCallback

type GetRawSchemaVersionCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetSchemaCallback

type GetSchemaCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.Schema) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetSchemaConfigCallback

type GetSchemaConfigCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaConfig) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetSchemaModeCallback

type GetSchemaModeCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaMode) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetSchemaRegistryCallback

type GetSchemaRegistryCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaRegistry) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.GetVersionCallback

type GetVersionCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaVersion) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListContextsCallback

type ListContextsCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListReferencedSchemasCallback

type ListReferencedSchemasCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListSchemaRegistriesCallback

type ListSchemaRegistriesCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.ListSchemaRegistriesResponse) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListSchemaTypesCallback

type ListSchemaTypesCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListSchemaVersionsCallback

type ListSchemaVersionsCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListSubjectsBySchemaIdCallback

type ListSubjectsBySchemaIdCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListSubjectsCallback

type ListSubjectsCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.ListVersionsCallback

type ListVersionsCallback = (error: (Error|null), response?: google.api.HttpBody) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.LookupVersionCallback

type LookupVersionCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaVersion) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.UpdateSchemaConfigCallback

type UpdateSchemaConfigCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaConfig) => void;

Callback as used by .

protos.google.cloud.managedkafka.schemaregistry.v1.ManagedSchemaRegistry.UpdateSchemaModeCallback

type UpdateSchemaModeCallback = (error: (Error|null), response?: google.cloud.managedkafka.schemaregistry.v1.SchemaMode) => void;

Callback as used by .

Package @google-cloud/managedkafka-schemaregistry (0.3.1)

Classes

Interfaces