org.apache.beam.sdk.io.kudu

Class KuduIO.Read<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<T>>

org.apache.beam.sdk.io.kudu.KuduIO.Read<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

KuduIO

public abstract static class KuduIO.Read<T>
extends PTransform<PBegin,PCollection<T>>

Implementation of KuduIO.read().

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<T>	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 pipelineOptions) Called before running the Pipeline to verify this transform is fully and correctly specified.
KuduIO.Read<T>	withBatchSize(int batchSize) Reads from the table in batches of the specified size.
KuduIO.Read<T>	withCoder(Coder<T> coder) Sets a Coder for the result of the parse function.
KuduIO.Read<T>	withFaultTolerent(boolean faultTolerent) Instructs the read scan to resume a scan on another tablet server if the current server fails and faultTolerant is set to true.
KuduIO.Read<T>	withMasterAddresses(java.lang.String masterAddresses) Reads from the Kudu cluster on the specified master addresses.
KuduIO.Read<T>	withParseFn(SerializableFunction<org.apache.kudu.client.RowResult,T> parseFn) Provides the function to parse a row from Kudu into the typed object.
KuduIO.Read<T>	withPredicates(java.util.List<org.apache.kudu.client.KuduPredicate> predicates) Filters the rows read from Kudu using the given predicates.
KuduIO.Read<T>	withProjectedColumns(java.util.List<java.lang.String> projectedColumns) Filters the columns read from the table to include only those specified.
KuduIO.Read<T>	withTable(java.lang.String table) Reads from the specified table.

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

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

withMasterAddresses

public KuduIO.Read<T> withMasterAddresses(java.lang.String masterAddresses)

Reads from the Kudu cluster on the specified master addresses.

withTable

public KuduIO.Read<T> withTable(java.lang.String table)

Reads from the specified table.

withParseFn

public KuduIO.Read<T> withParseFn(SerializableFunction<org.apache.kudu.client.RowResult,T> parseFn)

Provides the function to parse a row from Kudu into the typed object.

withPredicates

public KuduIO.Read<T> withPredicates(java.util.List<org.apache.kudu.client.KuduPredicate> predicates)

Filters the rows read from Kudu using the given predicates.

withProjectedColumns

public KuduIO.Read<T> withProjectedColumns(java.util.List<java.lang.String> projectedColumns)

Filters the columns read from the table to include only those specified.

withBatchSize

public KuduIO.Read<T> withBatchSize(int batchSize)

Reads from the table in batches of the specified size.

withFaultTolerent

public KuduIO.Read<T> withFaultTolerent(boolean faultTolerent)

Instructs the read scan to resume a scan on another tablet server if the current server fails and faultTolerant is set to true.

withCoder

public KuduIO.Read<T> withCoder(Coder<T> coder)

Sets a Coder for the result of the parse function. This may be required if a coder can not be inferred automatically.

expand

public PCollection<T> 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<T>>

validate

public void validate(PipelineOptions pipelineOptions)

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

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

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData