org.apache.beam.sdk.io.influxdb

Class InfluxDbIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<java.lang.String>,PDone>

org.apache.beam.sdk.io.influxdb.InfluxDbIO.Write

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

InfluxDbIO

public abstract static class InfluxDbIO.Write
extends PTransform<PCollection<java.lang.String>,PDone>

A PTransform to write to a InfluxDB datasource.

See Also:

Serialized Form

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<java.lang.String> input) Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
InfluxDbIO.Write	withBatchSize(int batchSize) Number of elements to batch.
InfluxDbIO.Write	withConsistencyLevel(InfluxDB.ConsistencyLevel consistencyLevel) Sets the consistency level to use.
InfluxDbIO.Write	withDatabase(java.lang.String database) Writes to the specified database.
InfluxDbIO.Write	withDataSourceConfiguration(InfluxDbIO.DataSourceConfiguration configuration) Writes to the InfluxDB instance indicated by the given configuration.
InfluxDbIO.Write	withDisableCertificateValidation(boolean disableCertificateValidation) Disable SSL certification validation.
InfluxDbIO.Write	withRetentionPolicy(java.lang.String rp) Sets the retention policy to use.

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, 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 PDone expand(PCollection<java.lang.String> 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<java.lang.String>,PDone>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<java.lang.String>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

withBatchSize

public InfluxDbIO.Write withBatchSize(int batchSize)

Number of elements to batch. *

withDisableCertificateValidation

public InfluxDbIO.Write withDisableCertificateValidation(boolean disableCertificateValidation)

Disable SSL certification validation. *

withRetentionPolicy

public InfluxDbIO.Write withRetentionPolicy(java.lang.String rp)

Sets the retention policy to use. *

withConsistencyLevel

public InfluxDbIO.Write withConsistencyLevel(InfluxDB.ConsistencyLevel consistencyLevel)

Sets the consistency level to use. ALL("all") Write succeeds only if write reached all cluster members. ANY("any") Write succeeds if write reached at least one cluster members. ONE("one") Write succeeds if write reached at least one cluster members. QUORUM("quorum") Write succeeds only if write reached a quorum of cluster members.

withDataSourceConfiguration

public InfluxDbIO.Write withDataSourceConfiguration(InfluxDbIO.DataSourceConfiguration configuration)

Writes to the InfluxDB instance indicated by the given configuration.

withDatabase

public InfluxDbIO.Write withDatabase(java.lang.String database)

Writes to the specified database.