Constant Field Values

Contents

• io.confluent.*

io.confluent.*

io.confluent.kafka.formatter.SchemaMessageReader<T>

Modifier and Type	Constant Field	Value
public static final String	KEY_SCHEMA	"key.schema"
public static final String	VALUE_SCHEMA	"value.schema"

io.confluent.kafka.serializers.AbstractKafkaSchemaSerDe

Modifier and Type	Constant Field	Value
protected static final int	DEFAULT_CACHE_CAPACITY	1000
protected static final int	idSize	4
protected static final byte	MAGIC_BYTE	0

io.confluent.kafka.serializers.AbstractKafkaSchemaSerDeConfig

Modifier and Type	Constant Field	Value
public static final String	AUTO_REGISTER_SCHEMAS	"auto.register.schemas"
public static final boolean	AUTO_REGISTER_SCHEMAS_DEFAULT	true
public static final String	AUTO_REGISTER_SCHEMAS_DOC	"Specify if the Serializer should attempt to register the Schema with Schema Registry"
public static final String	BASIC_AUTH_CREDENTIALS_SOURCE	"basic.auth.credentials.source"
public static final String	BASIC_AUTH_CREDENTIALS_SOURCE_DEFAULT	"URL"
public static final String	BASIC_AUTH_CREDENTIALS_SOURCE_DOC	"Specify how to pick the credentials for Basic Auth header. The supported values are URL, USER_INFO and SASL_INHERIT"
public static final String	BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS	"bearer.auth.cache.expiry.buffer.seconds"
public static final String	BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS_DOC	"The amount of buffer time between expiration times of the OAuth Token and corresponding cache which hold the token. Ideally we would want to get a new token before the current one expires. Legal values are between 0 and 3600 (1 hour); a default value of 300 (5 minutes) is used if no value is specified. This value is ignored if it exceeds the remaining lifetime of a token from the moment it is retrieved into schema registry."
public static final String	BEARER_AUTH_CLIENT_ID	"bearer.auth.client.id"
public static final String	BEARER_AUTH_CLIENT_ID_DOC	"Client Id used to obtain Client Credentials Grant from OAuth/OIDC identity provider <a href=\"rfc-editor.org/rfc/rfc6749.html#section-4.4\"> "
public static final String	BEARER_AUTH_CLIENT_SECRET	"bearer.auth.client.secret"
public static final String	BEARER_AUTH_CLIENT_SECRET_DOC	"Client secret used to obtain Client Credentials Grant from OAuth/OIDC identity provider <a href=\"rfc-editor.org/rfc/rfc6749.html#section-4.4\"> "
public static final String	BEARER_AUTH_CREDENTIALS_SOURCE	"bearer.auth.credentials.source"
public static final String	BEARER_AUTH_CREDENTIALS_SOURCE_DEFAULT	"STATIC_TOKEN"
public static final String	BEARER_AUTH_CREDENTIALS_SOURCE_DOC	"Specify how to pick the credentials for Bearer Auth header. "
public static final String	BEARER_AUTH_CUSTOM_PROVIDER_CLASS	"bearer.auth.custom.provider.class"
public static final String	BEARER_AUTH_CUSTOM_PROVIDER_CLASS_D0C	"Custom class which will provide the token credential. Needs to implement io.confluent.kafka.schemaregistry.client.security.bearerauth.BearerAuthCredentialProvider interface"
public static final String	BEARER_AUTH_IDENTITY_POOL_ID	"bearer.auth.identity.pool.id"
public static final String	BEARER_AUTH_IDENTITY_POOL_ID_DOC	"Additional property which can added in Request header to Schema Registry. This maybe used as Principal Id for Authorization"
public static final String	BEARER_AUTH_ISSUER_ENDPOINT_URL	"bearer.auth.issuer.endpoint.url"
public static final String	BEARER_AUTH_ISSUER_ENDPOINT_URL_DOC	"The HTTP(S)-based URL for the OAuth/OIDC identity provider which issues access token"
public static final String	BEARER_AUTH_LOGICAL_CLUSTER	"bearer.auth.logical.cluster"
public static final String	BEARER_AUTH_LOGICAL_CLUSTER_DOC	"Additional property which can added in Request header to Schema Registry"
public static final String	BEARER_AUTH_SCOPE	"bearer.auth.scope"
public static final String	BEARER_AUTH_SCOPE_CLAIM_NAME	"bearer.auth.scope.claim.name"
public static final String	BEARER_AUTH_SCOPE_CLAIM_NAME_DOC	"The OAuth claim for the scope is often named \"scope\", but this (optional) setting can provide a different name to use for the scope included in the JWT payload\'s claims if the OAuth/OIDC provider uses a different name for that claim."
public static final String	BEARER_AUTH_SCOPE_DOC	"Access Token Scope used to obtain Client Credentials Grant OAuth/OIDC identity provider <a href=\"rfc-editor.org/rfc/rfc6749.html#section-3.3\"> "
public static final String	BEARER_AUTH_SUB_CLAIM_NAME	"bearer.auth.sub.claim.name"
public static final String	BEARER_AUTH_SUB_CLAIM_NAME_DOC	"The OAuth claim for the subject is often named \"sub\", but this (optional) setting can provide a different name to use for the subject included in the JWT payload\'s claims if the OAuth/OIDC provider uses a different name for that claim."
public static final String	BEARER_AUTH_TOKEN_CONFIG	"bearer.auth.token"
public static final String	BEARER_AUTH_TOKEN_DEFAULT	""
public static final String	BEARER_AUTH_TOKEN_DOC	"Specify the Bearer token to be used for authentication"
public static final String	CONTEXT_NAME_STRATEGY	"context.name.strategy"
public static final String	CONTEXT_NAME_STRATEGY_DOC	"A class used to determine the schema registry context."
public static final String	DEFAULT_BEARER_AUTH_SCOPE_CLAIM_NAME	"scope"
public static final String	DEFAULT_BEARER_AUTH_SUB_CLAIM_NAME	"sub"
public static final String	HTTP_CONNECT_TIMEOUT_MS	"http.connect.timeout.ms"
public static final int	HTTP_CONNECT_TIMEOUT_MS_DEFAULT	60000
public static final String	HTTP_CONNECT_TIMEOUT_MS_DOC	"Specify the http connection timeout in milliseconds for schema registry client"
public static final String	HTTP_READ_TIMEOUT_MS	"http.read.timeout.ms"
public static final int	HTTP_READ_TIMEOUT_MS_DEFAULT	60000
public static final String	HTTP_READ_TIMEOUT_MS_DOC	"Specify the http read timeout in milliseconds for schema registry client"
public static final String	ID_COMPATIBILITY_STRICT	"id.compatibility.strict"
public static final boolean	ID_COMPATIBILITY_STRICT_DEFAULT	true
public static final String	ID_COMPATIBILITY_STRICT_DOC	"Whether to check for backward compatibility between the schema with the given ID and the schema of the object to be serialized"
public static final String	KEY_SUBJECT_NAME_STRATEGY	"key.subject.name.strategy"
public static final String	KEY_SUBJECT_NAME_STRATEGY_DOC	"Determines how to construct the subject name under which the key schema is registered with the schema registry. By default, <topic>-key is used as subject."
public static final String	LATEST_CACHE_SIZE	"latest.cache.size"
public static final int	LATEST_CACHE_SIZE_DEFAULT	1000
public static final String	LATEST_CACHE_SIZE_DOC	"The maximum size for caches holding latest schemas"
public static final String	LATEST_CACHE_TTL	"latest.cache.ttl.sec"
public static final int	LATEST_CACHE_TTL_DEFAULT	-1
public static final String	LATEST_CACHE_TTL_DOC	"The TTL for caches holding latest schemas, or -1 for no TTL"
public static final String	LATEST_COMPATIBILITY_STRICT	"latest.compatibility.strict"
public static final boolean	LATEST_COMPATIBILITY_STRICT_DEFAULT	true
public static final String	LATEST_COMPATIBILITY_STRICT_DOC	"Whether to check for backward compatibility between the latest subject version and the Schema of the object to be serialized"
public static final String	MAX_RETRIES_CONFIG	"max.retries"
public static final int	MAX_RETRIES_DEFAULT	3
public static final String	MAX_RETRIES_DOC	"The maximum number of retries for a request"
public static final String	MAX_SCHEMAS_PER_SUBJECT_CONFIG	"max.schemas.per.subject"
public static final int	MAX_SCHEMAS_PER_SUBJECT_DEFAULT	1000
public static final String	MAX_SCHEMAS_PER_SUBJECT_DOC	"Maximum number of schemas to create or cache locally."
public static final String	NORMALIZE_SCHEMAS	"normalize.schemas"
public static final boolean	NORMALIZE_SCHEMAS_DEFAULT	false
public static final String	NORMALIZE_SCHEMAS_DOC	"Whether to normalize schemas, which generally ignores ordering when it is not significant"
public static final String	PROPAGATE_SCHEMA_TAGS	"propagate.schema.tags"
public static final boolean	PROPAGATE_SCHEMA_TAGS_DEFAULT	false
public static final String	PROPAGATE_SCHEMA_TAGS_DOC	"Whether to propagate schema tags from a previous schema version during registration"
public static final String	PROXY_HOST	"proxy.host"
public static final String	PROXY_HOST_DEFAULT	""
public static final String	PROXY_HOST_DOC	"The hostname, or address, of the proxy server that will be used to connect to the schema registry instances."
public static final String	PROXY_PORT	"proxy.port"
public static final int	PROXY_PORT_DEFAULT	-1
public static final String	PROXY_PORT_DOC	"The port number of the proxy server that will be used to connect to the schema registry instances."
public static final String	REQUEST_HEADER_PREFIX	"request.header."
public static final String	RETRIES_MAX_WAIT_MS_CONFIG	"retries.max.wait.ms"
public static final int	RETRIES_MAX_WAIT_MS_DEFAULT	20000
public static final String	RETRIES_MAX_WAIT_MS_DOC	"The maximum time to wait for any retry."
public static final String	RETRIES_WAIT_MS_CONFIG	"retries.wait.ms"
public static final int	RETRIES_WAIT_MS_DEFAULT	1000
public static final String	RETRIES_WAIT_MS_DOC	"The maximum time to wait for the first retry. When jitter is applied, the actual wait may be less."
public static final String	RULE_ACTIONS	"rule.actions"
public static final String	RULE_ACTIONS_DOCS	"A comma-separated list of rule action names."
public static final String	RULE_EXECUTORS	"rule.executors"
public static final String	RULE_EXECUTORS_DOCS	"A comma-separated list of rule executor names."
public static final String	RULE_SERVICE_LOADER_ENABLE	"rule.service.loader.enable"
public static final String	RULE_SERVICE_LOADER_ENABLE_DOCS	"Whether to enable the ServiceLoader for rule executors, defaults to true."
public static final String	SCHEMA_FORMAT	"schema.format"
public static final String	SCHEMA_FORMAT_DOC	"The schema format to use when registering or looking up schemas."
public static final String	SCHEMA_REFLECTION_CONFIG	"schema.reflection"
public static final boolean	SCHEMA_REFLECTION_DEFAULT	false
public static final String	SCHEMA_REFLECTION_DOC	"If true, uses the reflection API when serializing/deserializing "
public static final String	SCHEMA_REGISTRY_URL_CONFIG	"schema.registry.url"
public static final String	SCHEMA_REGISTRY_URL_DOC	"Comma-separated list of URLs for schema registry instances that can be used to register or look up schemas. If you wish to get a connection to a mocked schema registry for testing, you can specify a scope using the \'mock://\' pseudo-protocol. For example, \'mock://my-scope-name\' corresponds to \'MockSchemaRegistry.getClientForScope(\"my-scope-name\")\'."
public static final String	SCHEMA_REGISTRY_URL_RANDOMIZE_CONFIG	"schema.registry.url.randomize"
public static final boolean	SCHEMA_REGISTRY_URL_RANDOMIZE_DEFAULT	false
public static final String	SCHEMA_REGISTRY_URL_RANDOMIZE_DOC	"Whether to randomize the starting index of the schema registry URL list. This can help with load balancing if many schema registry clients are using a shared configuration."
public static final String	SCHEMA_REGISTRY_USER_INFO_CONFIG	"schema.registry.basic.auth.user.info"
public static final String	SCHEMA_REGISTRY_USER_INFO_DEFAULT	""
public static final String	SCHEMA_REGISTRY_USER_INFO_DOC	"Specify the user info for Basic Auth in the form of {username}:{password}"
public static final String	USE_LATEST_VERSION	"use.latest.version"
public static final boolean	USE_LATEST_VERSION_DEFAULT	false
public static final String	USE_LATEST_VERSION_DOC	"Specify if the Serializer should use the latest subject version for serialization"
public static final String	USE_LATEST_WITH_METADATA	"use.latest.with.metadata"
public static final String	USE_LATEST_WITH_METADATA_DOC	"Specify if the Serializer or Deserializer should use the latest subject version with the given metadata property and value, for example, \'application.version=v1\'"
public static final String	USE_SCHEMA_ID	"use.schema.id"
public static final int	USE_SCHEMA_ID_DEFAULT	-1
public static final String	USE_SCHEMA_ID_DOC	"Schema ID to use for serialization"
public static final String	USER_INFO_CONFIG	"basic.auth.user.info"
public static final String	USER_INFO_DEFAULT	""
public static final String	VALUE_SUBJECT_NAME_STRATEGY	"value.subject.name.strategy"
public static final String	VALUE_SUBJECT_NAME_STRATEGY_DOC	"Determines how to construct the subject name under which the value schema is registered with the schema registry. By default, <topic>-value is used as subject."

