org.apache.beam.sdk.common.runner.v1

Interface RunnerApi.ParDoPayloadOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RunnerApi.ParDoPayload, RunnerApi.ParDoPayload.Builder

Enclosing class:

RunnerApi

public static interface RunnerApi.ParDoPayloadOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsSideInputs(String key) (Optional) A mapping of local input names to side inputs, describing the expected access pattern.
boolean	containsStateSpecs(String key) (Optional) A mapping of local state names to state specifications.
boolean	containsTimerSpecs(String key) (Optional) A mapping of local timer names to timer specifications.
RunnerApi.SdkFunctionSpec	getDoFn() (Required) The SdkFunctionSpec of the DoFn.
RunnerApi.SdkFunctionSpecOrBuilder	getDoFnOrBuilder() (Required) The SdkFunctionSpec of the DoFn.
RunnerApi.Parameter	getParameters(int index) (Required) Additional pieces of context the DoFn may require that are not otherwise represented in the payload.
int	getParametersCount() (Required) Additional pieces of context the DoFn may require that are not otherwise represented in the payload.
List<RunnerApi.Parameter>	getParametersList() (Required) Additional pieces of context the DoFn may require that are not otherwise represented in the payload.
RunnerApi.ParameterOrBuilder	getParametersOrBuilder(int index) (Required) Additional pieces of context the DoFn may require that are not otherwise represented in the payload.
List<? extends RunnerApi.ParameterOrBuilder>	getParametersOrBuilderList() (Required) Additional pieces of context the DoFn may require that are not otherwise represented in the payload.
Map<String,RunnerApi.SideInput>	getSideInputs() Deprecated.
int	getSideInputsCount() (Optional) A mapping of local input names to side inputs, describing the expected access pattern.
Map<String,RunnerApi.SideInput>	getSideInputsMap() (Optional) A mapping of local input names to side inputs, describing the expected access pattern.
RunnerApi.SideInput	getSideInputsOrDefault(String key, RunnerApi.SideInput defaultValue) (Optional) A mapping of local input names to side inputs, describing the expected access pattern.
RunnerApi.SideInput	getSideInputsOrThrow(String key) (Optional) A mapping of local input names to side inputs, describing the expected access pattern.
boolean	getSplittable() Whether the DoFn is splittable
Map<String,RunnerApi.StateSpec>	getStateSpecs() Deprecated.
int	getStateSpecsCount() (Optional) A mapping of local state names to state specifications.
Map<String,RunnerApi.StateSpec>	getStateSpecsMap() (Optional) A mapping of local state names to state specifications.
RunnerApi.StateSpec	getStateSpecsOrDefault(String key, RunnerApi.StateSpec defaultValue) (Optional) A mapping of local state names to state specifications.
RunnerApi.StateSpec	getStateSpecsOrThrow(String key) (Optional) A mapping of local state names to state specifications.
Map<String,RunnerApi.TimerSpec>	getTimerSpecs() Deprecated.
int	getTimerSpecsCount() (Optional) A mapping of local timer names to timer specifications.
Map<String,RunnerApi.TimerSpec>	getTimerSpecsMap() (Optional) A mapping of local timer names to timer specifications.
RunnerApi.TimerSpec	getTimerSpecsOrDefault(String key, RunnerApi.TimerSpec defaultValue) (Optional) A mapping of local timer names to timer specifications.
RunnerApi.TimerSpec	getTimerSpecsOrThrow(String key) (Optional) A mapping of local timer names to timer specifications.
boolean	hasDoFn() (Required) The SdkFunctionSpec of the DoFn.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasDoFn

boolean hasDoFn()

 (Required) The SdkFunctionSpec of the DoFn.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec do_fn = 1;

getDoFn

RunnerApi.SdkFunctionSpec getDoFn()

 (Required) The SdkFunctionSpec of the DoFn.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec do_fn = 1;

getDoFnOrBuilder

RunnerApi.SdkFunctionSpecOrBuilder getDoFnOrBuilder()

 (Required) The SdkFunctionSpec of the DoFn.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec do_fn = 1;

getParametersList

List<RunnerApi.Parameter> getParametersList()

 (Required) Additional pieces of context the DoFn may require that
 are not otherwise represented in the payload.
 (may force runners to execute the ParDo differently)
 

repeated .org.apache.beam.runner_api.v1.Parameter parameters = 2;

getParameters

RunnerApi.Parameter getParameters(int index)

 (Required) Additional pieces of context the DoFn may require that
 are not otherwise represented in the payload.
 (may force runners to execute the ParDo differently)
 

repeated .org.apache.beam.runner_api.v1.Parameter parameters = 2;

getParametersCount

int getParametersCount()

 (Required) Additional pieces of context the DoFn may require that
 are not otherwise represented in the payload.
 (may force runners to execute the ParDo differently)
 

repeated .org.apache.beam.runner_api.v1.Parameter parameters = 2;

getParametersOrBuilderList

