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

Interface RunnerApi.CoderOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RunnerApi.Coder, RunnerApi.Coder.Builder

Enclosing class:

RunnerApi

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

Method Summary

Modifier and Type	Method and Description
String	getComponentCoderIds(int index) (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
com.google.protobuf.ByteString	getComponentCoderIdsBytes(int index) (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
int	getComponentCoderIdsCount() (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
List<String>	getComponentCoderIdsList() (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
RunnerApi.SdkFunctionSpec	getSpec() (Required) A specification for the coder, as a URN plus parameters.
RunnerApi.SdkFunctionSpecOrBuilder	getSpecOrBuilder() (Required) A specification for the coder, as a URN plus parameters.
boolean	hasSpec() (Required) A specification for the coder, as a URN plus parameters.

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

hasSpec

boolean hasSpec()

 (Required) A specification for the coder, as a URN plus parameters. This
 may be a cross-language agreed-upon format, or it may be a "custom coder"
 that can only be used by a particular SDK. It does not include component
 coders, as it is beneficial for these to be comprehensible to a runner
 regardless of whether the binary format is agree-upon.
 

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

getSpec

RunnerApi.SdkFunctionSpec getSpec()

 (Required) A specification for the coder, as a URN plus parameters. This
 may be a cross-language agreed-upon format, or it may be a "custom coder"
 that can only be used by a particular SDK. It does not include component
 coders, as it is beneficial for these to be comprehensible to a runner
 regardless of whether the binary format is agree-upon.
 

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

getSpecOrBuilder

RunnerApi.SdkFunctionSpecOrBuilder getSpecOrBuilder()

 (Required) A specification for the coder, as a URN plus parameters. This
 may be a cross-language agreed-upon format, or it may be a "custom coder"
 that can only be used by a particular SDK. It does not include component
 coders, as it is beneficial for these to be comprehensible to a runner
 regardless of whether the binary format is agree-upon.
 

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

getComponentCoderIdsList

List<String> getComponentCoderIdsList()

 (Optional) If this coder is parametric, such as ListCoder(VarIntCoder),
 this is a list of the components. In order for encodings to be identical,
 the SdkFunctionSpec and all components must be identical, recursively.
 

repeated string component_coder_ids = 2;

getComponentCoderIdsCount

int getComponentCoderIdsCount()

 (Optional) If this coder is parametric, such as ListCoder(VarIntCoder),
 this is a list of the components. In order for encodings to be identical,
 the SdkFunctionSpec and all components must be identical, recursively.
 

repeated string component_coder_ids = 2;

getComponentCoderIds

String getComponentCoderIds(int index)

 (Optional) If this coder is parametric, such as ListCoder(VarIntCoder),
 this is a list of the components. In order for encodings to be identical,
 the SdkFunctionSpec and all components must be identical, recursively.
 

repeated string component_coder_ids = 2;

getComponentCoderIdsBytes

com.google.protobuf.ByteString getComponentCoderIdsBytes(int index)

 (Optional) If this coder is parametric, such as ListCoder(VarIntCoder),
 this is a list of the components. In order for encodings to be identical,
 the SdkFunctionSpec and all components must be identical, recursively.
 

repeated string component_coder_ids = 2;