org.apache.beam.sdk.io.solr

Class SolrIO.Read

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<org.apache.solr.common.SolrDocument>>

org.apache.beam.sdk.io.solr.SolrIO.Read

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

SolrIO

public abstract static class SolrIO.Read
extends PTransform<PBegin,PCollection<org.apache.solr.common.SolrDocument>>

A PTransform reading data from Solr.

See Also:

Serialized Form

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<org.apache.solr.common.SolrDocument>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
SolrIO.Read	from(java.lang.String collection) Provide name of collection while reading from Solr.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
SolrIO.Read	withConnectionConfiguration(SolrIO.ConnectionConfiguration connectionConfiguration) Provide the Solr connection configuration object.
SolrIO.Read	withQuery(java.lang.String query) Provide a query used while reading from Solr.

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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString, 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

withConnectionConfiguration

public SolrIO.Read withConnectionConfiguration(SolrIO.ConnectionConfiguration connectionConfiguration)

Provide the Solr connection configuration object.

from

public SolrIO.Read from(java.lang.String collection)

Provide name of collection while reading from Solr.

Parameters:

collection - the collection toward which the requests will be issued

withQuery

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

Provide a query used while reading from Solr.

Parameters:

query - the query. See Solr Query

expand

public PCollection<org.apache.solr.common.SolrDocument> 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<org.apache.solr.common.SolrDocument>>

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<org.apache.solr.common.SolrDocument>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData