org.apache.beam.sdk.options

Interface ValueProvider<T>

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ValueProvider.NestedValueProvider, ValueProvider.RuntimeValueProvider, ValueProvider.StaticValueProvider

public interface ValueProvider<T>
extends java.io.Serializable

A ValueProvider abstracts the notion of fetching a value that may or may not be currently available.

This can be used to parameterize transforms that only read values in at runtime, for example.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValueProvider.Deserializer For internal use only; no backwards compatibility guarantees.
static class	ValueProvider.NestedValueProvider<T,X> ValueProvider.NestedValueProvider is an implementation of ValueProvider that allows for wrapping another ValueProvider object.
static class	ValueProvider.RuntimeValueProvider<T> ValueProvider.RuntimeValueProvider is an implementation of ValueProvider that allows for a value to be provided at execution time rather than at graph construction time.
static class	ValueProvider.Serializer For internal use only; no backwards compatibility guarantees.
static class	ValueProvider.StaticValueProvider<T> ValueProvider.StaticValueProvider is an implementation of ValueProvider that allows for a static value to be provided.

Method Summary

Modifier and Type	Method and Description
T	get() Return the value wrapped by this ValueProvider.
boolean	isAccessible() Whether the contents of this ValueProvider is available to routines that run at graph construction time.

Method Detail

get

T get()

Return the value wrapped by this ValueProvider.

isAccessible

boolean isAccessible()

Whether the contents of this ValueProvider is available to routines that run at graph construction time.