io.confluent.kafka.serializers.WrapperKeyDeserializerConfig

Modifier and Type	Constant Field	Value
public static final String	WRAPPED_KEY_DESERIALIZER	"wrapped.key.deserializer"
public static final String	WRAPPED_KEY_DESERIALIZER_DOC	"Deserializer class to which calls will be delegated"

io.confluent.kafka.serializers.WrapperKeySerializerConfig

Modifier and Type	Constant Field	Value
public static final String	WRAPPED_KEY_SERIALIZER	"wrapped.key.serializer"
public static final String	WRAPPED_KEY_SERIALIZER_DOC	"Serializer class to which calls will be delegated"

io.confluent.kafka.serializers.wrapper.CompositeDeserializer

Modifier and Type	Constant Field	Value
protected static final byte	MAGIC_BYTE	0

io.confluent.kafka.serializers.wrapper.CompositeDeserializerConfig

Modifier and Type	Constant Field	Value
public static final String	COMPOSITE_CONFLUENT_DESERIALIZER	"composite.confluent.deserializer"
public static final String	COMPOSITE_CONFLUENT_DESERIALIZER_DOC	"Confluent deserializer, one of Avro, Protobuf, JSON Schema"
public static final String	COMPOSITE_OLD_DESERIALIZER	"composite.old.deserializer"
public static final String	COMPOSITE_OLD_DESERIALIZER_DOC	"Old deserializer that is schema-unaware"