Class SchemaRegistryClient

Package version

Client for Azure Schema Registry service.

Hierarchy

SchemaRegistryClient

Implements

SchemaRegistry

Index

Constructors

constructor

Properties

endpoint

Methods

Constructors

constructor

new SchemaRegistryClient(endpoint: string, credential: TokenCredential, options?: SchemaRegistryClientOptions): SchemaRegistryClient

- Defined in schemaRegistryClient.ts:29
Creates a new client for Azure Schema Registry service.

Parameters
- endpoint: string
  
  The Schema Registry service endpoint URL, for example https://mynamespace.servicebus.windows.net.
- credential: TokenCredential
  
  Credential to authenticate requests to the service.
- Default value options: SchemaRegistryClientOptions = {}
  
  Options to configure API requests to the service.
Returns SchemaRegistryClient

Properties

endpoint

endpoint: string

The Schema Registry service endpoint URL.

Methods

getSchemaById

getSchemaById(id: string, options?: GetSchemaByIdOptions): Promise<Schema>

Implementation of SchemaRegistry.getSchemaById
- Defined in schemaRegistryClient.ts:104
Gets the ID of an existing schema with matching name, group, type, and content.

Parameters
- id: string
- Optional options: GetSchemaByIdOptions
Returns Promise<Schema>

Matched schema's ID.

getSchemaId

getSchemaId(schema: SchemaDescription, options?: GetSchemaIdOptions): Promise<SchemaId>

Implementation of SchemaRegistry.getSchemaId
- Defined in schemaRegistryClient.ts:83
Gets the ID of an existing schema with matching name, group, type, and content.

Parameters
- schema: SchemaDescription
  
  Schema to match.
- Optional options: GetSchemaIdOptions
Returns Promise<SchemaId>

Matched schema's ID.

registerSchema

registerSchema(schema: SchemaDescription, options?: RegisterSchemaOptions): Promise<SchemaId>

Implementation of SchemaRegistry.registerSchema
- Defined in schemaRegistryClient.ts:59
Registers a new schema and returns its ID.

If schema of specified name does not exist in the specified group, a schema is created at version 1. If schema of specified name exists already in specified group, schema is created at latest version + 1.

Parameters
- schema: SchemaDescription
  
  Schema to register.
- Optional options: RegisterSchemaOptions
Returns Promise<SchemaId>

Registered schema's ID.

Generated using TypeDoc