org.apache.kafka.common.config.TopicConfig

public class TopicConfigextends Object

Keys that can be used to configure a topic. These keys are useful when creating or reconfiguring a topic using the AdminClient.

The intended pattern is for broker configs to include a `log.` prefix. For example, to set the default broker cleanup policy, one would set log.cleanup.policy instead of cleanup.policy. Unfortunately, there are many cases where this pattern is not followed.

Field Summary
Fields
Modifier and Type
Field
Description
static final String
CLEANUP_POLICY_COMPACT

static final String
CLEANUP_POLICY_CONFIG

static final String
CLEANUP_POLICY_DELETE

static final String
CLEANUP_POLICY_DOC

static final String
COMPRESSION_GZIP_LEVEL_CONFIG

static final String
COMPRESSION_GZIP_LEVEL_DOC

static final String
COMPRESSION_LZ4_LEVEL_CONFIG

static final String
COMPRESSION_LZ4_LEVEL_DOC

static final String
COMPRESSION_TYPE_CONFIG

static final String
COMPRESSION_TYPE_DOC

static final String
COMPRESSION_ZSTD_LEVEL_CONFIG

static final String
COMPRESSION_ZSTD_LEVEL_DOC

static final String
DELETE_RETENTION_MS_CONFIG

static final String
DELETE_RETENTION_MS_DOC

static final String
FILE_DELETE_DELAY_MS_CONFIG

static final String
FILE_DELETE_DELAY_MS_DOC

static final String
FLUSH_MESSAGES_INTERVAL_CONFIG

static final String
FLUSH_MESSAGES_INTERVAL_DOC

static final String
FLUSH_MS_CONFIG

static final String
FLUSH_MS_DOC

static final String
INDEX_INTERVAL_BYTES_CONFIG

static final String
INDEX_INTERVAL_BYTES_DOC

static final String
LOCAL_LOG_RETENTION_BYTES_CONFIG

static final String
LOCAL_LOG_RETENTION_BYTES_DOC

static final String
LOCAL_LOG_RETENTION_MS_CONFIG

static final String
LOCAL_LOG_RETENTION_MS_DOC

static final String
MAX_COMPACTION_LAG_MS_CONFIG

static final String
MAX_COMPACTION_LAG_MS_DOC

static final String
MAX_MESSAGE_BYTES_CONFIG

static final String
MAX_MESSAGE_BYTES_DOC

static final String
MESSAGE_DOWNCONVERSION_ENABLE_CONFIG
Deprecated.
down-conversion is not possible in Apache Kafka 4.0 and newer, hence this configuration is a no-op, and it is deprecated for removal in Apache Kafka 5.0.
static final String
MESSAGE_DOWNCONVERSION_ENABLE_DOC
Deprecated.
see MESSAGE_DOWNCONVERSION_ENABLE_CONFIG.
static final String
MESSAGE_TIMESTAMP_AFTER_MAX_MS_CONFIG

static final String
MESSAGE_TIMESTAMP_AFTER_MAX_MS_DOC

static final String
MESSAGE_TIMESTAMP_BEFORE_MAX_MS_CONFIG

static final String
MESSAGE_TIMESTAMP_BEFORE_MAX_MS_DOC

static final String
MESSAGE_TIMESTAMP_TYPE_CONFIG

static final String
MESSAGE_TIMESTAMP_TYPE_DOC

static final String
MIN_CLEANABLE_DIRTY_RATIO_CONFIG

static final String
MIN_CLEANABLE_DIRTY_RATIO_DOC

static final String
MIN_COMPACTION_LAG_MS_CONFIG

static final String
MIN_COMPACTION_LAG_MS_DOC

static final String
MIN_IN_SYNC_REPLICAS_CONFIG

static final String
MIN_IN_SYNC_REPLICAS_DOC

static final String
PREALLOCATE_CONFIG

static final String
PREALLOCATE_DOC

static final String
REMOTE_LOG_COPY_DISABLE_CONFIG

static final String
REMOTE_LOG_COPY_DISABLE_DOC

