org.apache.beam.it.splunk

Class SplunkResourceManager.Builder

java.lang.Object

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

org.apache.beam.it.splunk.SplunkResourceManager.Builder

Enclosing class:

SplunkResourceManager

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

Builder for SplunkResourceManager.

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
SplunkResourceManager	build() Builds and returns a Resource Manager that extends TestContainerResourceManager.
SplunkResourceManager.Builder	setHecPort(int port) Sets the port that the Splunk Http Event Collector (HEC) service is hosted on.
SplunkResourceManager.Builder	setHecToken(java.lang.String hecToken) Manually set the Splunk HTTP Event Collector (HEC) token to the given token.
SplunkResourceManager.Builder	setHost(java.lang.String containerHost) Sets the host of the resource that the resource manager will connect to.
SplunkResourceManager.Builder	setPassword(java.lang.String password) Manually set the Splunk password to the given password.
SplunkResourceManager.Builder	setPort(int port) Sets the port that the resource is hosted on.
SplunkResourceManager.Builder	setSplunkdPort(int port) Sets the port that the Splunkd service is hosted on.
SplunkResourceManager.Builder	setUsername(java.lang.String username) Set the username used to connect to a static Splunk instance.

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

setContainerImageName, setContainerImageTag, useStaticContainer

Methods inherited from class java.lang.Object

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

Method Detail

setUsername

public SplunkResourceManager.Builder setUsername(java.lang.String username)

Set the username used to connect to a static Splunk instance.

Note: This method should only be used if useStaticContainer() is also called.

Parameters:

username - the username for the Splunk instance.

Returns:

this builder with the username manually set.

setPassword

public SplunkResourceManager.Builder setPassword(java.lang.String password)

Manually set the Splunk password to the given password. This password will be used by the resource manager to authenticate with Splunk.

Parameters:

password - the password for the Splunk instance.

Returns:

this builder with the password manually set.

setHecToken

public SplunkResourceManager.Builder setHecToken(java.lang.String hecToken)

Manually set the Splunk HTTP Event Collector (HEC) token to the given token. This token will be used by the resource manager to authenticate with Splunk.

Parameters:

hecToken - the HEC token for the Splunk instance.

Returns:

this builder with the HEC token manually set.

setHost

public SplunkResourceManager.Builder setHost(java.lang.String containerHost)

Description copied from class: TestContainerResourceManager.Builder

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

Overrides:

setHost in class TestContainerResourceManager.Builder<SplunkResourceManager>

Parameters:

containerHost - the resource host address.

Returns:

this builder object with the host set.

setPort

public SplunkResourceManager.Builder setPort(int port)

Description copied from class: TestContainerResourceManager.Builder

Sets the port that the resource is hosted on.

Overrides:

setPort in class TestContainerResourceManager.Builder<SplunkResourceManager>

Parameters:

port - the port the resource is hosted on.

Returns:

this builder object with the port set.

setHecPort

public SplunkResourceManager.Builder setHecPort(int port)

Sets the port that the Splunk Http Event Collector (HEC) service is hosted on.

Parameters:

port - the port hosting the HEC service.

Returns:

this builder object with the HEC port set.

setSplunkdPort

public SplunkResourceManager.Builder setSplunkdPort(int port)

Sets the port that the Splunkd service is hosted on.

Parameters:

port - the port hosting the Splunkd service.

Returns:

this builder object with the Splunkd port set.

build

public SplunkResourceManager build()

Description copied from class: TestContainerResourceManager.Builder

Builds and returns a Resource Manager that extends TestContainerResourceManager.

Specified by:

build in class TestContainerResourceManager.Builder<SplunkResourceManager>

Returns:

an instance of TestContainerResourceManager