org.apache.beam.sdk.io.redis

Class RedisIO.WriteStreams

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<KV<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>,PDone>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

RedisIO

public abstract static class RedisIO.WriteStreams
extends PTransform<PCollection<KV<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>,PDone>

A PTransform to write stream key pairs (https://redis.io/topics/streams-intro) to a Redis server.

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
WriteStreams()

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<KV<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> input) Override this method to specify how this PTransform should be expanded on the given InputT.
RedisIO.WriteStreams	withApproximateTrim(boolean approximateTrim) If withMaxLen(long) is used, set the "~" prefix to the MAXLEN value, indicating to the server that it should use "close enough" trimming.
RedisIO.WriteStreams	withAuth(java.lang.String auth) Use the redis AUTH command when connecting to the server; the format of the string can be either just a password or a username and password separated by a space.
RedisIO.WriteStreams	withConnectionConfiguration(RedisConnectionConfiguration connection) Predefine a RedisConnectionConfiguration and pass it to the builder.
RedisIO.WriteStreams	withEndpoint(java.lang.String host, int port) Set the hostname and port of the Redis server to connect to.
RedisIO.WriteStreams	withMaxLen(long maxLen) When appending (XADD) to a stream, set a MAXLEN option.
RedisIO.WriteStreams	withTimeout(int timeout) Set the connection timeout for the Redis server connection.

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteStreams

public WriteStreams()

Method Detail

withEndpoint

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

Set the hostname and port of the Redis server to connect to.

withAuth

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

Use the redis AUTH command when connecting to the server; the format of the string can be either just a password or a username and password separated by a space. See https://redis.io/commands/auth for details

withTimeout

public RedisIO.WriteStreams withTimeout(int timeout)

Set the connection timeout for the Redis server connection.

withConnectionConfiguration

public RedisIO.WriteStreams withConnectionConfiguration(RedisConnectionConfiguration connection)

Predefine a RedisConnectionConfiguration and pass it to the builder.

withMaxLen

public RedisIO.WriteStreams withMaxLen(long maxLen)

When appending (XADD) to a stream, set a MAXLEN option.

withApproximateTrim

public RedisIO.WriteStreams withApproximateTrim(boolean approximateTrim)

If withMaxLen(long) is used, set the "~" prefix to the MAXLEN value, indicating to the server that it should use "close enough" trimming.

expand

public PDone expand(PCollection<KV<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> 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<PCollection<KV<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>,PDone>