static final String
REMOTE_LOG_DELETE_ON_DISABLE_CONFIG

static final String
REMOTE_LOG_DELETE_ON_DISABLE_DOC

static final String
REMOTE_LOG_STORAGE_ENABLE_CONFIG

static final String
REMOTE_LOG_STORAGE_ENABLE_DOC

static final String
RETENTION_BYTES_CONFIG

static final String
RETENTION_BYTES_DOC

static final String
RETENTION_MS_CONFIG

static final String
RETENTION_MS_DOC

static final String
SEGMENT_BYTES_CONFIG

static final String
SEGMENT_BYTES_DOC

static final String
SEGMENT_INDEX_BYTES_CONFIG

static final String
SEGMENT_INDEX_BYTES_DOC

static final String
SEGMENT_JITTER_MS_CONFIG

static final String
SEGMENT_JITTER_MS_DOC

static final String
SEGMENT_MS_CONFIG

static final String
SEGMENT_MS_DOC

static final String
UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG

static final String
UNCLEAN_LEADER_ELECTION_ENABLE_DOC
Constructor Summary
Constructors
Constructor
Description
TopicConfig()
Method Summary
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- SEGMENT_BYTES_CONFIG
  public static final String SEGMENT_BYTES_CONFIG
  See Also:
  Constant Field Values
- SEGMENT_BYTES_DOC
  public static final String SEGMENT_BYTES_DOC
  See Also:
  Constant Field Values
- SEGMENT_MS_CONFIG
  public static final String SEGMENT_MS_CONFIG
  See Also:
  Constant Field Values
- SEGMENT_MS_DOC
  public static final String SEGMENT_MS_DOC
  See Also:
  Constant Field Values
- SEGMENT_JITTER_MS_CONFIG
  public static final String SEGMENT_JITTER_MS_CONFIG
  See Also:
  Constant Field Values
- SEGMENT_JITTER_MS_DOC
  public static final String SEGMENT_JITTER_MS_DOC
  See Also:
  Constant Field Values
- SEGMENT_INDEX_BYTES_CONFIG
  public static final String SEGMENT_INDEX_BYTES_CONFIG
  See Also:
  Constant Field Values
- SEGMENT_INDEX_BYTES_DOC
  public static final String SEGMENT_INDEX_BYTES_DOC
  See Also:
  Constant Field Values
- FLUSH_MESSAGES_INTERVAL_CONFIG
  public static final String FLUSH_MESSAGES_INTERVAL_CONFIG
  See Also:
  Constant Field Values
- FLUSH_MESSAGES_INTERVAL_DOC
  public static final String FLUSH_MESSAGES_INTERVAL_DOC
  See Also:
  Constant Field Values
- FLUSH_MS_CONFIG
  public static final String FLUSH_MS_CONFIG
  See Also:
  Constant Field Values
- FLUSH_MS_DOC
  public static final String FLUSH_MS_DOC
  See Also:
  Constant Field Values
- RETENTION_BYTES_CONFIG
  public static final String RETENTION_BYTES_CONFIG
  See Also:
  Constant Field Values
- RETENTION_BYTES_DOC
  public static final String RETENTION_BYTES_DOC
  See Also:
  Constant Field Values
- RETENTION_MS_CONFIG
  public static final String RETENTION_MS_CONFIG
  See Also:
  Constant Field Values
- RETENTION_MS_DOC
  public static final String RETENTION_MS_DOC
  See Also:
  Constant Field Values
- REMOTE_LOG_STORAGE_ENABLE_CONFIG
  public static final String REMOTE_LOG_STORAGE_ENABLE_CONFIG
  See Also:
  Constant Field Values
- REMOTE_LOG_STORAGE_ENABLE_DOC
  public static final String REMOTE_LOG_STORAGE_ENABLE_DOC
  See Also:
  Constant Field Values
- LOCAL_LOG_RETENTION_MS_CONFIG
  public static final String LOCAL_LOG_RETENTION_MS_CONFIG
  See Also:
  Constant Field Values
