REST Resource: projects.locations.schemaRegistries.config

Resource: SchemaConfig

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

JSON representation
{
  "alias": string,
  "compatibility": enum (CompatibilityType),
  "normalize": boolean
}
Fields
alias

string

Optional. The subject to which this subject is an alias of. Only applicable for subject config.

compatibility

enum (CompatibilityType)

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.

normalize

boolean

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.

CompatibilityType

Compatibility type of the schemas.

Enums
NONE No compatibility check.
BACKWARD Backwards compatible with the most recent version.
BACKWARD_TRANSITIVE Backwards compatible with all previous versions.
FORWARD Forwards compatible with the most recent version.
FORWARD_TRANSITIVE Forwards compatible with all previous versions.
FULL Backwards and forwards compatible with the most recent version.
FULL_TRANSITIVE Backwards and forwards compatible with all previous versions.

Methods

delete

Delete schema config for a subject.

get

Get schema config at global level or for a subject.

update

Update config at global level or for a subject.