package google.cloud.managedkafka.schemaregistry.v1
Get desktop application:
View/edit binary Protocol Buffers messages
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.
Check compatibility of a schema with all versions or a specific version of a subject.
message
schema_registry.proto:756Request for CheckCompatibility.
string name = 1
Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject.
optional Schema.SchemaType schema_type = 2
Optional. The schema type of the schema.
string schema = 3
Required. The schema payload
repeated references = 4
Optional. The schema references used by the schema.
optional bool verbose = 5
Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
message
schema_registry.proto:785Response for CheckCompatibility.
bool is_compatible = 1
The compatibility check result. If true, the schema is compatible with the resource.
repeated string messages = 2
Failure reasons if verbose = true.
Create a schema registry instance.
message
schema_registry.proto:431Request to create a schema registry instance.
string parent = 1
Required. The parent whose schema registry instance is to be created. Structured like: `projects/{project}/locations/{location}`
string schema_registry_id = 2
Required. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number.
optional schema_registry = 3
Required. The schema registry instance to create. The name field is ignored.
Register a new version under a given subject with the given schema.
message
schema_registry.proto:640Request for CreateVersion.
string parent = 1
Required. The subject to create the version for. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
optional int32 version = 2
Optional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.
optional int32 id = 3
Optional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.
optional Schema.SchemaType schema_type = 4
Optional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.
string schema = 5
Required. The schema payload
repeated references = 6
Optional. The schema references used by the schema.
optional bool normalize = 7
Optional. If true, the schema will be normalized before being stored. The default is false.
message
schema_registry.proto:681Response for CreateVersion.
int32 id = 1
The unique identifier of the schema created.
Delete schema config for a subject.
message
schema_registry.proto:842Request for deleting schema config.
string name = 1
Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}
Delete schema mode for a subject.
message
schema_registry.proto:884Request for deleting schema mode.
string name = 1
Required. The resource name of subject to delete the mode for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject} * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}
Delete a schema registry instance.
message
schema_registry.proto:451Request for DeleteSchemaRegistry.
string name = 1
Required. The name of the schema registry instance to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Delete a subject. The response will be an array of versions of the deleted subject.
message
schema_registry.proto:600Request for DeleteSubject.
string name = 1
Required. The name of the subject to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
optional bool permanent = 2
Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.
Delete a version of a subject. The response will be the deleted version id.
message
schema_registry.proto:721Request for DeleteVersion.
string name = 1
Required. The name of the subject version to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
optional bool permanent = 2
Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.
rpc GetContext (, )
schema_registry.proto:126Get the context.
message
schema_registry.proto:464Request for GetContext
string name = 1
Required. The name of the context to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`
Context represents an independent schema grouping in a schema registry instance.
string name = 1
Identifier. The name of the context. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}` The context name {context} can contain the following: * Up to 255 characters. * Allowed characters: letters (uppercase or lowercase), numbers, and the following special characters: `.`, `-`, `_`, `+`, `%`, and `~`.
repeated string subjects = 2
Optional. The subjects of the context.
Get the schema string for the given schema id. The response will be the schema string.
Get the schema string only for a version of a subject. The response will be the schema string.
rpc GetSchema (, )
schema_registry.proto:142Get the schema for the given schema id.
Schema for a Kafka message.
Schema.SchemaType schema_type = 1
Optional. The schema type of the schema.
string schema_payload = 2
The schema payload.
repeated references = 3
Optional. The schema references used by the schema.
Get schema config at global level or for a subject.
message
schema_registry.proto:795Request for getting config.
string name = 1
Required. The resource name to get the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Get config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Get config for a specific subject.
optional bool default_to_global = 2
Optional. If true, the config will fall back to the config at the global level if no subject level config is found.
Get mode at global level or for a subject.
message
schema_registry.proto:855Request for getting schema registry or subject mode.
string name = 1
Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
Get the schema registry instance.
message
schema_registry.proto:402Request for GetSchemaRegistry.
string name = 1
Required. The name of the schema registry instance to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
rpc GetVersion (, )
schema_registry.proto:241Get a versioned schema (schema with subject/version) of a subject.
List contexts for a schema registry.
message
schema_registry.proto:476Request for ListContexts.
string parent = 1
Required. The parent of the contexts. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Get a list of IDs of schemas that reference the schema with the given subject and version.
message
schema_registry.proto:742Request for ListReferencedSchemas.
string parent = 1
Required. The version to list referenced by. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
List schema registries.
message
schema_registry.proto:415Request for ListSchemaRegistries.
string parent = 1
Required. The parent whose schema registry instances are to be listed. Structured like: `projects/{project}/locations/{location}`
message
schema_registry.proto:425Request for ListSchemaRegistries.
repeated schema_registries = 1
The schema registry instances.
List the supported schema types. The response will be an array of schema types.
message
schema_registry.proto:505Request for ListSchemaTypes.
string parent = 1
Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{"subject":"subject1", "version":1}, {"subject":"subject2", "version":2}].
message
schema_registry.proto:516Request for ListSchemaVersions.
string parent = 1
Required. The schema whose schema versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`
optional string subject = 2
Optional. The subject to filter the subjects by.
optional bool deleted = 3
Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.
List subjects in the schema registry. The response will be an array of subject names.
message
schema_registry.proto:538Request for listing subjects.
string parent = 1
Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`
optional string subject_prefix = 2
Optional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
optional bool deleted = 3
Optional. If true, the response will include soft-deleted subjects. The default is false.
List subjects which reference a particular schema id. The response will be an array of subject names.
message
schema_registry.proto:562Request for listing subjects.
string parent = 1
Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`
optional string subject = 2
Optional. The subject to filter the subjects by.
optional bool deleted = 3
Optional. If true, the response will include soft-deleted subjects. The default is false.
Get all versions of a subject. The response will be an array of versions of the subject.
message
schema_registry.proto:582Request for GetVersions.
string parent = 1
Required. The subject whose versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
optional bool deleted = 2
Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.
Lookup a schema under the specified subject.
message
schema_registry.proto:687Request for LookupVersion.
string parent = 1
Required. The subject to lookup the schema in. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
optional Schema.SchemaType schema_type = 2
Optional. The schema type of the schema.
string schema = 3
Required. The schema payload
repeated references = 4
Optional. The schema references used by the schema.
optional bool normalize = 5
Optional. If true, the schema will be normalized before being looked up. The default is false.
optional bool deleted = 6
Optional. If true, soft-deleted versions will be included in lookup, no matter if the subject is active or soft-deleted. If false, soft-deleted versions will be excluded. The default is false.
Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.
message
schema_registry.proto:815Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.
string name = 1
Required. The resource name to update the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject.
optional SchemaConfig.CompatibilityType compatibility = 2
Required. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
optional bool normalize = 3
Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.
Update mode at global level or for a subject.
message
schema_registry.proto:868Request for updating schema registry or subject mode.
string name = 1
Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
SchemaMode.ModeType mode = 2
Required. The mode type.
message
schema_registry.proto:488Request for GetSchema.
Used as request type in: ManagedSchemaRegistry.GetRawSchema, ManagedSchemaRegistry.GetSchema
string name = 1
Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`
optional string subject = 2
Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
message
schema_registry.proto:621Request for GetVersion.
Used as request type in: ManagedSchemaRegistry.GetRawSchemaVersion, ManagedSchemaRegistry.GetVersion
string name = 1
Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
optional bool deleted = 2
Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
SchemaReference is a reference to a schema.
Used in: , , , ,
string name = 1
Required. The name of the reference.
string subject = 2
Required. The subject of the reference.
int32 version = 3
Required. The version of the reference.
Schema types.
Used in: , , , ,
SCHEMA_TYPE_UNSPECIFIED = 0
No schema type. The default will be AVRO.
AVRO = 1
Avro schema type.
JSON = 2
JSON schema type.
PROTOBUF = 3
Protobuf schema type.
SchemaConfig represents configuration for a schema registry or a specific subject.
Used as response type in: ManagedSchemaRegistry.DeleteSchemaConfig, ManagedSchemaRegistry.GetSchemaConfig, ManagedSchemaRegistry.UpdateSchemaConfig
optional SchemaConfig.CompatibilityType compatibility = 1
Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
optional bool normalize = 2
Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
string alias = 3
Optional. The subject to which this subject is an alias of. Only applicable for subject config.
Compatibility type of the schemas.
Used in: ,
NONE = 0
No compatibility check.
BACKWARD = 1
Backwards compatible with the most recent version.
BACKWARD_TRANSITIVE = 2
Backwards compatible with all previous versions.
FORWARD = 3
Forwards compatible with the most recent version.
FORWARD_TRANSITIVE = 4
Forwards compatible with all previous versions.
FULL = 5
Backwards and forwards compatible with the most recent version.
FULL_TRANSITIVE = 6
Backwards and forwards compatible with all previous versions.
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.
Used as response type in: ManagedSchemaRegistry.DeleteSchemaMode, ManagedSchemaRegistry.GetSchemaMode, ManagedSchemaRegistry.UpdateSchemaMode
SchemaMode.ModeType mode = 1
Required. The mode type of a schema registry (READWRITE by default) or of a subject (unset by default, which means use the global schema registry setting).
Mode type of the schemas or subjects.
Used in: ,
NONE = 0
The default / unset value. The subject mode is NONE/unset by default, which means use the global schema registry mode. This should not be used for setting the mode.
READONLY = 1
READONLY mode.
READWRITE = 2
READWRITE mode.
IMPORT = 3
IMPORT mode.
SchemaRegistry is a schema registry instance.
Used as response type in: ManagedSchemaRegistry.CreateSchemaRegistry, ManagedSchemaRegistry.GetSchemaRegistry
Used as field type in: ,
string name = 1
Identifier. The name of the schema registry instance. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` The instance name {schema_registry} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores.
repeated string contexts = 2
Output only. The contexts of the schema registry instance.
Subject defines the evolution scope of schemas as a holder of schema versions.
string name = 1
The name of the subject. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}` Subject name {subject} can contain the following: * Up to 255 UTF-8 bytes. * Allowed characters: letters (uppercase or lowercase), numbers, and the following special characters: `.`, `-`, `_`, `+`, `%`, and `~`.
repeated string versions = 3
The versions of the subject.
Version of a schema.
Used as response type in: ManagedSchemaRegistry.GetVersion, ManagedSchemaRegistry.LookupVersion
string subject = 1
Required. The subject of the version.
int32 version_id = 2
Required. The version ID
int32 schema_id = 3
Required. The schema ID.
Schema.SchemaType schema_type = 4
Optional. The schema type of the schema.
string schema_payload = 5
Required. The schema payload.
repeated references = 6
Optional. The schema references used by the schema.