- LOCAL_LOG_RETENTION_MS_DOC
  public static final String LOCAL_LOG_RETENTION_MS_DOC
  See Also:
  Constant Field Values
- LOCAL_LOG_RETENTION_BYTES_CONFIG
  public static final String LOCAL_LOG_RETENTION_BYTES_CONFIG
  See Also:
  Constant Field Values
- LOCAL_LOG_RETENTION_BYTES_DOC
  public static final String LOCAL_LOG_RETENTION_BYTES_DOC
  See Also:
  Constant Field Values
- REMOTE_LOG_COPY_DISABLE_CONFIG
  public static final String REMOTE_LOG_COPY_DISABLE_CONFIG
  See Also:
  Constant Field Values
- REMOTE_LOG_COPY_DISABLE_DOC
  public static final String REMOTE_LOG_COPY_DISABLE_DOC
  See Also:
  Constant Field Values
- REMOTE_LOG_DELETE_ON_DISABLE_CONFIG
  public static final String REMOTE_LOG_DELETE_ON_DISABLE_CONFIG
  See Also:
  Constant Field Values
- REMOTE_LOG_DELETE_ON_DISABLE_DOC
  public static final String REMOTE_LOG_DELETE_ON_DISABLE_DOC
  See Also:
  Constant Field Values
- MAX_MESSAGE_BYTES_CONFIG
  public static final String MAX_MESSAGE_BYTES_CONFIG
  See Also:
  Constant Field Values
- MAX_MESSAGE_BYTES_DOC
  public static final String MAX_MESSAGE_BYTES_DOC
  See Also:
  Constant Field Values
- INDEX_INTERVAL_BYTES_CONFIG
  public static final String INDEX_INTERVAL_BYTES_CONFIG
  See Also:
  Constant Field Values
- INDEX_INTERVAL_BYTES_DOC
  public static final String INDEX_INTERVAL_BYTES_DOC
  See Also:
  Constant Field Values
- FILE_DELETE_DELAY_MS_CONFIG
  public static final String FILE_DELETE_DELAY_MS_CONFIG
  See Also:
  Constant Field Values
- FILE_DELETE_DELAY_MS_DOC
  public static final String FILE_DELETE_DELAY_MS_DOC
  See Also:
  Constant Field Values
- DELETE_RETENTION_MS_CONFIG
  public static final String DELETE_RETENTION_MS_CONFIG
  See Also:
  Constant Field Values
- DELETE_RETENTION_MS_DOC
  public static final String DELETE_RETENTION_MS_DOC
  See Also:
  Constant Field Values
- MIN_COMPACTION_LAG_MS_CONFIG
  public static final String MIN_COMPACTION_LAG_MS_CONFIG
  See Also:
  Constant Field Values
- MIN_COMPACTION_LAG_MS_DOC
  public static final String MIN_COMPACTION_LAG_MS_DOC
  See Also:
  Constant Field Values
- MAX_COMPACTION_LAG_MS_CONFIG
  public static final String MAX_COMPACTION_LAG_MS_CONFIG
  See Also:
  Constant Field Values
- MAX_COMPACTION_LAG_MS_DOC
  public static final String MAX_COMPACTION_LAG_MS_DOC
  See Also:
  Constant Field Values
- MIN_CLEANABLE_DIRTY_RATIO_CONFIG
  public static final String MIN_CLEANABLE_DIRTY_RATIO_CONFIG
  See Also:
  Constant Field Values
- MIN_CLEANABLE_DIRTY_RATIO_DOC
  public static final String MIN_CLEANABLE_DIRTY_RATIO_DOC
  See Also:
  Constant Field Values
- CLEANUP_POLICY_CONFIG
  public static final String CLEANUP_POLICY_CONFIG
  See Also:
  Constant Field Values
- CLEANUP_POLICY_COMPACT
  public static final String CLEANUP_POLICY_COMPACT
  See Also:
  Constant Field Values
- CLEANUP_POLICY_DELETE
  public static final String CLEANUP_POLICY_DELETE
  See Also:
  Constant Field Values
