org.apache.beam.sdk.io.influxdb

Class InfluxDbIO.Read

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

InfluxDbIO

public abstract static class InfluxDbIO.Read
extends PTransform<PBegin,PCollection<java.lang.String>>

A PTransform to read from InfluxDB metric or data related to query. See InfluxDB for more information on usage and configuration.

See Also:

Serialized Form

Field Summary

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

name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<java.lang.String>	expand(PBegin 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.Read	withDatabase(java.lang.String database) Reads from the specified database.
InfluxDbIO.Read	withDataSourceConfiguration(InfluxDbIO.DataSourceConfiguration configuration) Reads from the InfluxDB instance indicated by the given configuration.
InfluxDbIO.Read	withDisableCertificateValidation(boolean disableCertificateValidation) Disable SSL certification validation.
InfluxDbIO.Read	withFromDateTime(java.lang.String fromDateTime) Read metric data from the fromDateTime.
InfluxDbIO.Read	withMetric(@Nullable java.lang.String metric) Sets the metric to use.
InfluxDbIO.Read	withQuery(java.lang.String query) Sets the query to use.
InfluxDbIO.Read	withRetentionPolicy(java.lang.String retentionPolicy) Sets the retention policy to use.
InfluxDbIO.Read	withToDateTime(java.lang.String toDateTime) Read metric data till the toDateTime.

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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Read

public Read()

Method Detail

withDataSourceConfiguration

public InfluxDbIO.Read withDataSourceConfiguration(InfluxDbIO.DataSourceConfiguration configuration)

Reads from the InfluxDB instance indicated by the given configuration.

withDatabase

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

Reads from the specified database.

withToDateTime

public InfluxDbIO.Read withToDateTime(java.lang.String toDateTime)

Read metric data till the toDateTime. *

withFromDateTime

public InfluxDbIO.Read withFromDateTime(java.lang.String fromDateTime)

Read metric data from the fromDateTime. *

withMetric

public InfluxDbIO.Read withMetric(@Nullable java.lang.String metric)

Sets the metric to use. *

withDisableCertificateValidation

public InfluxDbIO.Read withDisableCertificateValidation(boolean disableCertificateValidation)

Disable SSL certification validation. *

withRetentionPolicy

public InfluxDbIO.Read withRetentionPolicy(java.lang.String retentionPolicy)

Sets the retention policy to use. *

withQuery

public InfluxDbIO.Read withQuery(java.lang.String query)

Sets the query to use. *

expand

public PCollection<java.lang.String> expand(PBegin 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<PBegin,PCollection<java.lang.String>>

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<PBegin,PCollection<java.lang.String>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData