org.apache.beam.sdk.io.redis

Class RedisIO.Read

java.lang.Object

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

org.apache.beam.sdk.io.redis.RedisIO.Read

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

RedisIO

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

Implementation of RedisIO.read().

See Also:

Serialized Form

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<KV<java.lang.String,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.
RedisIO.Read	withAuth(java.lang.String auth)
RedisIO.Read	withBatchSize(int batchSize)
RedisIO.Read	withConnectionConfiguration(RedisConnectionConfiguration connection)
RedisIO.Read	withEndpoint(java.lang.String host, int port)
RedisIO.Read	withKeyPattern(java.lang.String keyPattern)
RedisIO.Read	withOutputParallelization(boolean outputParallelization) Whether to reshuffle the resulting PCollection so results are distributed to all workers.
RedisIO.Read	withTimeout(int timeout)

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, toString, validate, 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

withEndpoint

public RedisIO.Read withEndpoint(java.lang.String host,
                                 int port)

withAuth

public RedisIO.Read withAuth(java.lang.String auth)

withTimeout

public RedisIO.Read withTimeout(int timeout)

withKeyPattern

public RedisIO.Read withKeyPattern(java.lang.String keyPattern)

withConnectionConfiguration

public RedisIO.Read withConnectionConfiguration(RedisConnectionConfiguration connection)

withBatchSize

public RedisIO.Read withBatchSize(int batchSize)

withOutputParallelization

public RedisIO.Read withOutputParallelization(boolean outputParallelization)

Whether to reshuffle the resulting PCollection so results are distributed to all workers. The default is to parallelize and should only be changed if this is known to be unnecessary.

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

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

expand

public PCollection<KV<java.lang.String,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<KV<java.lang.String,java.lang.String>>>