org.apache.beam.it.testcontainers

Class TestContainerResourceManager.Builder<T extends TestContainerResourceManager<?>>

java.lang.Object

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

Direct Known Subclasses:

AbstractJDBCResourceManager.Builder, CassandraResourceManager.Builder, ElasticsearchResourceManager.Builder, KafkaResourceManager.Builder, MongoDBResourceManager.Builder, Neo4jResourceManager.Builder, SplunkResourceManager.Builder

Enclosing class:

TestContainerResourceManager<T extends GenericContainer<?>>

public abstract static class TestContainerResourceManager.Builder<T extends TestContainerResourceManager<?>>
extends java.lang.Object

Builder for TestContainerResourceManager.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	containerImageName
java.lang.String	containerImageTag
java.lang.String	host
int	port
java.lang.String	testId
boolean	useStaticContainer

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String testId, java.lang.String containerImageName, java.lang.String containerImageTag)

Method Summary

Modifier and Type	Method and Description
abstract T	build() Builds and returns a Resource Manager that extends TestContainerResourceManager.
TestContainerResourceManager.Builder<T>	setContainerImageName(java.lang.String containerName) Sets the name of the test container image.
TestContainerResourceManager.Builder<T>	setContainerImageTag(java.lang.String containerTag) Sets the tag for the test container.
TestContainerResourceManager.Builder<T>	setHost(java.lang.String containerHost) Sets the host of the resource that the resource manager will connect to.
TestContainerResourceManager.Builder<T>	setPort(int port) Sets the port that the resource is hosted on.
TestContainerResourceManager.Builder<T>	useStaticContainer() Configures the resource manager to use a static resource instead of creating a new TestContainer instance of the resource.

Methods inherited from class java.lang.Object

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

Field Detail

testId

public java.lang.String testId

containerImageName

public java.lang.String containerImageName

containerImageTag

public java.lang.String containerImageTag

host

@Nullable
public java.lang.String host

port

public int port

useStaticContainer

public boolean useStaticContainer

Constructor Detail

Builder

public Builder(java.lang.String testId,
               java.lang.String containerImageName,
               java.lang.String containerImageTag)

Method Detail

setContainerImageName

public TestContainerResourceManager.Builder<T> setContainerImageName(java.lang.String containerName)

Sets the name of the test container image. The tag is typically the version of the image.

Parameters:

containerName - The name of the container image.

Returns:

this builder object with the image name set.

setContainerImageTag

public TestContainerResourceManager.Builder<T> setContainerImageTag(java.lang.String containerTag)

Sets the tag for the test container. The tag is typically the version of the image.

Parameters:

containerTag - The tag to use for the container.

Returns:

this builder object with the tag set.

setHost

public TestContainerResourceManager.Builder<T> setHost(java.lang.String containerHost)

Sets the host of the resource that the resource manager will connect to. This will default to localhost if not set.

Parameters:

containerHost - the resource host address.

Returns:

this builder object with the host set.

setPort

public TestContainerResourceManager.Builder<T> setPort(int port)

Sets the port that the resource is hosted on.

Parameters:

port - the port the resource is hosted on.

Returns:

this builder object with the port set.

useStaticContainer

public TestContainerResourceManager.Builder<T> useStaticContainer()

Configures the resource manager to use a static resource instead of creating a new TestContainer instance of the resource. This can be another TestContainer or any other VM or server hosting the resource.

Note: When this option is enabled, the setPort() and setHost() methods must also be called to configure the static resource address.

Returns:

this builder object with the useStaticContainer option enabled.

build

public abstract T build()

Builds and returns a Resource Manager that extends TestContainerResourceManager.

Returns:

an instance of TestContainerResourceManager