org.apache.beam.sdk.io.splunk

Class SplunkIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<SplunkEvent>,PCollection<SplunkWriteError>>

org.apache.beam.sdk.io.splunk.SplunkIO.Write

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

SplunkIO

public abstract static class SplunkIO.Write
extends PTransform<PCollection<SplunkEvent>,PCollection<SplunkWriteError>>

Class SplunkIO.Write provides a PTransform that allows writing SplunkEvent records into a Splunk HTTP Event Collector end-point using HTTP POST requests.

In the event of an error, a PCollection<SplunkWriteError> is returned for further processing or storing into a dead-letter sink.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
PCollection<SplunkWriteError>	expand(PCollection<SplunkEvent> input) Override this method to specify how this PTransform should be expanded on the given InputT.
SplunkIO.Write	withBatchCount(java.lang.Integer batchCount) Sets batchCount for sending multiple events in a single request to the HEC.
SplunkIO.Write	withBatchCount(ValueProvider<java.lang.Integer> batchCount) Same as withBatchCount(Integer) but with ValueProvider.
SplunkIO.Write	withDisableCertificateValidation(java.lang.Boolean disableCertificateValidation) Disables ssl certificate validation.
SplunkIO.Write	withDisableCertificateValidation(ValueProvider<java.lang.Boolean> disableCertificateValidation) Same as withDisableCertificateValidation(Boolean) but with ValueProvider.
SplunkIO.Write	withEnableBatchLogs(java.lang.Boolean enableBatchLogs) Method to enable batch logs.
SplunkIO.Write	withEnableBatchLogs(ValueProvider<java.lang.Boolean> enableBatchLogs) Same as Builder#withEnableBatchLogs(ValueProvider) but without a ValueProvider.
SplunkIO.Write	withEnableGzipHttpCompression(java.lang.Boolean enableGzipHttpCompression) Method to specify if HTTP requests sent to Splunk should be GZIP encoded.
SplunkIO.Write	withEnableGzipHttpCompression(ValueProvider<java.lang.Boolean> enableGzipHttpCompression) Same as Builder#withEnableGzipHttpCompression(ValueProvider) but without a ValueProvider.
SplunkIO.Write	withParallelism(java.lang.Integer parallelism) Sets the number of parallel http client connections to the HEC.
SplunkIO.Write	withParallelism(ValueProvider<java.lang.Integer> parallelism) Same as withBatchCount(Integer) but with ValueProvider.
SplunkIO.Write	withRootCaCertificatePath(java.lang.String rootCaCertificatePath) Method to set the root CA certificate.
SplunkIO.Write	withRootCaCertificatePath(ValueProvider<java.lang.String> rootCaCertificatePath) Same as Builder#withRootCaCertificatePath(ValueProvider) but without a ValueProvider.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

expand

public PCollection<SplunkWriteError> expand(PCollection<SplunkEvent> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<SplunkEvent>,PCollection<SplunkWriteError>>

withBatchCount

public SplunkIO.Write withBatchCount(ValueProvider<java.lang.Integer> batchCount)

Same as withBatchCount(Integer) but with ValueProvider.

Parameters:

batchCount - for batching requests

withBatchCount

public SplunkIO.Write withBatchCount(java.lang.Integer batchCount)

Sets batchCount for sending multiple events in a single request to the HEC.

Parameters:

batchCount - for batching requests

withParallelism

public SplunkIO.Write withParallelism(ValueProvider<java.lang.Integer> parallelism)

Same as withBatchCount(Integer) but with ValueProvider.

Parameters:

parallelism - for controlling the number of concurrent http client connections

withParallelism

public SplunkIO.Write withParallelism(java.lang.Integer parallelism)

Sets the number of parallel http client connections to the HEC.

Parameters:

parallelism - controlling the number of http client connections

Returns:

Builder

withDisableCertificateValidation

public SplunkIO.Write withDisableCertificateValidation(ValueProvider<java.lang.Boolean> disableCertificateValidation)

Same as withDisableCertificateValidation(Boolean) but with ValueProvider.

Parameters:

disableCertificateValidation - for disabling certificate validation

Returns:

Builder

withDisableCertificateValidation

public SplunkIO.Write withDisableCertificateValidation(java.lang.Boolean disableCertificateValidation)

Disables ssl certificate validation.

Parameters:

disableCertificateValidation - for disabling certificate validation

withRootCaCertificatePath

public SplunkIO.Write withRootCaCertificatePath(ValueProvider<java.lang.String> rootCaCertificatePath)

Same as Builder#withRootCaCertificatePath(ValueProvider) but without a ValueProvider.

Parameters:

rootCaCertificatePath - Path to root CA certificate

Returns:

Builder

withRootCaCertificatePath

public SplunkIO.Write withRootCaCertificatePath(java.lang.String rootCaCertificatePath)

Method to set the root CA certificate.

Parameters:

rootCaCertificatePath - Path to root CA certificate

Returns:

Builder

withEnableBatchLogs

public SplunkIO.Write withEnableBatchLogs(ValueProvider<java.lang.Boolean> enableBatchLogs)

Same as Builder#withEnableBatchLogs(ValueProvider) but without a ValueProvider.

Parameters:

enableBatchLogs - whether to enable Gzip encoding.

Returns:

Builder

withEnableBatchLogs

public SplunkIO.Write withEnableBatchLogs(java.lang.Boolean enableBatchLogs)

Method to enable batch logs.

Parameters:

enableBatchLogs - whether to enable Gzip encoding.

Returns:

Builder

withEnableGzipHttpCompression

public SplunkIO.Write withEnableGzipHttpCompression(ValueProvider<java.lang.Boolean> enableGzipHttpCompression)

Same as Builder#withEnableGzipHttpCompression(ValueProvider) but without a ValueProvider.

Parameters:

enableGzipHttpCompression - whether to enable Gzip encoding.

Returns:

Builder

withEnableGzipHttpCompression

public SplunkIO.Write withEnableGzipHttpCompression(java.lang.Boolean enableGzipHttpCompression)

Method to specify if HTTP requests sent to Splunk should be GZIP encoded.

Parameters:

enableGzipHttpCompression - whether to enable Gzip encoding.

Returns:

Builder