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

Interface RunnerApi.CombinePayloadOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RunnerApi.CombinePayload, RunnerApi.CombinePayload.Builder

Enclosing class:

RunnerApi

public static interface RunnerApi.CombinePayloadOrBuilder
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.
String	getAccumulatorCoderId() (Required) A reference to the Coder to use for accumulators of the CombineFn
com.google.protobuf.ByteString	getAccumulatorCoderIdBytes() (Required) A reference to the Coder to use for accumulators of the CombineFn
RunnerApi.SdkFunctionSpec	getCombineFn() (Required) The SdkFunctionSpec of the CombineFn.
RunnerApi.SdkFunctionSpecOrBuilder	getCombineFnOrBuilder() (Required) The SdkFunctionSpec of the CombineFn.
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	hasCombineFn() (Required) The SdkFunctionSpec of the CombineFn.

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

hasCombineFn

boolean hasCombineFn()

 (Required) The SdkFunctionSpec of the CombineFn.
 

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

getCombineFn

RunnerApi.SdkFunctionSpec getCombineFn()

 (Required) The SdkFunctionSpec of the CombineFn.
 

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

getCombineFnOrBuilder

RunnerApi.SdkFunctionSpecOrBuilder getCombineFnOrBuilder()

 (Required) The SdkFunctionSpec of the CombineFn.
 

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

getAccumulatorCoderId

String getAccumulatorCoderId()

 (Required) A reference to the Coder to use for accumulators of the CombineFn
 

string accumulator_coder_id = 2;

getAccumulatorCoderIdBytes

com.google.protobuf.ByteString getAccumulatorCoderIdBytes()

 (Required) A reference to the Coder to use for accumulators of the CombineFn
 

string accumulator_coder_id = 2;

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 = 3;

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 = 3;

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 = 3;

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 = 3;

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 = 3;

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 = 4;

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 = 4;

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 = 4;

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 = 4;

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 = 4;