Package com.azure.data.schemaregistry.apacheavro

Class SchemaRegistryApacheAvroSerializerBuilder

java.lang.Object

com.azure.data.schemaregistry.apacheavro.SchemaRegistryApacheAvroSerializerBuilder

public final class SchemaRegistryApacheAvroSerializerBuilder
extends Object

The builder for instantiating a SchemaRegistryApacheAvroSerializer. Additional code samples are in SchemaRegistryApacheAvroSerializer.

Creating a SchemaRegistryApacheAvroSerializer

 TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
 SchemaRegistryAsyncClient schemaRegistryAsyncClient = new SchemaRegistryClientBuilder()
     .credential(tokenCredential)
     .fullyQualifiedNamespace("{schema-registry-endpoint}")
     .buildAsyncClient();

 // By setting autoRegisterSchema to true, if the schema does not exist in the Schema Registry instance, it is
 // added to the instance. By default, this is false, so it will error if the schema is not found.
 SchemaRegistryApacheAvroSerializer serializer = new SchemaRegistryApacheAvroSerializerBuilder()
     .schemaRegistryAsyncClient(schemaRegistryAsyncClient)
     .autoRegisterSchema(true)
     .schemaGroup("{schema-group}")
     .buildSerializer();
 

See Also:

SchemaRegistryApacheAvroSerializer

Constructor Summary

Constructors

Constructor	Description
SchemaRegistryApacheAvroSerializerBuilder()	Instantiates instance of Builder class.

Method Summary

Modifier and Type	Method	Description
SchemaRegistryApacheAvroSerializerBuilder	autoRegisterSchema(boolean autoRegisterSchemas)	If specified true, serializer will register schemas against Azure Schema Registry service under the specified group.
SchemaRegistryApacheAvroSerializerBuilder	avroSpecificReader(boolean avroSpecificReader)	Specifies if objects should be deserialized into Avro SpecificRecord via Avro's SpecificDatumReader.
SchemaRegistryApacheAvroSerializer	buildSerializer()	Creates a new instance of Schema Registry serializer.
SchemaRegistryApacheAvroSerializerBuilder	schemaGroup(String schemaGroup)	Specifies schema group for interacting with Azure Schema Registry service.
SchemaRegistryApacheAvroSerializerBuilder	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

SchemaRegistryApacheAvroSerializerBuilder

public SchemaRegistryApacheAvroSerializerBuilder()

Instantiates instance of Builder class. Supplies client defaults.

Method Detail

schemaGroup

public SchemaRegistryApacheAvroSerializerBuilder schemaGroup(String schemaGroup)

Specifies schema group for interacting with Azure Schema Registry service. This is optional unless autoRegisterSchema is set to true. 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 SchemaRegistryApacheAvroSerializerBuilder instance

autoRegisterSchema

public SchemaRegistryApacheAvroSerializerBuilder 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 SchemaRegistryApacheAvroSerializerBuilder instance

avroSpecificReader

public SchemaRegistryApacheAvroSerializerBuilder avroSpecificReader(boolean avroSpecificReader)

Specifies if objects should be deserialized into Avro SpecificRecord via Avro's SpecificDatumReader.

Parameters:

avroSpecificReader - true to deserialize into SpecificRecord via SpecificDatumReader; false otherwise.

Returns:

updated SchemaRegistryApacheAvroSerializerBuilder instance.

schemaRegistryAsyncClient

public SchemaRegistryApacheAvroSerializerBuilder schemaRegistryAsyncClient(SchemaRegistryAsyncClient schemaRegistryAsyncClient)

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

Parameters:

schemaRegistryAsyncClient - The SchemaRegistryAsyncClient.

Returns:

updated SchemaRegistryApacheAvroSerializerBuilder instance.

buildSerializer

public SchemaRegistryApacheAvroSerializer buildSerializer()

Creates a new instance of Schema Registry serializer.

Returns:

A new instance of SchemaRegistryApacheAvroSerializer.

Throws:

NullPointerException - if schemaRegistryAsyncClient(SchemaRegistryAsyncClient) is null

IllegalStateException - if autoRegisterSchema(boolean) is true but schemaGroup is null.