- CLEANUP_POLICY_DOC
  public static final String CLEANUP_POLICY_DOC
  See Also:
  Constant Field Values
- UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG
  public static final String UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG
  See Also:
  Constant Field Values
- UNCLEAN_LEADER_ELECTION_ENABLE_DOC
  public static final String UNCLEAN_LEADER_ELECTION_ENABLE_DOC
  See Also:
  Constant Field Values
- MIN_IN_SYNC_REPLICAS_CONFIG
  public static final String MIN_IN_SYNC_REPLICAS_CONFIG
  See Also:
  Constant Field Values
- MIN_IN_SYNC_REPLICAS_DOC
  public static final String MIN_IN_SYNC_REPLICAS_DOC
  See Also:
  Constant Field Values
- COMPRESSION_TYPE_CONFIG
  public static final String COMPRESSION_TYPE_CONFIG
  See Also:
  Constant Field Values
- COMPRESSION_TYPE_DOC
  public static final String COMPRESSION_TYPE_DOC
  See Also:
  Constant Field Values
- COMPRESSION_GZIP_LEVEL_CONFIG
  public static final String COMPRESSION_GZIP_LEVEL_CONFIG
  See Also:
  Constant Field Values
- COMPRESSION_GZIP_LEVEL_DOC
  public static final String COMPRESSION_GZIP_LEVEL_DOC
  See Also:
  Constant Field Values
- COMPRESSION_LZ4_LEVEL_CONFIG
  public static final String COMPRESSION_LZ4_LEVEL_CONFIG
  See Also:
  Constant Field Values
- COMPRESSION_LZ4_LEVEL_DOC
  public static final String COMPRESSION_LZ4_LEVEL_DOC
  See Also:
  Constant Field Values
- COMPRESSION_ZSTD_LEVEL_CONFIG
  public static final String COMPRESSION_ZSTD_LEVEL_CONFIG
  See Also:
  Constant Field Values
- COMPRESSION_ZSTD_LEVEL_DOC
  public static final String COMPRESSION_ZSTD_LEVEL_DOC
  See Also:
  Constant Field Values
- PREALLOCATE_CONFIG
  public static final String PREALLOCATE_CONFIG
  See Also:
  Constant Field Values
- PREALLOCATE_DOC
  public static final String PREALLOCATE_DOC
  See Also:
  Constant Field Values
- MESSAGE_TIMESTAMP_TYPE_CONFIG
  public static final String MESSAGE_TIMESTAMP_TYPE_CONFIG
  See Also:
  Constant Field Values
- MESSAGE_TIMESTAMP_TYPE_DOC
  public static final String MESSAGE_TIMESTAMP_TYPE_DOC
  See Also:
  Constant Field Values
- MESSAGE_TIMESTAMP_BEFORE_MAX_MS_CONFIG
  public static final String MESSAGE_TIMESTAMP_BEFORE_MAX_MS_CONFIG
  See Also:
  Constant Field Values
- MESSAGE_TIMESTAMP_BEFORE_MAX_MS_DOC
  public static final String MESSAGE_TIMESTAMP_BEFORE_MAX_MS_DOC
  See Also:
  Constant Field Values
- MESSAGE_TIMESTAMP_AFTER_MAX_MS_CONFIG
  public static final String MESSAGE_TIMESTAMP_AFTER_MAX_MS_CONFIG
  See Also:
  Constant Field Values
- MESSAGE_TIMESTAMP_AFTER_MAX_MS_DOC
  public static final String MESSAGE_TIMESTAMP_AFTER_MAX_MS_DOC
  See Also:
  Constant Field Values
- MESSAGE_DOWNCONVERSION_ENABLE_CONFIG
  @Deprecatedpublic static final String MESSAGE_DOWNCONVERSION_ENABLE_CONFIG
  Deprecated.
  down-conversion is not possible in Apache Kafka 4.0 and newer, hence this configuration is a no-op, and it is deprecated for removal in Apache Kafka 5.0.
  See Also:
  Constant Field Values