List<? extends RunnerApi.ParameterOrBuilder> getParametersOrBuilderList()

 (Required) Additional pieces of context the DoFn may require that
 are not otherwise represented in the payload.
 (may force runners to execute the ParDo differently)
 

repeated .org.apache.beam.runner_api.v1.Parameter parameters = 2;

getParametersOrBuilder

RunnerApi.ParameterOrBuilder getParametersOrBuilder(int index)

 (Required) Additional pieces of context the DoFn may require that
 are not otherwise represented in the payload.
 (may force runners to execute the ParDo differently)
 

repeated .org.apache.beam.runner_api.v1.Parameter parameters = 2;

getSideInputsCount

int getSideInputsCount()

 (Optional) A mapping of local input names to side inputs, describing
 the expected access pattern.
 

map<string, .org.apache.beam.runner_api.v1.SideInput> side_inputs = 3;

containsSideInputs

boolean containsSideInputs(String key)

 (Optional) A mapping of local input names to side inputs, describing
 the expected access pattern.
 

map<string, .org.apache.beam.runner_api.v1.SideInput> side_inputs = 3;

getSideInputs

@Deprecated
Map<String,RunnerApi.SideInput> getSideInputs()

Deprecated.

Use getSideInputsMap() instead.

getSideInputsMap

Map<String,RunnerApi.SideInput> getSideInputsMap()

 (Optional) A mapping of local input names to side inputs, describing
 the expected access pattern.
 

map<string, .org.apache.beam.runner_api.v1.SideInput> side_inputs = 3;

getSideInputsOrDefault

RunnerApi.SideInput getSideInputsOrDefault(String key,
                                           RunnerApi.SideInput defaultValue)

 (Optional) A mapping of local input names to side inputs, describing
 the expected access pattern.
 

map<string, .org.apache.beam.runner_api.v1.SideInput> side_inputs = 3;

getSideInputsOrThrow

RunnerApi.SideInput getSideInputsOrThrow(String key)

 (Optional) A mapping of local input names to side inputs, describing
 the expected access pattern.
 

map<string, .org.apache.beam.runner_api.v1.SideInput> side_inputs = 3;

getStateSpecsCount

int getStateSpecsCount()

 (Optional) A mapping of local state names to state specifications.
 

map<string, .org.apache.beam.runner_api.v1.StateSpec> state_specs = 4;

containsStateSpecs

boolean containsStateSpecs(String key)

 (Optional) A mapping of local state names to state specifications.
 

map<string, .org.apache.beam.runner_api.v1.StateSpec> state_specs = 4;

getStateSpecs

@Deprecated
Map<String,RunnerApi.StateSpec> getStateSpecs()

Deprecated.

Use getStateSpecsMap() instead.

getStateSpecsMap

Map<String,RunnerApi.StateSpec> getStateSpecsMap()

 (Optional) A mapping of local state names to state specifications.
 

map<string, .org.apache.beam.runner_api.v1.StateSpec> state_specs = 4;

getStateSpecsOrDefault

RunnerApi.StateSpec getStateSpecsOrDefault(String key,
                                           RunnerApi.StateSpec defaultValue)

 (Optional) A mapping of local state names to state specifications.
 

map<string, .org.apache.beam.runner_api.v1.StateSpec> state_specs = 4;

getStateSpecsOrThrow

RunnerApi.StateSpec getStateSpecsOrThrow(String key)

 (Optional) A mapping of local state names to state specifications.
 

map<string, .org.apache.beam.runner_api.v1.StateSpec> state_specs = 4;

getTimerSpecsCount

int getTimerSpecsCount()

 (Optional) A mapping of local timer names to timer specifications.
 

map<string, .org.apache.beam.runner_api.v1.TimerSpec> timer_specs = 5;

containsTimerSpecs

boolean containsTimerSpecs(String key)

 (Optional) A mapping of local timer names to timer specifications.
 

map<string, .org.apache.beam.runner_api.v1.TimerSpec> timer_specs = 5;

getTimerSpecs

@Deprecated
Map<String,RunnerApi.TimerSpec> getTimerSpecs()

Deprecated.

Use getTimerSpecsMap() instead.

getTimerSpecsMap

Map<String,RunnerApi.TimerSpec> getTimerSpecsMap()

 (Optional) A mapping of local timer names to timer specifications.
 

map<string, .org.apache.beam.runner_api.v1.TimerSpec> timer_specs = 5;

getTimerSpecsOrDefault

RunnerApi.TimerSpec getTimerSpecsOrDefault(String key,
                                           RunnerApi.TimerSpec defaultValue)

 (Optional) A mapping of local timer names to timer specifications.
 

map<string, .org.apache.beam.runner_api.v1.TimerSpec> timer_specs = 5;

getTimerSpecsOrThrow

RunnerApi.TimerSpec getTimerSpecsOrThrow(String key)

 (Optional) A mapping of local timer names to timer specifications.
 

map<string, .org.apache.beam.runner_api.v1.TimerSpec> timer_specs = 5;

getSplittable

boolean getSplittable()

 Whether the DoFn is splittable
 

bool splittable = 6;