org.apache.kafka.common.config.TopicConfig

public class TopicConfig
extends 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 String`	`CLEANUP_POLICY_COMPACT`
`static String`	`CLEANUP_POLICY_CONFIG`
`static String`	`CLEANUP_POLICY_DELETE`
`static String`	`CLEANUP_POLICY_DOC`
`static String`	`COMPRESSION_TYPE_CONFIG`
`static String`	`COMPRESSION_TYPE_DOC`
`static String`	`DELETE_RETENTION_MS_CONFIG`
`static String`	`DELETE_RETENTION_MS_DOC`
`static String`	`FILE_DELETE_DELAY_MS_CONFIG`
`static String`	`FILE_DELETE_DELAY_MS_DOC`
`static String`	`FLUSH_MESSAGES_INTERVAL_CONFIG`
`static String`	`FLUSH_MESSAGES_INTERVAL_DOC`
`static String`	`FLUSH_MS_CONFIG`
`static String`	`FLUSH_MS_DOC`
`static String`	`INDEX_INTERVAL_BYTES_CONFIG`
`static String`	`INDEX_INTERVAL_BYTES_DOCS`
`static String`	`LOCAL_LOG_RETENTION_BYTES_CONFIG`
`static String`	`LOCAL_LOG_RETENTION_BYTES_DOC`
`static String`	`LOCAL_LOG_RETENTION_MS_CONFIG`
`static String`	`LOCAL_LOG_RETENTION_MS_DOC`
`static String`	`MAX_COMPACTION_LAG_MS_CONFIG`
`static String`	`MAX_COMPACTION_LAG_MS_DOC`
`static String`	`MAX_MESSAGE_BYTES_CONFIG`
`static String`	`MAX_MESSAGE_BYTES_DOC`
`static String`	`MESSAGE_DOWNCONVERSION_ENABLE_CONFIG`
`static String`	`MESSAGE_DOWNCONVERSION_ENABLE_DOC`
`static String`	`MESSAGE_FORMAT_VERSION_CONFIG`	Deprecated. since 3.0, removal planned in 4.0.
`static String`	`MESSAGE_FORMAT_VERSION_DOC`	Deprecated. since 3.0, removal planned in 4.0.
`static String`	`MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG`
`static String`	`MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC`
`static String`	`MESSAGE_TIMESTAMP_TYPE_CONFIG`
`static String`	`MESSAGE_TIMESTAMP_TYPE_DOC`
`static String`	`MIN_CLEANABLE_DIRTY_RATIO_CONFIG`
`static String`	`MIN_CLEANABLE_DIRTY_RATIO_DOC`
`static String`	`MIN_COMPACTION_LAG_MS_CONFIG`
`static String`	`MIN_COMPACTION_LAG_MS_DOC`
`static String`	`MIN_IN_SYNC_REPLICAS_CONFIG`
`static String`	`MIN_IN_SYNC_REPLICAS_DOC`
`static String`	`PREALLOCATE_CONFIG`
`static String`	`PREALLOCATE_DOC`
`static String`	`REMOTE_LOG_STORAGE_ENABLE_CONFIG`
`static String`	`REMOTE_LOG_STORAGE_ENABLE_DOC`
`static String`	`RETENTION_BYTES_CONFIG`
`static String`	`RETENTION_BYTES_DOC`
`static String`	`RETENTION_MS_CONFIG`
`static String`	`RETENTION_MS_DOC`
`static String`	`SEGMENT_BYTES_CONFIG`
`static String`	`SEGMENT_BYTES_DOC`
`static String`	`SEGMENT_INDEX_BYTES_CONFIG`
`static String`	`SEGMENT_INDEX_BYTES_DOC`
`static String`	`SEGMENT_JITTER_MS_CONFIG`
`static String`	`SEGMENT_JITTER_MS_DOC`
`static String`	`SEGMENT_MS_CONFIG`
`static String`	`SEGMENT_MS_DOC`
`static String`	`UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG`
`static String`	`UNCLEAN_LEADER_ELECTION_ENABLE_DOC`

Constructor Summary

Constructors

Constructor Description

TopicConfig()
Method Summary

Methods inherited from class java.lang.Object
clone, equals, finalize, 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
- 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_DOCS
  
  public static final String INDEX_INTERVAL_BYTES_DOCS
  
  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
- 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_FORMAT_VERSION_CONFIG
  
  @Deprecated public static final String MESSAGE_FORMAT_VERSION_CONFIG
  
  Deprecated.
  since 3.0, removal planned in 4.0. The default value for this config is appropriate for most situations.
  
  See Also:
  
  Constant Field Values
- MESSAGE_FORMAT_VERSION_DOC
  
  @Deprecated public static final String MESSAGE_FORMAT_VERSION_DOC
  
  Deprecated.
  since 3.0, removal planned in 4.0. The default value for this config is appropriate for most situations.
  
  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_DIFFERENCE_MAX_MS_CONFIG
  
  public static final String MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG
  
  See Also:
  
  Constant Field Values
- MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC
  
  public static final String MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC
  
  See Also:
  
  Constant Field Values
- MESSAGE_DOWNCONVERSION_ENABLE_CONFIG
  
  public static final String MESSAGE_DOWNCONVERSION_ENABLE_CONFIG
  
  See Also:
  
  Constant Field Values
- MESSAGE_DOWNCONVERSION_ENABLE_DOC
  
  public static final String MESSAGE_DOWNCONVERSION_ENABLE_DOC
  
  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

MAX_MESSAGE_BYTES_CONFIG

MAX_MESSAGE_BYTES_DOC

INDEX_INTERVAL_BYTES_CONFIG

INDEX_INTERVAL_BYTES_DOCS

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

PREALLOCATE_CONFIG

PREALLOCATE_DOC

MESSAGE_FORMAT_VERSION_CONFIG

MESSAGE_FORMAT_VERSION_DOC

MESSAGE_TIMESTAMP_TYPE_CONFIG

MESSAGE_TIMESTAMP_TYPE_DOC

MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG

MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC

MESSAGE_DOWNCONVERSION_ENABLE_CONFIG

MESSAGE_DOWNCONVERSION_ENABLE_DOC

Constructor Details

TopicConfig