| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
BOOTSTRAP_SERVERS_CONFIG |
"bootstrap.servers" |
public static final java.lang.String |
CLIENT_DNS_LOOKUP_CONFIG |
"client.dns.lookup" |
public static final java.lang.String |
CLIENT_ID_CONFIG |
"client.id" |
public static final java.lang.String |
CONNECTIONS_MAX_IDLE_MS_CONFIG |
"connections.max.idle.ms" |
public static final java.lang.String |
DEFAULT_SECURITY_PROTOCOL |
"PLAINTEXT" |
public static final java.lang.String |
METADATA_MAX_AGE_CONFIG |
"metadata.max.age.ms" |
public static final java.lang.String |
METRIC_REPORTER_CLASSES_CONFIG |
"metric.reporters" |
public static final java.lang.String |
METRICS_NUM_SAMPLES_CONFIG |
"metrics.num.samples" |
public static final java.lang.String |
METRICS_RECORDING_LEVEL_CONFIG |
"metrics.recording.level" |
public static final java.lang.String |
METRICS_SAMPLE_WINDOW_MS_CONFIG |
"metrics.sample.window.ms" |
public static final java.lang.String |
RECEIVE_BUFFER_CONFIG |
"receive.buffer.bytes" |
public static final java.lang.String |
RECONNECT_BACKOFF_MAX_MS_CONFIG |
"reconnect.backoff.max.ms" |
public static final java.lang.String |
RECONNECT_BACKOFF_MS_CONFIG |
"reconnect.backoff.ms" |
public static final java.lang.String |
REQUEST_TIMEOUT_MS_CONFIG |
"request.timeout.ms" |
public static final java.lang.String |
RETRIES_CONFIG |
"retries" |
public static final java.lang.String |
RETRY_BACKOFF_MS_CONFIG |
"retry.backoff.ms" |
public static final java.lang.String |
SECURITY_PROTOCOL_CONFIG |
"security.protocol" |
public static final java.lang.String |
SECURITY_PROVIDERS_CONFIG |
"security.providers" |
public static final java.lang.String |
SEND_BUFFER_CONFIG |
"send.buffer.bytes" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
ALLOW_AUTO_CREATE_TOPICS_CONFIG |
"allow.auto.create.topics" |
public static final java.lang.String |
AUTO_COMMIT_INTERVAL_MS_CONFIG |
"auto.commit.interval.ms" |
public static final java.lang.String |
AUTO_OFFSET_RESET_CONFIG |
"auto.offset.reset" |
public static final java.lang.String |
AUTO_OFFSET_RESET_DOC |
"What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted): <ul><li>earliest: automatically reset the offset to the earliest offset<li>latest: automatically reset the offset to the latest offset</li><li>none: throw exception to the consumer if no previous offset is found for the consumer\'s group</li><li>anything else: throw exception to the consumer.</li></ul>" |
public static final java.lang.String |
BOOTSTRAP_SERVERS_CONFIG |
"bootstrap.servers" |
public static final java.lang.String |
CHECK_CRCS_CONFIG |
"check.crcs" |
public static final java.lang.String |
CLIENT_DNS_LOOKUP_CONFIG |
"client.dns.lookup" |
public static final java.lang.String |
CLIENT_ID_CONFIG |
"client.id" |
public static final java.lang.String |
CLIENT_RACK_CONFIG |
"client.rack" |
public static final java.lang.String |
CONNECTIONS_MAX_IDLE_MS_CONFIG |
"connections.max.idle.ms" |
public static final boolean |
DEFAULT_ALLOW_AUTO_CREATE_TOPICS |
true |
public static final java.lang.String |
DEFAULT_API_TIMEOUT_MS_CONFIG |
"default.api.timeout.ms" |
public static final java.lang.String |
DEFAULT_API_TIMEOUT_MS_DOC |
"Specifies the timeout (in milliseconds) for consumer APIs that could block. This configuration is used as the default timeout for all consumer operations that do not explicitly accept a <code>timeout</code> parameter." |
public static final boolean |
DEFAULT_EXCLUDE_INTERNAL_TOPICS |
true |
public static final int |
DEFAULT_FETCH_MAX_BYTES |
52428800 |
public static final int |
DEFAULT_MAX_PARTITION_FETCH_BYTES |
1048576 |
public static final java.lang.String |
ENABLE_AUTO_COMMIT_CONFIG |
"enable.auto.commit" |
public static final java.lang.String |
EXCLUDE_INTERNAL_TOPICS_CONFIG |
"exclude.internal.topics" |
public static final java.lang.String |
FETCH_MAX_BYTES_CONFIG |
"fetch.max.bytes" |
public static final java.lang.String |
FETCH_MAX_WAIT_MS_CONFIG |
"fetch.max.wait.ms" |
public static final java.lang.String |
FETCH_MIN_BYTES_CONFIG |
"fetch.min.bytes" |
public static final java.lang.String |
GROUP_ID_CONFIG |
"group.id" |
public static final java.lang.String |
GROUP_INSTANCE_ID_CONFIG |
"group.instance.id" |
public static final java.lang.String |
HEARTBEAT_INTERVAL_MS_CONFIG |
"heartbeat.interval.ms" |
public static final java.lang.String |
INTERCEPTOR_CLASSES_CONFIG |
"interceptor.classes" |
public static final java.lang.String |
INTERCEPTOR_CLASSES_DOC |
"A list of classes to use as interceptors. Implementing the <code>org.apache.kafka.clients.consumer.ConsumerInterceptor</code> interface allows you to intercept (and possibly mutate) records received by the consumer. By default, there are no interceptors." |
public static final java.lang.String |
ISOLATION_LEVEL_CONFIG |
"isolation.level" |
public static final java.lang.String |
ISOLATION_LEVEL_DOC |
"Controls how to read messages written transactionally. If set to <code>read_committed</code>, consumer.poll() will only return transactional messages which have been committed. If set to <code>read_uncommitted</code>\' (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. <p>Messages will always be returned in offset order. Hence, in <code>read_committed</code> mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, <code>read_committed</code> consumers will not be able to read up to the high watermark when there are in flight transactions.</p><p> Further, when in <code>read_committed</code> the seekToEnd method will return the LSO" |
public static final java.lang.String |
KEY_DESERIALIZER_CLASS_CONFIG |
"key.deserializer" |
public static final java.lang.String |
KEY_DESERIALIZER_CLASS_DOC |
"Deserializer class for key that implements the <code>org.apache.kafka.common.serialization.Deserializer</code> interface." |
public static final java.lang.String |
MAX_PARTITION_FETCH_BYTES_CONFIG |
"max.partition.fetch.bytes" |
public static final java.lang.String |
MAX_POLL_INTERVAL_MS_CONFIG |
"max.poll.interval.ms" |
public static final java.lang.String |
MAX_POLL_RECORDS_CONFIG |
"max.poll.records" |
public static final java.lang.String |
METADATA_MAX_AGE_CONFIG |
"metadata.max.age.ms" |
public static final java.lang.String |
METRIC_REPORTER_CLASSES_CONFIG |
"metric.reporters" |
public static final java.lang.String |
METRICS_NUM_SAMPLES_CONFIG |
"metrics.num.samples" |
public static final java.lang.String |
METRICS_RECORDING_LEVEL_CONFIG |
"metrics.recording.level" |
public static final java.lang.String |
METRICS_SAMPLE_WINDOW_MS_CONFIG |
"metrics.sample.window.ms" |
public static final java.lang.String |
PARTITION_ASSIGNMENT_STRATEGY_CONFIG |
"partition.assignment.strategy" |
public static final java.lang.String |
RECEIVE_BUFFER_CONFIG |
"receive.buffer.bytes" |
public static final java.lang.String |
RECONNECT_BACKOFF_MAX_MS_CONFIG |
"reconnect.backoff.max.ms" |
public static final java.lang.String |
RECONNECT_BACKOFF_MS_CONFIG |
"reconnect.backoff.ms" |
public static final java.lang.String |
REQUEST_TIMEOUT_MS_CONFIG |
"request.timeout.ms" |
public static final java.lang.String |
RETRY_BACKOFF_MS_CONFIG |
"retry.backoff.ms" |
public static final java.lang.String |
SECURITY_PROVIDERS_CONFIG |
"security.providers" |
public static final java.lang.String |
SEND_BUFFER_CONFIG |
"send.buffer.bytes" |
public static final java.lang.String |
SESSION_TIMEOUT_MS_CONFIG |
"session.timeout.ms" |
public static final java.lang.String |
VALUE_DESERIALIZER_CLASS_CONFIG |
"value.deserializer" |
public static final java.lang.String |
VALUE_DESERIALIZER_CLASS_DOC |
"Deserializer class for value that implements the <code>org.apache.kafka.common.serialization.Deserializer</code> interface." |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final long |
NO_TIMESTAMP |
-1L |
public static final int |
NULL_CHECKSUM |
-1 |
public static final int |
NULL_SIZE |
-1 |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
NETWORK_THREAD_PREFIX |
"kafka-producer-network-thread" |
public static final java.lang.String |
PRODUCER_METRIC_GROUP_NAME |
"producer-metrics" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
ACKS_CONFIG |
"acks" |
public static final java.lang.String |
BATCH_SIZE_CONFIG |
"batch.size" |
public static final java.lang.String |
BOOTSTRAP_SERVERS_CONFIG |
"bootstrap.servers" |
public static final java.lang.String |
BUFFER_MEMORY_CONFIG |
"buffer.memory" |
public static final java.lang.String |
CLIENT_DNS_LOOKUP_CONFIG |
"client.dns.lookup" |
public static final java.lang.String |
CLIENT_ID_CONFIG |
"client.id" |
public static final java.lang.String |
COMPRESSION_TYPE_CONFIG |
"compression.type" |
public static final java.lang.String |
CONNECTIONS_MAX_IDLE_MS_CONFIG |
"connections.max.idle.ms" |
public static final java.lang.String |
DELIVERY_TIMEOUT_MS_CONFIG |
"delivery.timeout.ms" |
public static final java.lang.String |
ENABLE_IDEMPOTENCE_CONFIG |
"enable.idempotence" |
public static final java.lang.String |
ENABLE_IDEMPOTENCE_DOC |
"When set to \'true\', the producer will ensure that exactly one copy of each message is written in the stream. If \'false\', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream. Note that enabling idempotence requires <code>max.in.flight.requests.per.connection</code> to be less than or equal to 5, <code>retries</code> to be greater than 0 and <code>acks</code> must be \'all\'. If these values are not explicitly set by the user, suitable values will be chosen. If incompatible values are set, a <code>ConfigException</code> will be thrown." |
public static final java.lang.String |
INTERCEPTOR_CLASSES_CONFIG |
"interceptor.classes" |
public static final java.lang.String |
INTERCEPTOR_CLASSES_DOC |
"A list of classes to use as interceptors. Implementing the <code>org.apache.kafka.clients.producer.ProducerInterceptor</code> interface allows you to intercept (and possibly mutate) the records received by the producer before they are published to the Kafka cluster. By default, there are no interceptors." |
public static final java.lang.String |
KEY_SERIALIZER_CLASS_CONFIG |
"key.serializer" |
public static final java.lang.String |
KEY_SERIALIZER_CLASS_DOC |
"Serializer class for key that implements the <code>org.apache.kafka.common.serialization.Serializer</code> interface." |
public static final java.lang.String |
LINGER_MS_CONFIG |
"linger.ms" |
public static final java.lang.String |
MAX_BLOCK_MS_CONFIG |
"max.block.ms" |
public static final java.lang.String |
MAX_IN_FLIGHT_REQUESTS_PER_CONNECTION |
"max.in.flight.requests.per.connection" |
public static final java.lang.String |
MAX_REQUEST_SIZE_CONFIG |
"max.request.size" |
public static final java.lang.String |
METADATA_MAX_AGE_CONFIG |
"metadata.max.age.ms" |
public static final java.lang.String |
METRIC_REPORTER_CLASSES_CONFIG |
"metric.reporters" |
public static final java.lang.String |
METRICS_NUM_SAMPLES_CONFIG |
"metrics.num.samples" |
public static final java.lang.String |
METRICS_RECORDING_LEVEL_CONFIG |
"metrics.recording.level" |
public static final java.lang.String |
METRICS_SAMPLE_WINDOW_MS_CONFIG |
"metrics.sample.window.ms" |
public static final java.lang.String |
PARTITIONER_CLASS_CONFIG |
"partitioner.class" |
public static final java.lang.String |
RECEIVE_BUFFER_CONFIG |
"receive.buffer.bytes" |
public static final java.lang.String |
RECONNECT_BACKOFF_MAX_MS_CONFIG |
"reconnect.backoff.max.ms" |
public static final java.lang.String |
RECONNECT_BACKOFF_MS_CONFIG |
"reconnect.backoff.ms" |
public static final java.lang.String |
REQUEST_TIMEOUT_MS_CONFIG |
"request.timeout.ms" |
public static final java.lang.String |
RETRIES_CONFIG |
"retries" |
public static final java.lang.String |
RETRY_BACKOFF_MS_CONFIG |
"retry.backoff.ms" |
public static final java.lang.String |
SECURITY_PROVIDERS_CONFIG |
"security.providers" |
public static final java.lang.String |
SEND_BUFFER_CONFIG |
"send.buffer.bytes" |
public static final java.lang.String |
TRANSACTION_TIMEOUT_CONFIG |
"transaction.timeout.ms" |
public static final java.lang.String |
TRANSACTION_TIMEOUT_DOC |
"The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction.If this value is larger than the transaction.max.timeout.ms setting in the broker, the request will fail with a <code>InvalidTransactionTimeout</code> error." |
public static final java.lang.String |
TRANSACTIONAL_ID_CONFIG |
"transactional.id" |
public static final java.lang.String |
TRANSACTIONAL_ID_DOC |
"The TransactionalId to use for transactional delivery. This enables reliability semantics which span multiple producer sessions since it allows the client to guarantee that transactions using the same TransactionalId have been completed prior to starting any new transactions. If no TransactionalId is provided, then the producer is limited to idempotent delivery. Note that <code>enable.idempotence</code> must be enabled if a TransactionalId is configured. The default is <code>null</code>, which means transactions cannot be used. Note that, by default, transactions require a cluster of at least three brokers which is the recommended setting for production; for development you can change this, by adjusting broker setting <code>transaction.state.log.replication.factor</code>." |
public static final java.lang.String |
VALUE_SERIALIZER_CLASS_CONFIG |
"value.serializer" |
public static final java.lang.String |
VALUE_SERIALIZER_CLASS_DOC |
"Serializer class for value that implements the <code>org.apache.kafka.common.serialization.Serializer</code> interface." |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final int |
UNKNOWN_PARTITION |
-1 |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
CONFIG_PROVIDERS_CONFIG |
"config.providers" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
DEBUG_LOG_LEVEL |
"DEBUG" |
public static final java.lang.String |
ERROR_LOG_LEVEL |
"ERROR" |
public static final java.lang.String |
FATAL_LOG_LEVEL |
"FATAL" |
public static final java.lang.String |
INFO_LOG_LEVEL |
"INFO" |
public static final java.lang.String |
TRACE_LOG_LEVEL |
"TRACE" |
public static final java.lang.String |
WARN_LOG_LEVEL |
"WARN" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
DEFAULT_KERBEROS_KINIT_CMD |
"/usr/bin/kinit" |
public static final long |
DEFAULT_KERBEROS_MIN_TIME_BEFORE_RELOGIN |
60000L |
public static final double |
DEFAULT_KERBEROS_TICKET_RENEW_JITTER |
0.05 |
public static final double |
DEFAULT_KERBEROS_TICKET_RENEW_WINDOW_FACTOR |
0.8 |
public static final short |
DEFAULT_LOGIN_REFRESH_BUFFER_SECONDS |
300 |
public static final short |
DEFAULT_LOGIN_REFRESH_MIN_PERIOD_SECONDS |
60 |
public static final double |
DEFAULT_LOGIN_REFRESH_WINDOW_FACTOR |
0.8 |
public static final double |
DEFAULT_LOGIN_REFRESH_WINDOW_JITTER |
0.05 |
public static final java.lang.String |
DEFAULT_SASL_MECHANISM |
"GSSAPI" |
public static final java.lang.String |
GSSAPI_MECHANISM |
"GSSAPI" |
public static final java.lang.String |
SASL_CLIENT_CALLBACK_HANDLER_CLASS |
"sasl.client.callback.handler.class" |
public static final java.lang.String |
SASL_CLIENT_CALLBACK_HANDLER_CLASS_DOC |
"The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface." |
public static final java.lang.String |
SASL_ENABLED_MECHANISMS |
"sasl.enabled.mechanisms" |
public static final java.lang.String |
SASL_ENABLED_MECHANISMS_DOC |
"The list of SASL mechanisms enabled in the Kafka server. The list may contain any mechanism for which a security provider is available. Only GSSAPI is enabled by default." |
public static final java.lang.String |
SASL_JAAS_CONFIG |
"sasl.jaas.config" |
public static final java.lang.String |
SASL_JAAS_CONFIG_DOC |
"JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described <a href=\"http://docs.oracle.com/javase/8/docs/technotes/guides/security/jgss/tutorials/LoginConfigFile.html\">here</a>. The format for the value is: \'<code>loginModuleClass controlFlag (optionName=optionValue)*;</code>\'. For brokers, the config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.jaas.config=com.example.ScramLoginModule required;" |
public static final java.lang.String |
SASL_KERBEROS_KINIT_CMD |
"sasl.kerberos.kinit.cmd" |
public static final java.lang.String |
SASL_KERBEROS_KINIT_CMD_DOC |
"Kerberos kinit command path." |
public static final java.lang.String |
SASL_KERBEROS_MIN_TIME_BEFORE_RELOGIN |
"sasl.kerberos.min.time.before.relogin" |
public static final java.lang.String |
SASL_KERBEROS_MIN_TIME_BEFORE_RELOGIN_DOC |
"Login thread sleep time between refresh attempts." |
public static final java.lang.String |
SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES |
"sasl.kerberos.principal.to.local.rules" |
public static final java.lang.String |
SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES_DOC |
"A list of rules for mapping from principal names to short names (typically operating system usernames). The rules are evaluated in order and the first rule that matches a principal name is used to map it to a short name. Any later rules in the list are ignored. By default, principal names of the form {username}/{hostname}@{REALM} are mapped to {username}. For more details on the format please see <a href=\"#security_authz\"> security authorization and acls</a>. Note that this configuration is ignored if an extension of KafkaPrincipalBuilder is provided by the <code>principal.builder.class</code> configuration." |
public static final java.lang.String |
SASL_KERBEROS_SERVICE_NAME |
"sasl.kerberos.service.name" |
public static final java.lang.String |
SASL_KERBEROS_SERVICE_NAME_DOC |
"The Kerberos principal name that Kafka runs as. This can be defined either in Kafka\'s JAAS config or in Kafka\'s config." |
public static final java.lang.String |
SASL_KERBEROS_TICKET_RENEW_JITTER |
"sasl.kerberos.ticket.renew.jitter" |
public static final java.lang.String |
SASL_KERBEROS_TICKET_RENEW_JITTER_DOC |
"Percentage of random jitter added to the renewal time." |
public static final java.lang.String |
SASL_KERBEROS_TICKET_RENEW_WINDOW_FACTOR |
"sasl.kerberos.ticket.renew.window.factor" |
public static final java.lang.String |
SASL_KERBEROS_TICKET_RENEW_WINDOW_FACTOR_DOC |
"Login thread will sleep until the specified window factor of time from last refresh to ticket\'s expiry has been reached, at which time it will try to renew the ticket." |
public static final java.lang.String |
SASL_LOGIN_CALLBACK_HANDLER_CLASS |
"sasl.login.callback.handler.class" |
public static final java.lang.String |
SASL_LOGIN_CALLBACK_HANDLER_CLASS_DOC |
"The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface. For brokers, login callback handler config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.callback.handler.class=com.example.CustomScramLoginCallbackHandler" |
public static final java.lang.String |
SASL_LOGIN_CLASS |
"sasl.login.class" |
public static final java.lang.String |
SASL_LOGIN_CLASS_DOC |
"The fully qualified name of a class that implements the Login interface. For brokers, login config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.class=com.example.CustomScramLogin" |
public static final java.lang.String |
SASL_LOGIN_REFRESH_BUFFER_SECONDS |
"sasl.login.refresh.buffer.seconds" |
public static final java.lang.String |
SASL_LOGIN_REFRESH_BUFFER_SECONDS_DOC |
"The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds. If a refresh would otherwise occur closer to expiration than the number of buffer seconds then the refresh will be moved up to maintain as much of the buffer time as possible. 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 and sasl.login.refresh.min.period.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER." |
public static final java.lang.String |
SASL_LOGIN_REFRESH_MIN_PERIOD_SECONDS |
"sasl.login.refresh.min.period.seconds" |
public static final java.lang.String |
SASL_LOGIN_REFRESH_MIN_PERIOD_SECONDS_DOC |
"The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds. Legal values are between 0 and 900 (15 minutes); a default value of 60 (1 minute) is used if no value is specified. This value and sasl.login.refresh.buffer.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER." |
public static final java.lang.String |
SASL_LOGIN_REFRESH_WINDOW_FACTOR |
"sasl.login.refresh.window.factor" |
public static final java.lang.String |
SASL_LOGIN_REFRESH_WINDOW_FACTOR_DOC |
"Login refresh thread will sleep until the specified window factor relative to the credential\'s lifetime has been reached, at which time it will try to refresh the credential. Legal values are between 0.5 (50%) and 1.0 (100%) inclusive; a default value of 0.8 (80%) is used if no value is specified. Currently applies only to OAUTHBEARER." |
public static final java.lang.String |
SASL_LOGIN_REFRESH_WINDOW_JITTER |
"sasl.login.refresh.window.jitter" |
public static final java.lang.String |
SASL_LOGIN_REFRESH_WINDOW_JITTER_DOC |
"The maximum amount of random jitter relative to the credential\'s lifetime that is added to the login refresh thread\'s sleep time. Legal values are between 0 and 0.25 (25%) inclusive; a default value of 0.05 (5%) is used if no value is specified. Currently applies only to OAUTHBEARER." |
public static final java.lang.String |
SASL_MECHANISM |
"sasl.mechanism" |
public static final java.lang.String |
SASL_MECHANISM_DOC |
"SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism." |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
SECURITY_PROVIDERS_CONFIG |
"security.providers" |
public static final java.lang.String |
SECURITY_PROVIDERS_DOC |
"A list of configurable creator classes each returning a provider implementing security algorithms. These classes should implement the <code>org.apache.kafka.common.security.auth.SecurityProviderCreator</code> interface." |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
DEFAULT_SSL_ENABLED_PROTOCOLS |
"TLSv1.2,TLSv1.1,TLSv1" |
public static final java.lang.String |
DEFAULT_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM |
"https" |
public static final java.lang.String |
DEFAULT_SSL_KEYSTORE_TYPE |
"JKS" |
public static final java.lang.String |
DEFAULT_SSL_PROTOCOL |
"TLS" |
public static final java.lang.String |
DEFAULT_SSL_TRUSTSTORE_TYPE |
"JKS" |
public static final java.lang.String |
PRINCIPAL_BUILDER_CLASS_CONFIG |
"principal.builder.class" |
public static final java.lang.String |
PRINCIPAL_BUILDER_CLASS_DOC |
"The fully qualified name of a class that implements the KafkaPrincipalBuilder interface, which is used to build the KafkaPrincipal object used during authorization. This config also supports the deprecated PrincipalBuilder interface which was previously used for client authentication over SSL. If no principal builder is defined, the default behavior depends on the security protocol in use. For SSL authentication, the principal will be derived using the rules defined by <code>ssl.principal.mapping.rules</code> applied on the distinguished name from the client certificate if one is provided; otherwise, if client authentication is not required, the principal name will be ANONYMOUS. For SASL authentication, the principal will be derived using the rules defined by <code>sasl.kerberos.principal.to.local.rules</code> if GSSAPI is in use, and the SASL authentication ID for other mechanisms. For PLAINTEXT, the principal will be ANONYMOUS." |
public static final java.lang.String |
SSL_CIPHER_SUITES_CONFIG |
"ssl.cipher.suites" |
public static final java.lang.String |
SSL_CIPHER_SUITES_DOC |
"A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported." |
public static final java.lang.String |
SSL_CLIENT_AUTH_CONFIG |
"ssl.client.auth" |
public static final java.lang.String |
SSL_CLIENT_AUTH_DOC |
"Configures kafka broker to request client authentication. The following settings are common: <ul> <li><code>ssl.client.auth=required</code> If set to required client authentication is required. <li><code>ssl.client.auth=requested</code> This means client authentication is optional. unlike requested , if this option is set client can choose not to provide authentication information about itself <li><code>ssl.client.auth=none</code> This means client authentication is not needed.</ul>" |
public static final java.lang.String |
SSL_ENABLED_PROTOCOLS_CONFIG |
"ssl.enabled.protocols" |
public static final java.lang.String |
SSL_ENABLED_PROTOCOLS_DOC |
"The list of protocols enabled for SSL connections." |
public static final java.lang.String |
SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG |
"ssl.endpoint.identification.algorithm" |
public static final java.lang.String |
SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_DOC |
"The endpoint identification algorithm to validate server hostname using server certificate. " |
public static final java.lang.String |
SSL_KEY_PASSWORD_CONFIG |
"ssl.key.password" |
public static final java.lang.String |
SSL_KEY_PASSWORD_DOC |
"The password of the private key in the key store file. This is optional for client." |
public static final java.lang.String |
SSL_KEYMANAGER_ALGORITHM_CONFIG |
"ssl.keymanager.algorithm" |
public static final java.lang.String |
SSL_KEYMANAGER_ALGORITHM_DOC |
"The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine." |
public static final java.lang.String |
SSL_KEYSTORE_LOCATION_CONFIG |
"ssl.keystore.location" |
public static final java.lang.String |
SSL_KEYSTORE_LOCATION_DOC |
"The location of the key store file. This is optional for client and can be used for two-way authentication for client." |
public static final java.lang.String |
SSL_KEYSTORE_PASSWORD_CONFIG |
"ssl.keystore.password" |
public static final java.lang.String |
SSL_KEYSTORE_PASSWORD_DOC |
"The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured. " |
public static final java.lang.String |
SSL_KEYSTORE_TYPE_CONFIG |
"ssl.keystore.type" |
public static final java.lang.String |
SSL_KEYSTORE_TYPE_DOC |
"The file format of the key store file. This is optional for client." |
public static final java.lang.String |
SSL_PROTOCOL_CONFIG |
"ssl.protocol" |
public static final java.lang.String |
SSL_PROTOCOL_DOC |
"The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities." |
public static final java.lang.String |
SSL_PROVIDER_CONFIG |
"ssl.provider" |
public static final java.lang.String |
SSL_PROVIDER_DOC |
"The name of the security provider used for SSL connections. Default value is the default security provider of the JVM." |
public static final java.lang.String |
SSL_SECURE_RANDOM_IMPLEMENTATION_CONFIG |
"ssl.secure.random.implementation" |
public static final java.lang.String |
SSL_SECURE_RANDOM_IMPLEMENTATION_DOC |
"The SecureRandom PRNG implementation to use for SSL cryptography operations. " |
public static final java.lang.String |
SSL_TRUSTMANAGER_ALGORITHM_CONFIG |
"ssl.trustmanager.algorithm" |
public static final java.lang.String |
SSL_TRUSTMANAGER_ALGORITHM_DOC |
"The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine." |
public static final java.lang.String |
SSL_TRUSTSTORE_LOCATION_CONFIG |
"ssl.truststore.location" |
public static final java.lang.String |
SSL_TRUSTSTORE_LOCATION_DOC |
"The location of the trust store file. " |
public static final java.lang.String |
SSL_TRUSTSTORE_PASSWORD_CONFIG |
"ssl.truststore.password" |
public static final java.lang.String |
SSL_TRUSTSTORE_PASSWORD_DOC |
"The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled." |
public static final java.lang.String |
SSL_TRUSTSTORE_TYPE_CONFIG |
"ssl.truststore.type" |
public static final java.lang.String |
SSL_TRUSTSTORE_TYPE_DOC |
"The file format of the trust store file." |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
CLEANUP_POLICY_COMPACT |
"compact" |
public static final java.lang.String |
CLEANUP_POLICY_CONFIG |
"cleanup.policy" |
public static final java.lang.String |
CLEANUP_POLICY_DELETE |
"delete" |
public static final java.lang.String |
CLEANUP_POLICY_DOC |
"A string that is either \"delete\" or \"compact\" or both. This string designates the retention policy to use on old log segments. The default policy (\"delete\") will discard old segments when their retention time or size limit has been reached. The \"compact\" setting will enable <a href=\"#compaction\">log compaction</a> on the topic." |
public static final java.lang.String |
COMPRESSION_TYPE_CONFIG |
"compression.type" |
public static final java.lang.String |
COMPRESSION_TYPE_DOC |
"Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (\'gzip\', \'snappy\', \'lz4\', \'zstd\'). It additionally accepts \'uncompressed\' which is equivalent to no compression; and \'producer\' which means retain the original compression codec set by the producer." |
public static final java.lang.String |
DELETE_RETENTION_MS_CONFIG |
"delete.retention.ms" |
public static final java.lang.String |
DELETE_RETENTION_MS_DOC |
"The amount of time to retain delete tombstone markers for <a href=\"#compaction\">log compacted</a> topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan)." |
public static final java.lang.String |
FILE_DELETE_DELAY_MS_CONFIG |
"file.delete.delay.ms" |
public static final java.lang.String |
FILE_DELETE_DELAY_MS_DOC |
"The time to wait before deleting a file from the filesystem" |
public static final java.lang.String |
FLUSH_MESSAGES_INTERVAL_CONFIG |
"flush.messages" |
public static final java.lang.String |
FLUSH_MESSAGES_INTERVAL_DOC |
"This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system\'s background flush capabilities as it is more efficient. This setting can be overridden on a per-topic basis (see <a href=\"#topicconfigs\">the per-topic configuration section</a>)." |
public static final java.lang.String |
FLUSH_MS_CONFIG |
"flush.ms" |
public static final java.lang.String |
FLUSH_MS_DOC |
"This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system\'s background flush capabilities as it is more efficient." |
public static final java.lang.String |
INDEX_INTERVAL_BYTES_CONFIG |
"index.interval.bytes" |
public static final java.lang.String |
INDEX_INTERVAL_BYTES_DOCS |
"This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don\'t need to change this." |
public static final java.lang.String |
MAX_COMPACTION_LAG_MS_CONFIG |
"max.compaction.lag.ms" |
public static final java.lang.String |
MAX_COMPACTION_LAG_MS_DOC |
"The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted." |
public static final java.lang.String |
MAX_MESSAGE_BYTES_CONFIG |
"max.message.bytes" |
public static final java.lang.String |
MAX_MESSAGE_BYTES_DOC |
"The largest record batch size allowed by Kafka. If this is increased and there are consumers older than 0.10.2, the consumers\' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case." |
public static final java.lang.String |
MESSAGE_DOWNCONVERSION_ENABLE_CONFIG |
"message.downconversion.enable" |
public static final java.lang.String |
MESSAGE_DOWNCONVERSION_ENABLE_DOC |
"This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to <code>false</code>, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with <code>UNSUPPORTED_VERSION</code> error for consume requests from such older clients. This configurationdoes not apply to any message format conversion that might be required for replication to followers." |
public static final java.lang.String |
MESSAGE_FORMAT_VERSION_CONFIG |
"message.format.version" |
public static final java.lang.String |
MESSAGE_FORMAT_VERSION_DOC |
"Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don\'t understand." |
public static final java.lang.String |
MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG |
"message.timestamp.difference.max.ms" |
public static final java.lang.String |
MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC |
"The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime." |
public static final java.lang.String |
MESSAGE_TIMESTAMP_TYPE_CONFIG |
"message.timestamp.type" |
public static final java.lang.String |
MESSAGE_TIMESTAMP_TYPE_DOC |
"Define whether the timestamp in the message is message create time or log append time. The value should be either `CreateTime` or `LogAppendTime`" |
public static final java.lang.String |
MIN_CLEANABLE_DIRTY_RATIO_CONFIG |
"min.cleanable.dirty.ratio" |
public static final java.lang.String |
MIN_CLEANABLE_DIRTY_RATIO_DOC |
"This configuration controls how frequently the log compactor will attempt to clean the log (assuming <a href=\"#compaction\">log compaction</a> is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period." |
public static final java.lang.String |
MIN_COMPACTION_LAG_MS_CONFIG |
"min.compaction.lag.ms" |
public static final java.lang.String |
MIN_COMPACTION_LAG_MS_DOC |
"The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted." |
public static final java.lang.String |
MIN_IN_SYNC_REPLICAS_CONFIG |
"min.insync.replicas" |
public static final java.lang.String |
MIN_IN_SYNC_REPLICAS_DOC |
"When a producer sets acks to \"all\" (or \"-1\"), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend).<br>When used together, <code>min.insync.replicas</code> and <code>acks</code> allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set <code>min.insync.replicas</code> to 2, and produce with <code>acks</code> of \"all\". This will ensure that the producer raises an exception if a majority of replicas do not receive a write." |
public static final java.lang.String |
PREALLOCATE_CONFIG |
"preallocate" |
public static final java.lang.String |
PREALLOCATE_DOC |
"True if we should preallocate the file on disk when creating a new log segment." |
public static final java.lang.String |
RETENTION_BYTES_CONFIG |
"retention.bytes" |
public static final java.lang.String |
RETENTION_BYTES_DOC |
"This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the \"delete\" retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes." |
public static final java.lang.String |
RETENTION_MS_CONFIG |
"retention.ms" |
public static final java.lang.String |
RETENTION_MS_DOC |
"This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the \"delete\" retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied." |
public static final java.lang.String |
SEGMENT_BYTES_CONFIG |
"segment.bytes" |
public static final java.lang.String |
SEGMENT_BYTES_DOC |
"This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention." |
public static final java.lang.String |
SEGMENT_INDEX_BYTES_CONFIG |
"segment.index.bytes" |
public static final java.lang.String |
SEGMENT_INDEX_BYTES_DOC |
"This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting." |
public static final java.lang.String |
SEGMENT_JITTER_MS_CONFIG |
"segment.jitter.ms" |
public static final java.lang.String |
SEGMENT_JITTER_MS_DOC |
"The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling" |
public static final java.lang.String |
SEGMENT_MS_CONFIG |
"segment.ms" |
public static final java.lang.String |
SEGMENT_MS_DOC |
"This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn\'t full to ensure that retention can delete or compact old data." |
public static final java.lang.String |
UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG |
"unclean.leader.election.enable" |
public static final java.lang.String |
UNCLEAN_LEADER_ELECTION_ENABLE_DOC |
"Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss." |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
CLUSTER_NAME |
"kafka-cluster" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
WILDCARD_RESOURCE |
"*" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
USER_TYPE |
"User" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
OAUTHBEARER_MECHANISM |
"OAUTHBEARER" |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final java.lang.String |
TOKEN_AUTH_CONFIG |
"tokenauth" |