org.apache.beam.sdk.io.elasticsearch

Class ElasticsearchIO.BoundedElasticsearchSource

java.lang.Object

org.apache.beam.sdk.io.Source<T>

org.apache.beam.sdk.io.BoundedSource<java.lang.String>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

ElasticsearchIO

public static class ElasticsearchIO.BoundedElasticsearchSource
extends BoundedSource<java.lang.String>

A BoundedSource reading from Elasticsearch.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.BoundedSource

BoundedSource.BoundedReader<T>

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.Source

Source.Reader<T>

Method Summary

Modifier and Type	Method and Description
BoundedSource.BoundedReader<java.lang.String>	createReader(PipelineOptions options) Returns a new BoundedSource.BoundedReader that reads from this source.
long	getEstimatedSizeBytes(PipelineOptions options) An estimate of the total size (in bytes) of the data that would be read from this source.
Coder<java.lang.String>	getOutputCoder() Returns the Coder to use for the data read from this source.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
java.util.List<? extends BoundedSource<java.lang.String>>	split(long desiredBundleSizeBytes, PipelineOptions options) Splits the source into bundles of approximately desiredBundleSizeBytes.
void	validate() Checks that this source is valid, before it can be used in a pipeline.

Methods inherited from class org.apache.beam.sdk.io.Source

getDefaultOutputCoder

Methods inherited from class java.lang.Object

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

Method Detail

split

public java.util.List<? extends BoundedSource<java.lang.String>> split(long desiredBundleSizeBytes,
                                                                       PipelineOptions options)
                                                                throws java.lang.Exception

Description copied from class: BoundedSource

Splits the source into bundles of approximately desiredBundleSizeBytes.

Specified by:

split in class BoundedSource<java.lang.String>

Throws:

java.lang.Exception

getEstimatedSizeBytes

public long getEstimatedSizeBytes(PipelineOptions options)
                           throws java.io.IOException

Description copied from class: BoundedSource

An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.

If there is no way to estimate the size of the source implementations MAY return 0L.

Specified by:

getEstimatedSizeBytes in class BoundedSource<java.lang.String>

Throws:

java.io.IOException

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: Source

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 Source<java.lang.String>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

createReader

public BoundedSource.BoundedReader<java.lang.String> createReader(PipelineOptions options)

Description copied from class: BoundedSource

Returns a new BoundedSource.BoundedReader that reads from this source.

Specified by:

createReader in class BoundedSource<java.lang.String>

validate

public void validate()

Description copied from class: Source

Checks that this source is valid, before it can be used in a pipeline.

It is recommended to use Preconditions for implementing this method.

Overrides:

validate in class Source<java.lang.String>

getOutputCoder

public Coder<java.lang.String> getOutputCoder()

Description copied from class: Source

Returns the Coder to use for the data read from this source.

Overrides:

getOutputCoder in class Source<java.lang.String>