Package org.apache.kafka.common.config

Class TopicConfig

java.lang.Object

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 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
static final String	MESSAGE_DOWNCONVERSION_ENABLE_DOC
static final String	MESSAGE_FORMAT_VERSION_CONFIG	Deprecated. since 3.0, removal planned in 4.0.
static final String	MESSAGE_FORMAT_VERSION_DOC	Deprecated. since 3.0, removal planned in 4.0.
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_DIFFERENCE_MAX_MS_CONFIG	Deprecated. since 3.6, removal planned in 4.0.
static final String	MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC	Deprecated. since 3.6, removal planned in 4.0.
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_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

@Deprecated
public static final String MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG

Deprecated.

since 3.6, removal planned in 4.0. Use message.timestamp.before.max.ms and message.timestamp.after.max.ms instead

See Also:

• Constant Field Values

MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC

@Deprecated
public static final String MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_DOC

Deprecated.

since 3.6, removal planned in 4.0. Use message.timestamp.before.max.ms and message.timestamp.after.max.ms instead

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

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()