- MESSAGE_DOWNCONVERSION_ENABLE_DOC
  @Deprecatedpublic static final String MESSAGE_DOWNCONVERSION_ENABLE_DOC
  Deprecated.
  see MESSAGE_DOWNCONVERSION_ENABLE_CONFIG.
  See Also:
  Constant Field Values
Constructor Details
- TopicConfig
  public TopicConfig()

Class TopicConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

SEGMENT_BYTES_CONFIG

SEGMENT_BYTES_DOC

SEGMENT_MS_CONFIG

SEGMENT_MS_DOC

SEGMENT_JITTER_MS_CONFIG

SEGMENT_JITTER_MS_DOC

SEGMENT_INDEX_BYTES_CONFIG

SEGMENT_INDEX_BYTES_DOC

FLUSH_MESSAGES_INTERVAL_CONFIG

FLUSH_MESSAGES_INTERVAL_DOC

FLUSH_MS_CONFIG

FLUSH_MS_DOC

RETENTION_BYTES_CONFIG

RETENTION_BYTES_DOC

RETENTION_MS_CONFIG

RETENTION_MS_DOC

REMOTE_LOG_STORAGE_ENABLE_CONFIG

REMOTE_LOG_STORAGE_ENABLE_DOC

LOCAL_LOG_RETENTION_MS_CONFIG

LOCAL_LOG_RETENTION_MS_DOC

LOCAL_LOG_RETENTION_BYTES_CONFIG

LOCAL_LOG_RETENTION_BYTES_DOC

REMOTE_LOG_COPY_DISABLE_CONFIG

REMOTE_LOG_COPY_DISABLE_DOC

REMOTE_LOG_DELETE_ON_DISABLE_CONFIG

REMOTE_LOG_DELETE_ON_DISABLE_DOC

MAX_MESSAGE_BYTES_CONFIG

MAX_MESSAGE_BYTES_DOC

INDEX_INTERVAL_BYTES_CONFIG

INDEX_INTERVAL_BYTES_DOC

FILE_DELETE_DELAY_MS_CONFIG

FILE_DELETE_DELAY_MS_DOC

DELETE_RETENTION_MS_CONFIG

DELETE_RETENTION_MS_DOC

MIN_COMPACTION_LAG_MS_CONFIG

MIN_COMPACTION_LAG_MS_DOC

MAX_COMPACTION_LAG_MS_CONFIG

MAX_COMPACTION_LAG_MS_DOC

MIN_CLEANABLE_DIRTY_RATIO_CONFIG

MIN_CLEANABLE_DIRTY_RATIO_DOC

CLEANUP_POLICY_CONFIG

CLEANUP_POLICY_COMPACT

CLEANUP_POLICY_DELETE

CLEANUP_POLICY_DOC

UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG

UNCLEAN_LEADER_ELECTION_ENABLE_DOC

MIN_IN_SYNC_REPLICAS_CONFIG

MIN_IN_SYNC_REPLICAS_DOC

COMPRESSION_TYPE_CONFIG

COMPRESSION_TYPE_DOC

COMPRESSION_GZIP_LEVEL_CONFIG

COMPRESSION_GZIP_LEVEL_DOC

COMPRESSION_LZ4_LEVEL_CONFIG

COMPRESSION_LZ4_LEVEL_DOC

COMPRESSION_ZSTD_LEVEL_CONFIG

COMPRESSION_ZSTD_LEVEL_DOC

PREALLOCATE_CONFIG

PREALLOCATE_DOC

MESSAGE_TIMESTAMP_TYPE_CONFIG

MESSAGE_TIMESTAMP_TYPE_DOC

MESSAGE_TIMESTAMP_BEFORE_MAX_MS_CONFIG

MESSAGE_TIMESTAMP_BEFORE_MAX_MS_DOC

MESSAGE_TIMESTAMP_AFTER_MAX_MS_CONFIG

MESSAGE_TIMESTAMP_AFTER_MAX_MS_DOC

MESSAGE_DOWNCONVERSION_ENABLE_CONFIG

MESSAGE_DOWNCONVERSION_ENABLE_DOC

Constructor Details

TopicConfig