SchemaRegistry interface
Representa um arquivo de esquemas registados.
Implementado por SchemaRegistryClient para armazenar os esquemas com o serviço Azure Schema Registry.
Métodos
| get |
Obtém um esquema existente por ID. |
| get |
Obtém o ID de um esquema existente com o nome, grupo, tipo e definição correspondentes. |
| register |
Regista um novo esquema e devolve o respetivo ID. Se o esquema do nome especificado não existir no grupo especificado, é criado um esquema na versão 1. Se o esquema do nome especificado já existir no grupo especificado, o esquema é criado na versão mais recente + 1. |
Detalhes de Método
getSchema(string, GetSchemaOptions)
Obtém um esquema existente por ID.
function getSchema(schemaId: string, options?: GetSchemaOptions): Promise<Schema>Parâmetros
- schemaId
-
string
ID de esquema exclusivo.
- options
- GetSchemaOptions
Devoluções
Promise<Schema>
Esquema com um determinado ID.
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)
Obtém o ID de um esquema existente com o nome, grupo, tipo e definição correspondentes.
function getSchemaProperties(schema: SchemaDescription, options?: GetSchemaPropertiesOptions): Promise<SchemaProperties>Parâmetros
- schema
- SchemaDescription
Esquema a corresponder.
- options
- GetSchemaPropertiesOptions
Devoluções
Promise<SchemaProperties>
ID do esquema correspondente.
registerSchema(SchemaDescription, RegisterSchemaOptions)
Regista um novo esquema e devolve o respetivo ID.
Se o esquema do nome especificado não existir no grupo especificado, é criado um esquema na versão 1. Se o esquema do nome especificado já existir no grupo especificado, o esquema é criado na versão mais recente + 1.
function registerSchema(schema: SchemaDescription, options?: RegisterSchemaOptions): Promise<SchemaProperties>Parâmetros
- schema
- SchemaDescription
Esquema a registar.
- options
- RegisterSchemaOptions
Devoluções
Promise<SchemaProperties>
ID do esquema registado.