org.apache.beam.sdk.io.elasticsearch

Class ElasticsearchIO.Read

java.lang.Object

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

org.apache.beam.sdk.io.elasticsearch.ElasticsearchIO.Read

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

ElasticsearchIO

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

A PTransform reading data from Elasticsearch.

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<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.
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
ElasticsearchIO.Read	withBatchSize(long batchSize) Provide a size for the scroll read.
ElasticsearchIO.Read	withConnectionConfiguration(ElasticsearchIO.ConnectionConfiguration connectionConfiguration) Provide the Elasticsearch connection configuration object.
ElasticsearchIO.Read	withQuery(java.lang.String query) Provide a query used while reading from Elasticsearch.
ElasticsearchIO.Read	withScrollKeepalive(java.lang.String scrollKeepalive) Provide a scroll keepalive.

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

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

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 ElasticsearchIO.Read withConnectionConfiguration(ElasticsearchIO.ConnectionConfiguration connectionConfiguration)

Provide the Elasticsearch connection configuration object.

Parameters:

connectionConfiguration - the Elasticsearch ElasticsearchIO.ConnectionConfiguration object

Returns:

the ElasticsearchIO.Read with connection configuration set

withQuery

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

Provide a query used while reading from Elasticsearch.

Parameters:

query - the query. See Query DSL

Returns:

the ElasticsearchIO.Read object with query set

withScrollKeepalive

public ElasticsearchIO.Read withScrollKeepalive(java.lang.String scrollKeepalive)

Provide a scroll keepalive. See scroll API Default is "5m". Change this only if you get "No search context found" errors.

Parameters:

scrollKeepalive - keepalive duration ex "5m" from 5 minutes

Returns:

the ElasticsearchIO.Read with scroll keepalive set

withBatchSize

public ElasticsearchIO.Read withBatchSize(long batchSize)

Provide a size for the scroll read. See scroll API Default is 100. Maximum is 10 000. If documents are small, increasing batch size might improve read performance. If documents are big, you might need to decrease batchSize

Parameters:

batchSize - number of documents read in each scroll read

Returns:

the ElasticsearchIO.Read with batch size set

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>>

validate

public void validate(PipelineOptions options)

Description copied from class: PTransform

Called before running the Pipeline to verify this transform is fully and correctly specified.

By default, does nothing.

Overrides:

validate 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