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

Class RunnerApi.SideInput

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

RunnerApi

public static final class RunnerApi.SideInput
extends com.google.protobuf.GeneratedMessageV3
implements RunnerApi.SideInputOrBuilder

 A specification for how to "side input" a PCollection.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.SideInput.Builder A specification for how to "side input" a PCollection.

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	ACCESS_PATTERN_FIELD_NUMBER
static int	VIEW_FN_FIELD_NUMBER
static int	WINDOW_MAPPING_FN_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	equals(Object obj)
RunnerApi.FunctionSpec	getAccessPattern() (Required) URN of the access pattern required by the `view_fn` to present the desired SDK-specific interface to a UDF.
RunnerApi.FunctionSpecOrBuilder	getAccessPatternOrBuilder() (Required) URN of the access pattern required by the `view_fn` to present the desired SDK-specific interface to a UDF.
static RunnerApi.SideInput	getDefaultInstance()
RunnerApi.SideInput	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<RunnerApi.SideInput>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
RunnerApi.SdkFunctionSpec	getViewFn() (Required) The SdkFunctionSpec of the UDF that adapts a particular access_pattern to a user-facing view type.
RunnerApi.SdkFunctionSpecOrBuilder	getViewFnOrBuilder() (Required) The SdkFunctionSpec of the UDF that adapts a particular access_pattern to a user-facing view type.
RunnerApi.SdkFunctionSpec	getWindowMappingFn() (Required) The SdkFunctionSpec of the UDF that maps a main input window to a side input window.
RunnerApi.SdkFunctionSpecOrBuilder	getWindowMappingFnOrBuilder() (Required) The SdkFunctionSpec of the UDF that maps a main input window to a side input window.
boolean	hasAccessPattern() (Required) URN of the access pattern required by the `view_fn` to present the desired SDK-specific interface to a UDF.
int	hashCode()
boolean	hasViewFn() (Required) The SdkFunctionSpec of the UDF that adapts a particular access_pattern to a user-facing view type.
boolean	hasWindowMappingFn() (Required) The SdkFunctionSpec of the UDF that maps a main input window to a side input window.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunnerApi.SideInput.Builder	newBuilder()
static RunnerApi.SideInput.Builder	newBuilder(RunnerApi.SideInput prototype)
RunnerApi.SideInput.Builder	newBuilderForType()
protected RunnerApi.SideInput.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.SideInput	parseDelimitedFrom(InputStream input)
static RunnerApi.SideInput	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.SideInput	parseFrom(byte[] data)
static RunnerApi.SideInput	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.SideInput	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.SideInput	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.SideInput	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.SideInput	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.SideInput	parseFrom(InputStream input)
static RunnerApi.SideInput	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.SideInput>	parser()
RunnerApi.SideInput.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, internalGetMapField, 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

ACCESS_PATTERN_FIELD_NUMBER

public static final int ACCESS_PATTERN_FIELD_NUMBER

See Also:

Constant Field Values

VIEW_FN_FIELD_NUMBER

public static final int VIEW_FN_FIELD_NUMBER

See Also:

Constant Field Values

WINDOW_MAPPING_FN_FIELD_NUMBER

public static final int WINDOW_MAPPING_FN_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()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasAccessPattern

public boolean hasAccessPattern()

 (Required) URN of the access pattern required by the `view_fn` to present
 the desired SDK-specific interface to a UDF.
 This access pattern defines the SDK harness <-> Runner Harness RPC
 interface for accessing a side input.
 The only access pattern intended for Beam, because of its superior
 performance possibilities, is "urn:beam:sideinput:multimap" (or some such
 URN)
 

.org.apache.beam.runner_api.v1.FunctionSpec access_pattern = 1;

Specified by:

hasAccessPattern in interface RunnerApi.SideInputOrBuilder

getAccessPattern

public RunnerApi.FunctionSpec getAccessPattern()

 (Required) URN of the access pattern required by the `view_fn` to present
 the desired SDK-specific interface to a UDF.
 This access pattern defines the SDK harness <-> Runner Harness RPC
 interface for accessing a side input.
 The only access pattern intended for Beam, because of its superior
 performance possibilities, is "urn:beam:sideinput:multimap" (or some such
 URN)
 

