org.apache.beam.it.kafka

Class KafkaResourceManager.Builder

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder<KafkaResourceManager>

org.apache.beam.it.kafka.KafkaResourceManager.Builder

Enclosing class:

KafkaResourceManager

public static final class KafkaResourceManager.Builder
extends TestContainerResourceManager.Builder<KafkaResourceManager>

Builder for KafkaResourceManager.

Field Summary

Fields inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder

containerImageName, containerImageTag, host, port, testId, useStaticContainer

Method Summary

Modifier and Type	Method and Description
KafkaResourceManager	build() Builds and returns a Resource Manager that extends TestContainerResourceManager.
KafkaResourceManager.Builder	setNumTopics(int numTopics) Sets the number of topics to be used instead of explicitly assign the topic names.
KafkaResourceManager.Builder	setTopicNames(java.util.Set<java.lang.String> topicNames) Sets names of topics to be used to that of a static kafka instance.

Methods inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager.Builder

setContainerImageName, setContainerImageTag, setHost, setPort, useStaticContainer

Methods inherited from class java.lang.Object

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

Method Detail

setTopicNames

public KafkaResourceManager.Builder setTopicNames(java.util.Set<java.lang.String> topicNames)

Sets names of topics to be used to that of a static kafka instance. Use this method only when attempting to operate on pre-existing kafka topics.

Note: if a topic name is set, and a static kafka server is being used (useStaticContainer() is also called on the builder), then a topic will be created on the static server if it does not exist, and it will NOT be removed when cleanupAll() is called on the KafkaResourceManager.

Parameters:

topicNames - A set of topic names.

Returns:

this builder object with the topic name set.

setNumTopics

public KafkaResourceManager.Builder setNumTopics(int numTopics)

Sets the number of topics to be used instead of explicitly assign the topic names.

Note: if number of topics is set, and a static kafka server is being used (useStaticContainer() is also called on the builder), then the assigned number of topics will be created on the static server, and it will be removed when cleanupAll() is called on the KafkaResourceManager.

Parameters:

numTopics - number of topics to be created. Default is 1.

Returns:

this builder object with numTopics set.

build

public KafkaResourceManager build()

Description copied from class: TestContainerResourceManager.Builder

Builds and returns a Resource Manager that extends TestContainerResourceManager.

Specified by:

build in class TestContainerResourceManager.Builder<KafkaResourceManager>

Returns:

an instance of TestContainerResourceManager