org.apache.beam.sdk.extensions.kryo

Class KryoCoderProvider

java.lang.Object

org.apache.beam.sdk.coders.CoderProvider

org.apache.beam.sdk.extensions.kryo.KryoCoderProvider

@Experimental
public class KryoCoderProvider
extends org.apache.beam.sdk.coders.CoderProvider

Implementation of CoderProvider, which provides KryoCoder for any type registered to Kryo by user-provided KryoRegistrar.

Method Summary

Modifier and Type	Method and Description
<T> org.apache.beam.sdk.coders.Coder<T>	coderFor(org.apache.beam.sdk.values.TypeDescriptor<T> typeDescriptor, java.util.List<? extends org.apache.beam.sdk.coders.Coder<?>> componentCoders)
static KryoCoderProvider	of() Create a new KryoCoderProvider with default KryoOptions.
static KryoCoderProvider	of(KryoRegistrar... registrars) Create a new KryoCoderProvider with default KryoOptions.
static KryoCoderProvider	of(java.util.List<KryoRegistrar> registrars) Create a new KryoCoderProvider with default KryoOptions.
static KryoCoderProvider	of(org.apache.beam.sdk.options.PipelineOptions pipelineOptions) Create a new KryoCoderProvider.
static KryoCoderProvider	of(org.apache.beam.sdk.options.PipelineOptions pipelineOptions, KryoRegistrar... registrars) Create a new KryoCoderProvider.
static KryoCoderProvider	of(org.apache.beam.sdk.options.PipelineOptions pipelineOptions, java.util.List<KryoRegistrar> registrars) Create a new KryoCoderProvider.
void	registerTo(org.apache.beam.sdk.Pipeline pipeline) Builds KryoCoderProvider and register it to given Pipeline.
KryoCoderProvider	withRegistrar(KryoRegistrar registrar) Create a new KryoCoderProvider with the provided registrar.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static KryoCoderProvider of()

Create a new KryoCoderProvider with default KryoOptions.

Returns:

A newly created KryoCoderProvider

of

public static KryoCoderProvider of(KryoRegistrar... registrars)

Create a new KryoCoderProvider with default KryoOptions.

Parameters:

registrars - KryoRegistrars which are used to register classes with underlying kryo instance

Returns:

A newly created KryoCoderProvider

of

public static KryoCoderProvider of(java.util.List<KryoRegistrar> registrars)

Create a new KryoCoderProvider with default KryoOptions.

Parameters:

registrars - KryoRegistrars which are used to register classes with underlying kryo instance

Returns:

A newly created KryoCoderProvider

of

public static KryoCoderProvider of(org.apache.beam.sdk.options.PipelineOptions pipelineOptions)

Create a new KryoCoderProvider.

Parameters:

pipelineOptions - Options used for coder setup. See KryoOptions for more details.

Returns:

A newly created KryoCoderProvider

of

public static KryoCoderProvider of(org.apache.beam.sdk.options.PipelineOptions pipelineOptions,
                                   KryoRegistrar... registrars)

Create a new KryoCoderProvider.

Parameters:

pipelineOptions - Options used for coder setup. See KryoOptions for more details.

registrars - KryoRegistrars which are used to register classes with underlying kryo instance

Returns:

A newly created KryoCoderProvider

of

public static KryoCoderProvider of(org.apache.beam.sdk.options.PipelineOptions pipelineOptions,
                                   java.util.List<KryoRegistrar> registrars)

Create a new KryoCoderProvider.

Parameters:

pipelineOptions - Options used for coder setup. See KryoOptions for more details.

registrars - KryoRegistrars which are used to register classes with underlying kryo instance

Returns:

A newly created KryoCoderProvider

coderFor

public <T> org.apache.beam.sdk.coders.Coder<T> coderFor(org.apache.beam.sdk.values.TypeDescriptor<T> typeDescriptor,
                                                        java.util.List<? extends org.apache.beam.sdk.coders.Coder<?>> componentCoders)
                                                 throws org.apache.beam.sdk.coders.CannotProvideCoderException

Specified by:

coderFor in class org.apache.beam.sdk.coders.CoderProvider

Throws:

org.apache.beam.sdk.coders.CannotProvideCoderException

withRegistrar

public KryoCoderProvider withRegistrar(KryoRegistrar registrar)

Create a new KryoCoderProvider with the provided registrar.

Parameters:

registrar - registrar to append to the list of already registered registrars.

Returns:

a new KryoCoderProvider

registerTo

public void registerTo(org.apache.beam.sdk.Pipeline pipeline)

Builds KryoCoderProvider and register it to given Pipeline.

Parameters:

pipeline - Pipeline whose coder registry will be used to register KryoCoderProvider under build.