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

Class RunnerApi.Coder.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, RunnerApi.CoderOrBuilder

Enclosing class:

RunnerApi.Coder

public static final class RunnerApi.Coder.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>
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

Method Summary

Modifier and Type	Method and Description
RunnerApi.Coder.Builder	addAllComponentCoderIds(Iterable<String> values) (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
RunnerApi.Coder.Builder	addComponentCoderIds(String value) (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
RunnerApi.Coder.Builder	addComponentCoderIdsBytes(com.google.protobuf.ByteString value) (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
RunnerApi.Coder.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunnerApi.Coder	build()
RunnerApi.Coder	buildPartial()
RunnerApi.Coder.Builder	clear()
RunnerApi.Coder.Builder	clearComponentCoderIds() (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
RunnerApi.Coder.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RunnerApi.Coder.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RunnerApi.Coder.Builder	clearSpec() (Required) A specification for the coder, as a URN plus parameters.
RunnerApi.Coder.Builder	clone()
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.
RunnerApi.Coder	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RunnerApi.SdkFunctionSpec	getSpec() (Required) A specification for the coder, as a URN plus parameters.
RunnerApi.SdkFunctionSpec.Builder	getSpecBuilder() (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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RunnerApi.Coder.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RunnerApi.Coder.Builder	mergeFrom(com.google.protobuf.Message other)
RunnerApi.Coder.Builder	mergeFrom(RunnerApi.Coder other)
RunnerApi.Coder.Builder	mergeSpec(RunnerApi.SdkFunctionSpec value) (Required) A specification for the coder, as a URN plus parameters.
RunnerApi.Coder.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RunnerApi.Coder.Builder	setComponentCoderIds(int index, String value) (Optional) If this coder is parametric, such as ListCoder(VarIntCoder), this is a list of the components.
RunnerApi.Coder.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunnerApi.Coder.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RunnerApi.Coder.Builder	setSpec(RunnerApi.SdkFunctionSpec.Builder builderForValue) (Required) A specification for the coder, as a URN plus parameters.
RunnerApi.Coder.Builder	setSpec(RunnerApi.SdkFunctionSpec value) (Required) A specification for the coder, as a URN plus parameters.
RunnerApi.Coder.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<RunnerApi.Coder.Builder>

clear

public RunnerApi.Coder.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

getDefaultInstanceForType

public RunnerApi.Coder getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RunnerApi.Coder build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RunnerApi.Coder buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RunnerApi.Coder.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

setField

public RunnerApi.Coder.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

clearField

public RunnerApi.Coder.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

clearOneof

public RunnerApi.Coder.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

setRepeatedField

public RunnerApi.Coder.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

addRepeatedField

public RunnerApi.Coder.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

mergeFrom

public RunnerApi.Coder.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunnerApi.Coder.Builder>

mergeFrom

public RunnerApi.Coder.Builder mergeFrom(RunnerApi.Coder other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunnerApi.Coder.Builder>

Throws:

IOException

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

setSpec

public RunnerApi.Coder.Builder setSpec(RunnerApi.SdkFunctionSpec value)

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

setSpec

public RunnerApi.Coder.Builder setSpec(RunnerApi.SdkFunctionSpec.Builder builderForValue)

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

mergeSpec

public RunnerApi.Coder.Builder mergeSpec(RunnerApi.SdkFunctionSpec value)

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

clearSpec

public RunnerApi.Coder.Builder clearSpec()

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

getSpecBuilder

public RunnerApi.SdkFunctionSpec.Builder getSpecBuilder()

 (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

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

setComponentCoderIds

public RunnerApi.Coder.Builder setComponentCoderIds(int index,
                                                    String value)

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

addComponentCoderIds

public RunnerApi.Coder.Builder addComponentCoderIds(String value)

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

addAllComponentCoderIds

public RunnerApi.Coder.Builder addAllComponentCoderIds(Iterable<String> values)

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

clearComponentCoderIds

public RunnerApi.Coder.Builder clearComponentCoderIds()

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

addComponentCoderIdsBytes

public RunnerApi.Coder.Builder addComponentCoderIdsBytes(com.google.protobuf.ByteString value)

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

setUnknownFields

public final RunnerApi.Coder.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>

mergeUnknownFields

public final RunnerApi.Coder.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Coder.Builder>