Package io.aiven.kafka.connect.common.config

Class CompressionFragment

java.lang.Object

io.aiven.kafka.connect.common.config.ConfigFragment

io.aiven.kafka.connect.common.config.CompressionFragment

public final class CompressionFragment
extends ConfigFragment

The configuration fragment that defines the compression characteristics.

Field Summary

Fields inherited from class io.aiven.kafka.connect.common.config.ConfigFragment

cfg

Constructor Summary

Constructors

Constructor	Description
CompressionFragment(org.apache.kafka.common.config.AbstractConfig cfg)	Constructor.

Method Summary

Modifier and Type	Method	Description
CompressionType	getCompressionType()	Retrieves the defined compression type.
static org.apache.kafka.common.config.ConfigDef	update(org.apache.kafka.common.config.ConfigDef configDef, CompressionType defaultCompressionType)	Adds the configuration options for compression to the configuration definition.

Methods inherited from class io.aiven.kafka.connect.common.config.ConfigFragment

has, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CompressionFragment

public CompressionFragment(org.apache.kafka.common.config.AbstractConfig cfg)

Constructor.

Parameters:

cfg - the configuration to resolve requests against.

Method Details

update

public static org.apache.kafka.common.config.ConfigDef update(org.apache.kafka.common.config.ConfigDef configDef,
 CompressionType defaultCompressionType)

Adds the configuration options for compression to the configuration definition.

Parameters:

configDef - the Configuration definition.

defaultCompressionType - the default compression type. If null, CompressionType.NONE will be configured.

Returns:

the update configuration definition

getCompressionType

public CompressionType getCompressionType()

Retrieves the defined compression type.

Returns:

the defined compression type or CompressionType.NONE if there is no defined compression type.