com.microsoft.azure.schemaregistry.kafka.avro

Class KafkaAvroSerializerConfig

java.lang.Object

com.microsoft.azure.schemaregistry.kafka.avro.KafkaAvroSerializerConfig

public final class KafkaAvroSerializerConfig
extends Object

Class containing configuration properties for KafkaAvroSerializer class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_REGISTER_SCHEMAS_CONFIG If specified true, serializer will register schemas against Azure Schema Registry service under the specified group.
static Boolean	AUTO_REGISTER_SCHEMAS_CONFIG_DEFAULT
static String	MAX_SCHEMA_MAP_SIZE_CONFIG Schema cache size limit on underlying SchemaRegistryClient.
static Integer	MAX_SCHEMA_MAP_SIZE_CONFIG_DEFAULT
static String	SCHEMA_GROUP_CONFIG Specifies schema group for interacting with Azure Schema Registry service.
static String	SCHEMA_REGISTRY_CREDENTIAL_CONFIG Required.
static String	SCHEMA_REGISTRY_URL_CONFIG Required.

Method Summary

Modifier and Type	Method and Description
Boolean	getAutoRegisterSchemas()
com.azure.core.credential.TokenCredential	getCredential()
Integer	getMaxSchemaMapSize()
Map<String,Object>	getProps()
String	getSchemaGroup()
String	getSchemaRegistryUrl()

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_REGISTER_SCHEMAS_CONFIG

public static final String AUTO_REGISTER_SCHEMAS_CONFIG

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. Requires type String.

See Also:

Constant Field Values

AUTO_REGISTER_SCHEMAS_CONFIG_DEFAULT

public static final Boolean AUTO_REGISTER_SCHEMAS_CONFIG_DEFAULT

SCHEMA_GROUP_CONFIG

public static final String SCHEMA_GROUP_CONFIG

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.

See Also:

Constant Field Values

SCHEMA_REGISTRY_URL_CONFIG

public static final String SCHEMA_REGISTRY_URL_CONFIG

Required. Sets the service endpoint for the Azure Schema Registry instance

See Also:

Constant Field Values

SCHEMA_REGISTRY_CREDENTIAL_CONFIG

public static final String SCHEMA_REGISTRY_CREDENTIAL_CONFIG

Required. Sets the TokenCredential to use when authenticating HTTP requests for this * SchemaRegistryClient.

See Also:

Constant Field Values

MAX_SCHEMA_MAP_SIZE_CONFIG

public static final String MAX_SCHEMA_MAP_SIZE_CONFIG

Schema cache size limit on underlying SchemaRegistryClient. If limit is exceeded on any cache, all caches are recycled.

See Also:

Constant Field Values

MAX_SCHEMA_MAP_SIZE_CONFIG_DEFAULT

public static final Integer MAX_SCHEMA_MAP_SIZE_CONFIG_DEFAULT

Method Detail

getAutoRegisterSchemas

public Boolean getAutoRegisterSchemas()

Returns:

auto-registration flag, with default set to false

getSchemaGroup

public String getSchemaGroup()

Returns:

schema group

getProps

public Map<String,Object> getProps()

getSchemaRegistryUrl

public String getSchemaRegistryUrl()

getCredential

public com.azure.core.credential.TokenCredential getCredential()

getMaxSchemaMapSize

public Integer getMaxSchemaMapSize()