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

Interface RunnerApi.SideInputOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RunnerApi.SideInput, RunnerApi.SideInput.Builder

Enclosing class:

RunnerApi

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

Method Summary

Modifier and Type	Method and Description
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.
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.
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.

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

hasAccessPattern

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;

getAccessPattern

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;

getAccessPatternOrBuilder

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;

hasViewFn

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;

getViewFn

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;

getViewFnOrBuilder

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;

hasWindowMappingFn

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;

getWindowMappingFn

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;

getWindowMappingFnOrBuilder

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;