Package org.apache.beam.sdk.io.influxdb

Class InfluxDbIO.Read

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

InfluxDbIO

public abstract static class InfluxDbIO.Read
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor	Description
Read()

Method Summary

Modifier and Type	Method	Description
org.apache.beam.sdk.values.PCollection<java.lang.String>	expand(org.apache.beam.sdk.values.PBegin input)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
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

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

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 org.apache.beam.sdk.values.PCollection<java.lang.String> expand(org.apache.beam.sdk.values.PBegin input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<java.lang.String>>

populateDisplayData

public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

Specified by:

populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData

Overrides:

populateDisplayData in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<java.lang.String>>