SchemaRegistry interface
登録済みスキーマのストアを表します。
Azure Schema Registry サービスを使用してスキーマを格納するために SchemaRegistryClient によって実装されます。
メソッド
get |
ID で既存のスキーマを取得します。 |
get |
名前、グループ、型、定義が一致する既存のスキーマの ID を取得します。 |
register |
新しいスキーマを登録し、その ID を返します。 指定した名前のスキーマが指定されたグループに存在しない場合は、バージョン 1 でスキーマが作成されます。 指定した名前のスキーマが既に指定されたグループに存在する場合、スキーマは最新バージョン + 1 で作成されます。 |
メソッドの詳細
getSchema(string, GetSchemaOptions)
ID で既存のスキーマを取得します。
function getSchema(schemaId: string, options?: GetSchemaOptions): Promise<Schema>
パラメーター
- schemaId
-
string
一意のスキーマ ID。
- options
- GetSchemaOptions
戻り値
Promise<Schema>
指定された ID を持つスキーマ。
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)
名前、グループ、型、定義が一致する既存のスキーマの ID を取得します。
function getSchemaProperties(schema: SchemaDescription, options?: GetSchemaPropertiesOptions): Promise<SchemaProperties>
パラメーター
- schema
- SchemaDescription
一致するスキーマ。
- options
- GetSchemaPropertiesOptions
戻り値
Promise<SchemaProperties>
一致したスキーマの ID。
registerSchema(SchemaDescription, RegisterSchemaOptions)
新しいスキーマを登録し、その ID を返します。
指定した名前のスキーマが指定されたグループに存在しない場合は、バージョン 1 でスキーマが作成されます。 指定した名前のスキーマが既に指定されたグループに存在する場合、スキーマは最新バージョン + 1 で作成されます。
function registerSchema(schema: SchemaDescription, options?: RegisterSchemaOptions): Promise<SchemaProperties>
パラメーター
- schema
- SchemaDescription
登録するスキーマ。
- options
- RegisterSchemaOptions
戻り値
Promise<SchemaProperties>
登録済みスキーマの ID。