org.apache.beam.sdk.io.elasticsearch

Class ElasticsearchIO.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.elasticsearch.ElasticsearchIO.Read

All Implemented Interfaces:

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

Enclosing class:

ElasticsearchIO

public abstract static class ElasticsearchIO.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 reading data from Elasticsearch.

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
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)
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	withMetadata() Include metadata in result json documents.
ElasticsearchIO.Read	withQuery(java.lang.String query) Provide a query used while reading from Elasticsearch.
ElasticsearchIO.Read	withQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query) Provide a ValueProvider that provides the 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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, 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 ElasticsearchIO.Read withConnectionConfiguration(ElasticsearchIO.ConnectionConfiguration connectionConfiguration)

Provide the Elasticsearch connection configuration object.

Parameters:

connectionConfiguration - a ElasticsearchIO.ConnectionConfiguration describes a connection configuration to Elasticsearch.

Returns:

a PTransform reading data from Elasticsearch.

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:

a PTransform reading data from Elasticsearch.

withQuery

public ElasticsearchIO.Read withQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)

Provide a ValueProvider that provides the query used while reading from Elasticsearch. This is useful for cases when the query must be dynamic.

Parameters:

query - the query. See Query DSL

Returns:

a PTransform reading data from Elasticsearch.

withMetadata

public ElasticsearchIO.Read withMetadata()

Include metadata in result json documents. Document source will be under json node _source.

Returns:

a PTransform reading data from Elasticsearch.

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 of the scroll

Returns:

a PTransform reading data from Elasticsearch.

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:

a PTransform reading data from Elasticsearch.

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