org.apache.beam.sdk.options

Class ValueProvider.RuntimeValueProvider<T>

java.lang.Object

org.apache.beam.sdk.options.ValueProvider.RuntimeValueProvider<T>

All Implemented Interfaces:

java.io.Serializable, ValueProvider<T>

Enclosing interface:

ValueProvider<T>

public static class ValueProvider.RuntimeValueProvider<T>
extends java.lang.Object
implements ValueProvider<T>, java.io.Serializable

ValueProvider.RuntimeValueProvider is an implementation of ValueProvider that allows for a value to be provided at execution time rather than at graph construction time.

To enforce this contract, if there is no default, users must only call get() at execution time (after a call to Pipeline.run()), which will provide the value of optionsMap.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.ValueProvider

ValueProvider.Deserializer, ValueProvider.NestedValueProvider<T,X>, ValueProvider.RuntimeValueProvider<T>, ValueProvider.Serializer, ValueProvider.StaticValueProvider<T>

Method Summary

Modifier and Type	Method and Description
T	get() Returns the runtime value wrapped by this ValueProvider in case it is ValueProvider.isAccessible(), otherwise fails.
boolean	isAccessible() Whether the contents of this ValueProvider is currently available via ValueProvider.get().
java.lang.String	propertyName() Returns the property name that corresponds to this provider.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

get

public T get()

Description copied from interface: ValueProvider

Returns the runtime value wrapped by this ValueProvider in case it is ValueProvider.isAccessible(), otherwise fails.

Specified by:

get in interface ValueProvider<T>

isAccessible

public boolean isAccessible()

Description copied from interface: ValueProvider

Whether the contents of this ValueProvider is currently available via ValueProvider.get().

Specified by:

isAccessible in interface ValueProvider<T>

propertyName

public java.lang.String propertyName()

Returns the property name that corresponds to this provider.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object