com.azure.data.schemaregistry.avro

Class SchemaRegistryAvroSerializerBuilder

java.lang.Object

com.azure.data.schemaregistry.avro.SchemaRegistryAvroSerializerBuilder

public final class SchemaRegistryAvroSerializerBuilder
extends Object

Builder implementation for building SchemaRegistryAvroSerializer and SchemaRegistryAvroSerializer

Constructor Summary

Constructors

Constructor and Description
SchemaRegistryAvroSerializerBuilder() Instantiates instance of Builder class.

Method Summary

Modifier and Type	Method and Description
SchemaRegistryAvroSerializerBuilder	autoRegisterSchema(boolean autoRegisterSchemas) If specified true, serializer will register schemas against Azure Schema Registry service under the specified group.
SchemaRegistryAvroSerializerBuilder	avroSpecificReader(boolean avroSpecificReader) Specifies if objects should be deserialized into Avro SpecificRecords via Avro SpecificDatumReader
SchemaRegistryAvroSerializer	buildSerializer() Instantiates SchemaRegistry avro serializer.
SchemaRegistryAvroSerializerBuilder	schemaGroup(String schemaGroup) Specifies schema group for interacting with Azure Schema Registry service.
SchemaRegistryAvroSerializerBuilder	schemaRegistryAsyncClient(SchemaRegistryAsyncClient schemaRegistryAsyncClient) The SchemaRegistryAsyncClient to use to interact with the Schema Registry service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaRegistryAvroSerializerBuilder

public SchemaRegistryAvroSerializerBuilder()

Instantiates instance of Builder class. Supplies client defaults.

Method Detail

schemaGroup

public SchemaRegistryAvroSerializerBuilder schemaGroup(String schemaGroup)

Specifies schema group for interacting with Azure Schema Registry service. If auto-registering schemas, schema will be stored under this group. If not auto-registering, serializer will request schema ID for matching data schema under specified group.

Parameters:

schemaGroup - Azure Schema Registry schema group

Returns:

updated SchemaRegistryAvroSerializerBuilder instance

autoRegisterSchema

public SchemaRegistryAvroSerializerBuilder autoRegisterSchema(boolean autoRegisterSchemas)

If specified true, serializer will register schemas against Azure Schema Registry service under the specified group. See Azure Schema Registry documentation for a description of schema registration behavior. If specified false, serializer will simply query the service for an existing ID given schema content. Serialization will fail if the schema has not been pre-created. Auto-registration is **NOT RECOMMENDED** for production scenarios.

Parameters:

autoRegisterSchemas - flag for schema auto-registration

Returns:

updated SchemaRegistryAvroSerializerBuilder instance

avroSpecificReader

public SchemaRegistryAvroSerializerBuilder avroSpecificReader(boolean avroSpecificReader)

Specifies if objects should be deserialized into Avro SpecificRecords via Avro SpecificDatumReader

Parameters:

avroSpecificReader - specific reader flag

Returns:

updated SchemaRegistryAvroSerializerBuilder instance

schemaRegistryAsyncClient

public SchemaRegistryAvroSerializerBuilder schemaRegistryAsyncClient(SchemaRegistryAsyncClient schemaRegistryAsyncClient)

The SchemaRegistryAsyncClient to use to interact with the Schema Registry service.

Parameters:

schemaRegistryAsyncClient - The SchemaRegistryAsyncClient.

Returns:

updated SchemaRegistryAvroSerializerBuilder instance.

buildSerializer

public SchemaRegistryAvroSerializer buildSerializer()

Instantiates SchemaRegistry avro serializer.

Returns:

SchemaRegistryAvroSerializer instance

Throws:

NullPointerException - if parameters are incorrectly set.

IllegalArgumentException - if credential is not set.