.org.apache.beam.runner_api.v1.FunctionSpec access_pattern = 1;

Specified by:

getAccessPattern in interface RunnerApi.SideInputOrBuilder

getAccessPatternOrBuilder

public RunnerApi.FunctionSpecOrBuilder getAccessPatternOrBuilder()

 (Required) URN of the access pattern required by the `view_fn` to present
 the desired SDK-specific interface to a UDF.
 This access pattern defines the SDK harness <-> Runner Harness RPC
 interface for accessing a side input.
 The only access pattern intended for Beam, because of its superior
 performance possibilities, is "urn:beam:sideinput:multimap" (or some such
 URN)
 

.org.apache.beam.runner_api.v1.FunctionSpec access_pattern = 1;

Specified by:

getAccessPatternOrBuilder in interface RunnerApi.SideInputOrBuilder

hasViewFn

public boolean hasViewFn()

 (Required) The SdkFunctionSpec of the UDF that adapts a particular
 access_pattern to a user-facing view type.
 For example, View.asSingleton() may include a `view_fn` that adapts a
 specially-designed multimap to a single value per window.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec view_fn = 2;

Specified by:

hasViewFn in interface RunnerApi.SideInputOrBuilder

getViewFn

public RunnerApi.SdkFunctionSpec getViewFn()

 (Required) The SdkFunctionSpec of the UDF that adapts a particular
 access_pattern to a user-facing view type.
 For example, View.asSingleton() may include a `view_fn` that adapts a
 specially-designed multimap to a single value per window.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec view_fn = 2;

Specified by:

getViewFn in interface RunnerApi.SideInputOrBuilder

getViewFnOrBuilder

public RunnerApi.SdkFunctionSpecOrBuilder getViewFnOrBuilder()

 (Required) The SdkFunctionSpec of the UDF that adapts a particular
 access_pattern to a user-facing view type.
 For example, View.asSingleton() may include a `view_fn` that adapts a
 specially-designed multimap to a single value per window.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec view_fn = 2;

Specified by:

getViewFnOrBuilder in interface RunnerApi.SideInputOrBuilder

hasWindowMappingFn

public boolean hasWindowMappingFn()

 (Required) The SdkFunctionSpec of the UDF that maps a main input window
 to a side input window.
 For example, when the main input is in fixed windows of one hour, this
 can specify that the side input should be accessed according to the day
 in which that hour falls.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec window_mapping_fn = 3;

Specified by:

hasWindowMappingFn in interface RunnerApi.SideInputOrBuilder

getWindowMappingFn

public RunnerApi.SdkFunctionSpec getWindowMappingFn()

 (Required) The SdkFunctionSpec of the UDF that maps a main input window
 to a side input window.
 For example, when the main input is in fixed windows of one hour, this
 can specify that the side input should be accessed according to the day
 in which that hour falls.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec window_mapping_fn = 3;

Specified by:

getWindowMappingFn in interface RunnerApi.SideInputOrBuilder

getWindowMappingFnOrBuilder

public RunnerApi.SdkFunctionSpecOrBuilder getWindowMappingFnOrBuilder()

 (Required) The SdkFunctionSpec of the UDF that maps a main input window
 to a side input window.
 For example, when the main input is in fixed windows of one hour, this
 can specify that the side input should be accessed according to the day
 in which that hour falls.
 

.org.apache.beam.runner_api.v1.SdkFunctionSpec window_mapping_fn = 3;

Specified by:

getWindowMappingFnOrBuilder in interface RunnerApi.SideInputOrBuilder

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.SideInput parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.SideInput 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.SideInput parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunnerApi.SideInput.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.SideInput.Builder newBuilder()

newBuilder

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

toBuilder

public RunnerApi.SideInput.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.SideInput getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<RunnerApi.SideInput> 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.SideInput getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder