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

Class RunnerApi.CombinePayload

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, RunnerApi.CombinePayloadOrBuilder

Enclosing class:

RunnerApi

public static final class RunnerApi.CombinePayload
extends com.google.protobuf.GeneratedMessageV3
implements RunnerApi.CombinePayloadOrBuilder

 The payload for the special-but-not-primitive Combine transform.
 

Protobuf type org.apache.beam.runner_api.v1.CombinePayload

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.CombinePayload.Builder The payload for the special-but-not-primitive Combine transform.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCUMULATOR_CODER_ID_FIELD_NUMBER
static int	COMBINE_FN_FIELD_NUMBER
static int	PARAMETERS_FIELD_NUMBER
static int	SIDE_INPUTS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

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	equals(Object obj)
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.
static RunnerApi.CombinePayload	getDefaultInstance()
RunnerApi.CombinePayload	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<RunnerApi.CombinePayload>	getParserForType()
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCombineFn() (Required) The SdkFunctionSpec of the CombineFn.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static RunnerApi.CombinePayload.Builder	newBuilder()
static RunnerApi.CombinePayload.Builder	newBuilder(RunnerApi.CombinePayload prototype)
RunnerApi.CombinePayload.Builder	newBuilderForType()
protected RunnerApi.CombinePayload.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.CombinePayload	parseDelimitedFrom(InputStream input)
static RunnerApi.CombinePayload	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.CombinePayload	parseFrom(byte[] data)
static RunnerApi.CombinePayload	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.CombinePayload	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.CombinePayload	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.CombinePayload	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.CombinePayload	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.CombinePayload	parseFrom(InputStream input)
static RunnerApi.CombinePayload	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.CombinePayload>	parser()
RunnerApi.CombinePayload.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

COMBINE_FN_FIELD_NUMBER

public static final int COMBINE_FN_FIELD_NUMBER

See Also:

Constant Field Values

ACCUMULATOR_CODER_ID_FIELD_NUMBER

public static final int ACCUMULATOR_CODER_ID_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER

See Also:

Constant Field Values

SIDE_INPUTS_FIELD_NUMBER

public static final int SIDE_INPUTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasCombineFn

public boolean hasCombineFn()

 (Required) The SdkFunctionSpec of the CombineFn.
 

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

Specified by:

hasCombineFn in interface RunnerApi.CombinePayloadOrBuilder

getCombineFn

public RunnerApi.SdkFunctionSpec getCombineFn()

 (Required) The SdkFunctionSpec of the CombineFn.
 

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

Specified by:

getCombineFn in interface RunnerApi.CombinePayloadOrBuilder

getCombineFnOrBuilder

public RunnerApi.SdkFunctionSpecOrBuilder getCombineFnOrBuilder()

 (Required) The SdkFunctionSpec of the CombineFn.
 

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

Specified by:

getCombineFnOrBuilder in interface RunnerApi.CombinePayloadOrBuilder

getAccumulatorCoderId

public String getAccumulatorCoderId()

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

string accumulator_coder_id = 2;

Specified by:

getAccumulatorCoderId in interface RunnerApi.CombinePayloadOrBuilder

getAccumulatorCoderIdBytes

public com.google.protobuf.ByteString getAccumulatorCoderIdBytes()

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

string accumulator_coder_id = 2;

Specified by:

getAccumulatorCoderIdBytes in interface RunnerApi.CombinePayloadOrBuilder

getParametersList

public 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;

Specified by:

getParametersList in interface RunnerApi.CombinePayloadOrBuilder

getParametersOrBuilderList

public 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;

Specified by:

getParametersOrBuilderList in interface RunnerApi.CombinePayloadOrBuilder

getParametersCount

public 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;

Specified by:

getParametersCount in interface RunnerApi.CombinePayloadOrBuilder

getParameters

public 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;

Specified by:

getParameters in interface RunnerApi.CombinePayloadOrBuilder

getParametersOrBuilder

public 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;

Specified by:

getParametersOrBuilder in interface RunnerApi.CombinePayloadOrBuilder

getSideInputsCount

public int getSideInputsCount()

Description copied from interface: RunnerApi.CombinePayloadOrBuilder

 (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;

Specified by:

getSideInputsCount in interface RunnerApi.CombinePayloadOrBuilder

containsSideInputs

public 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;

Specified by:

containsSideInputs in interface RunnerApi.CombinePayloadOrBuilder

getSideInputs

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

Deprecated.

Use getSideInputsMap() instead.

Specified by:

getSideInputs in interface RunnerApi.CombinePayloadOrBuilder

getSideInputsMap

public 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;

Specified by:

getSideInputsMap in interface RunnerApi.CombinePayloadOrBuilder

getSideInputsOrDefault

public 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;

Specified by:

getSideInputsOrDefault in interface RunnerApi.CombinePayloadOrBuilder

getSideInputsOrThrow

public 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;

Specified by:

getSideInputsOrThrow in interface RunnerApi.CombinePayloadOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RunnerApi.CombinePayload parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.CombinePayload parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.CombinePayload parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.CombinePayload parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.CombinePayload parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static RunnerApi.CombinePayload parseFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunnerApi.CombinePayload parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunnerApi.CombinePayload parseDelimitedFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseFrom

public static RunnerApi.CombinePayload parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static RunnerApi.CombinePayload parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

newBuilderForType

public RunnerApi.CombinePayload.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.CombinePayload.Builder newBuilder()

newBuilder

public static RunnerApi.CombinePayload.Builder newBuilder(RunnerApi.CombinePayload prototype)

toBuilder

public RunnerApi.CombinePayload.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RunnerApi.CombinePayload.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.CombinePayload getDefaultInstance()

parser

public static com.google.protobuf.Parser<RunnerApi.CombinePayload> parser()

getParserForType

public com.google.protobuf.Parser<RunnerApi.CombinePayload> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RunnerApi.CombinePayload getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder