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

Class FileNameFragment

java.lang.Object

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

io.aiven.kafka.connect.common.config.FileNameFragment

public final class FileNameFragment
extends ConfigFragment

Fragment to handle all file name extraction operations. Requires OutputFormatFragment and (@link CompressionFragment}

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_NAME_TEMPLATE_CONFIG
static final String	FILE_PATH_PREFIX_TEMPLATE_CONFIG

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

cfg

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getFilename()	Returns the text of the filename template.
Template	getFilenameTemplate()	Gets the filename template.
TimestampSource	getFilenameTimestampSource()	Gets the timestamp source for the file name.
ZoneId	getFilenameTimezone()	Gets the filename timezone
int	getMaxRecordsPerFile()	Gets the maximum number of records allowed in a file.
static org.apache.kafka.common.config.ConfigDef	update(org.apache.kafka.common.config.ConfigDef configDef)	Adds the FileName properties to the configuration definition.
void	validate()	Validate that the data in the configuration matches any restrictions.

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

has

Methods inherited from class java.lang.Object

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

Field Details

FILE_NAME_TEMPLATE_CONFIG

public static final String FILE_NAME_TEMPLATE_CONFIG

See Also:

• Constant Field Values

FILE_PATH_PREFIX_TEMPLATE_CONFIG

public static final String FILE_PATH_PREFIX_TEMPLATE_CONFIG

See Also:

• Constant Field Values

Constructor Details

FileNameFragment

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

Method Details

update

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

Adds the FileName properties to the configuration definition.

Parameters:

configDef - the configuration definition to update.

Returns:

the updated configuration definition.

validate

public void validate()

Description copied from class: ConfigFragment

Validate that the data in the configuration matches any restrictions. Default implementation does nothing.

Overrides:

validate in class ConfigFragment

getFilename

public String getFilename()

Returns the text of the filename template. May throw ConfigException if the property FILE_NAME_TEMPLATE_CONFIG is not set.

Returns:

the text of the filename template.

getFilenameTemplate

public Template getFilenameTemplate()

Gets the filename template.

Returns:

the Filename template.

getFilenameTimezone

public ZoneId getFilenameTimezone()

Gets the filename timezone

Returns:

The timezone specified for filenames.

getFilenameTimestampSource

public TimestampSource getFilenameTimestampSource()

Gets the timestamp source for the file name.

Returns:

the timestamp source for the file name.

getMaxRecordsPerFile

public int getMaxRecordsPerFile()

Gets the maximum number of records allowed in a file.

Returns:

the maximum number of records allowed in a file.