Package com.bakdata.kafka.consumer

Record Class ConfiguredConsumerApp<T extends ConsumerApp>

java.lang.Object

java.lang.Record

com.bakdata.kafka.consumer.ConfiguredConsumerApp<T>

Type Parameters:

T - type of ConsumerApp

All Implemented Interfaces:

ConfiguredApp<ExecutableConsumerApp<T>>, AutoCloseable

public record ConfiguredConsumerApp<T extends ConsumerApp>(T extends ConsumerApp app, @NonNull ConsumerAppConfiguration configuration)
extends Record
implements ConfiguredApp<ExecutableConsumerApp<T>>

A ConsumerApp with a corresponding ConsumerAppConfiguration

Constructor Summary

Constructors

Constructor	Description
ConfiguredConsumerApp(T app, @NonNull ConsumerAppConfiguration configuration)	Creates an instance of a ConfiguredConsumerApp record class.

Method Summary

Modifier and Type	Method	Description
T	app()	Returns the value of the app record component.
void	close()
@NonNull ConsumerAppConfiguration	configuration()	Returns the value of the configuration record component.
static Map<String,Object>	createBaseConfig()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,Object>	getKafkaProperties(RuntimeConfiguration runtimeConfiguration)	This method creates the configuration to run a ConsumerApp.
ConsumerTopicConfig	getTopics()	Get topic configuration
String	getUniqueGroupId()	Get unique group identifier of ConsumerApp
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
ExecutableConsumerApp<T>	withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)	Create an ExecutableConsumerApp using the provided RuntimeConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConfiguredConsumerApp

public ConfiguredConsumerApp(@NonNull
 T app,
 @NonNull
 @NonNull ConsumerAppConfiguration configuration)

Creates an instance of a ConfiguredConsumerApp record class.

Parameters:

app - the value for the app record component

configuration - the value for the configuration record component

Method Details

createBaseConfig

public static Map<String,Object> createBaseConfig()

getKafkaProperties

public Map<String,Object> getKafkaProperties(RuntimeConfiguration runtimeConfiguration)

This method creates the configuration to run a ConsumerApp.

Configuration is created in the following order

• Offset management:

   auto.offset.reset=earliest
   enable.auto.commit=false
   

• Configs provided by App.createKafkaProperties()
• Configs provided via environment variables (see EnvironmentKafkaConfigParser.parseVariables(Map))
• Configs provided by RuntimeConfiguration.createKafkaProperties()
• ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG and ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG is configured using ConsumerApp.defaultSerializationConfig()

Parameters:

runtimeConfiguration - configuration to run app with

Returns:

Kafka configuration

getUniqueGroupId

public String getUniqueGroupId()

Get unique group identifier of ConsumerApp

Returns:

unique group identifier

Throws:

IllegalArgumentException - if unique group identifier of ConsumerApp is different from provided group identifier in ConsumerAppConfiguration

See Also:

• ConsumerApp.getUniqueGroupId(ConsumerAppConfiguration)

withRuntimeConfiguration

public ExecutableConsumerApp<T> withRuntimeConfiguration(RuntimeConfiguration runtimeConfiguration)

Create an ExecutableConsumerApp using the provided RuntimeConfiguration

Specified by:

withRuntimeConfiguration in interface ConfiguredApp<T extends ConsumerApp>

Parameters:

runtimeConfiguration - configuration to run app with

Returns:

ExecutableConsumerApp

getTopics

public ConsumerTopicConfig getTopics()

Get topic configuration

Returns:

topic configuration

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ConfiguredApp<T extends ConsumerApp>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

app

@NonNull
public T app()

Returns the value of the app record component.

Returns:

the value of the app record component

configuration

@NonNull
public @NonNull ConsumerAppConfiguration configuration()

Returns the value of the configuration record component.

Returns:

the value of the configuration record component