ConfluentSchemaRegistry Section

The "ConfluentSchemaRegistry" section provides configuration for the centralized repository for managing and validating schemas used for topic message data, as well as for the serialization and deserialization of data over the network.

"ConfluentSchemaRegistry" : {
   "Endpoint" : "<confluent-schema‑registry‑endpoint>",
   "SchemaFormat" : "Json",
   "Authentication" : {
      "Type" : "ApiKey",
      "ApiKeyName" : "1234567890",
      "ApiKeyValue" : "ABCDEFEGGHIJKLMNOPQRSTUVWXYZ1234567890+" },
   "RetryOptions" : { "MaxRetries" : 3 }
}

Only one of the "ConfluentSchemaRegistry" or "AzureSchemaRegistry" sections is expected, based on the SchemaRegistryType specified in the "Modules" section.

The "ConfluentSchemaRegistry" section parameters are listed in the following table.

Parameter Required? Description
Endpoint Yes URL endpoint of your Confluent Schema Registry, which is typically in the format https://<your‑namespace>.confluent.cloud.
SchemaFormat Yes Format that the schema files describe. Currently only "Json" is supported.
Authentication Yes

The ConfluentSchemaRegistry section Authentication parameter Type can be one of the following.

  • ApiKey

    The ApiKey is different from the one used to connect to the Confluent Kafka Sender.

  • ConfluentOAuth2

For details, see "Type‑Specific Parameters", later in this chapter.

RetryOptions No

Can be used to configure the retry behavior of the transport mechanism used to communicate with the Confluent Schema Registry. It allows fine‑tuning of the retry mechanism to make the availability of the service more resilient. The retry options are:

  • "MaxRetries" is the maximum number of retry attempts before reporting an error. The default value is 3.

  • "RetryDelay" is the minimum delay in milliseconds between retry attempts. The default value is 800 milliseconds.

  • "MaxRetryDelay" is the maximum delay in milliseconds between retry attempts. The default value is 60 seconds.

  • "StatusCodes" is the HTTP status codes that indicate when an operation should be retried. The default values are HTTP status codes RequestTimeout(408), InternalServerError(500), BadGateway(502), ServiceUnavailable(503), GatewayTimeout(504).