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

Class RunnerApi.Coder

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

RunnerApi

public static final class RunnerApi.Coder
extends com.google.protobuf.GeneratedMessageV3
implements RunnerApi.CoderOrBuilder

 A coder, the binary format for serialization and deserialization of data in
 a pipeline.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.Coder.Builder A coder, the binary format for serialization and deserialization of data in a pipeline.

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	COMPONENT_CODER_IDS_FIELD_NUMBER
static int	SPEC_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)
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.
com.google.protobuf.ProtocolStringList	getComponentCoderIdsList() (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
static RunnerApi.Coder	getDefaultInstance()
RunnerApi.Coder	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<RunnerApi.Coder>	getParserForType()
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasSpec() (Required) A specification for the coder, as a URN plus parameters.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunnerApi.Coder.Builder	newBuilder()
static RunnerApi.Coder.Builder	newBuilder(RunnerApi.Coder prototype)
RunnerApi.Coder.Builder	newBuilderForType()
protected RunnerApi.Coder.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.Coder	parseDelimitedFrom(InputStream input)
static RunnerApi.Coder	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Coder	parseFrom(byte[] data)
static RunnerApi.Coder	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Coder	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.Coder	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Coder	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.Coder	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Coder	parseFrom(InputStream input)
static RunnerApi.Coder	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.Coder>	parser()
RunnerApi.Coder.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

SPEC_FIELD_NUMBER

public static final int SPEC_FIELD_NUMBER

See Also:

Constant Field Values

COMPONENT_CODER_IDS_FIELD_NUMBER

public static final int COMPONENT_CODER_IDS_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

hasSpec

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

Specified by:

hasSpec in interface RunnerApi.CoderOrBuilder

getSpec

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

Specified by:

getSpec in interface RunnerApi.CoderOrBuilder

getSpecOrBuilder

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

Specified by:

getSpecOrBuilder in interface RunnerApi.CoderOrBuilder

getComponentCoderIdsList

public com.google.protobuf.ProtocolStringList 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;

Specified by:

getComponentCoderIdsList in interface RunnerApi.CoderOrBuilder

getComponentCoderIdsCount

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

Specified by:

getComponentCoderIdsCount in interface RunnerApi.CoderOrBuilder

getComponentCoderIds

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

Specified by:

getComponentCoderIds in interface RunnerApi.CoderOrBuilder

getComponentCoderIdsBytes

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

Specified by:

getComponentCoderIdsBytes in interface RunnerApi.CoderOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunnerApi.Coder.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.Coder.Builder newBuilder()

newBuilder

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

toBuilder

public RunnerApi.Coder.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.Coder getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder