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

Class RunnerApi.Pipeline.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

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

All Implemented Interfaces:

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

Enclosing class:

RunnerApi.Pipeline

public static final class RunnerApi.Pipeline.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.Pipeline.Builder>
implements RunnerApi.PipelineOrBuilder

 A Pipeline is a hierarchical graph of PTransforms, linked
 by PCollections.
 This is represented by a number of by-reference maps to nodes,
 PCollections, SDK environments, UDF, etc., for
 supporting compact reuse and arbitrary graph structure.
 All of the keys in the maps here are arbitrary strings that are only
 required to be internally consistent within this proto message.
 

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

Method Summary

Modifier and Type	Method and Description
RunnerApi.Pipeline.Builder	addAllRootTransformIds(Iterable<String> values) (Required) The ids of all PTransforms that are not contained within another PTransform.
RunnerApi.Pipeline.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunnerApi.Pipeline.Builder	addRootTransformIds(String value) (Required) The ids of all PTransforms that are not contained within another PTransform.
RunnerApi.Pipeline.Builder	addRootTransformIdsBytes(com.google.protobuf.ByteString value) (Required) The ids of all PTransforms that are not contained within another PTransform.
RunnerApi.Pipeline	build()
RunnerApi.Pipeline	buildPartial()
RunnerApi.Pipeline.Builder	clear()
RunnerApi.Pipeline.Builder	clearComponents() (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.Pipeline.Builder	clearDisplayData() (Optional) Static display data for the pipeline.
RunnerApi.Pipeline.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RunnerApi.Pipeline.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RunnerApi.Pipeline.Builder	clearRootTransformIds() (Required) The ids of all PTransforms that are not contained within another PTransform.
RunnerApi.Pipeline.Builder	clone()
RunnerApi.Components	getComponents() (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.Components.Builder	getComponentsBuilder() (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.ComponentsOrBuilder	getComponentsOrBuilder() (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.Pipeline	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RunnerApi.DisplayData	getDisplayData() (Optional) Static display data for the pipeline.
RunnerApi.DisplayData.Builder	getDisplayDataBuilder() (Optional) Static display data for the pipeline.
RunnerApi.DisplayDataOrBuilder	getDisplayDataOrBuilder() (Optional) Static display data for the pipeline.
String	getRootTransformIds(int index) (Required) The ids of all PTransforms that are not contained within another PTransform.
com.google.protobuf.ByteString	getRootTransformIdsBytes(int index) (Required) The ids of all PTransforms that are not contained within another PTransform.
int	getRootTransformIdsCount() (Required) The ids of all PTransforms that are not contained within another PTransform.
com.google.protobuf.ProtocolStringList	getRootTransformIdsList() (Required) The ids of all PTransforms that are not contained within another PTransform.
boolean	hasComponents() (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
boolean	hasDisplayData() (Optional) Static display data for the pipeline.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RunnerApi.Pipeline.Builder	mergeComponents(RunnerApi.Components value) (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.Pipeline.Builder	mergeDisplayData(RunnerApi.DisplayData value) (Optional) Static display data for the pipeline.
RunnerApi.Pipeline.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RunnerApi.Pipeline.Builder	mergeFrom(com.google.protobuf.Message other)
RunnerApi.Pipeline.Builder	mergeFrom(RunnerApi.Pipeline other)
RunnerApi.Pipeline.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RunnerApi.Pipeline.Builder	setComponents(RunnerApi.Components.Builder builderForValue) (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.Pipeline.Builder	setComponents(RunnerApi.Components value) (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
RunnerApi.Pipeline.Builder	setDisplayData(RunnerApi.DisplayData.Builder builderForValue) (Optional) Static display data for the pipeline.
RunnerApi.Pipeline.Builder	setDisplayData(RunnerApi.DisplayData value) (Optional) Static display data for the pipeline.
RunnerApi.Pipeline.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunnerApi.Pipeline.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RunnerApi.Pipeline.Builder	setRootTransformIds(int index, String value) (Required) The ids of all PTransforms that are not contained within another PTransform.
RunnerApi.Pipeline.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.Pipeline.Builder>

clear

public RunnerApi.Pipeline.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.Pipeline.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.Pipeline.Builder>

getDefaultInstanceForType

public RunnerApi.Pipeline getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RunnerApi.Pipeline build()

Specified by:

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

Specified by:

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

buildPartial

public RunnerApi.Pipeline buildPartial()

Specified by:

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

Specified by:

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

clone

public RunnerApi.Pipeline.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.Pipeline.Builder>

setField

public RunnerApi.Pipeline.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.Pipeline.Builder>

clearField

public RunnerApi.Pipeline.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.Pipeline.Builder>

clearOneof

public RunnerApi.Pipeline.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.Pipeline.Builder>

setRepeatedField

public RunnerApi.Pipeline.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.Pipeline.Builder>

addRepeatedField

public RunnerApi.Pipeline.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.Pipeline.Builder>

mergeFrom

public RunnerApi.Pipeline.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.Pipeline.Builder>

mergeFrom

public RunnerApi.Pipeline.Builder mergeFrom(RunnerApi.Pipeline 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.Pipeline.Builder>

mergeFrom

public RunnerApi.Pipeline.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.Pipeline.Builder>

Throws:

IOException

hasComponents

public boolean hasComponents()

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

Specified by:

hasComponents in interface RunnerApi.PipelineOrBuilder

getComponents

public RunnerApi.Components getComponents()

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

Specified by:

getComponents in interface RunnerApi.PipelineOrBuilder

setComponents

public RunnerApi.Pipeline.Builder setComponents(RunnerApi.Components value)

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

setComponents

public RunnerApi.Pipeline.Builder setComponents(RunnerApi.Components.Builder builderForValue)

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

mergeComponents

public RunnerApi.Pipeline.Builder mergeComponents(RunnerApi.Components value)

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

clearComponents

public RunnerApi.Pipeline.Builder clearComponents()

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

getComponentsBuilder

public RunnerApi.Components.Builder getComponentsBuilder()

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

getComponentsOrBuilder

public RunnerApi.ComponentsOrBuilder getComponentsOrBuilder()

 (Required) The coders, UDFs, graph nodes, etc, that make up
 this pipeline.
 

.org.apache.beam.runner_api.v1.Components components = 1;

Specified by:

getComponentsOrBuilder in interface RunnerApi.PipelineOrBuilder

getRootTransformIdsList

public com.google.protobuf.ProtocolStringList getRootTransformIdsList()

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

Specified by:

getRootTransformIdsList in interface RunnerApi.PipelineOrBuilder

getRootTransformIdsCount

public int getRootTransformIdsCount()

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

Specified by:

getRootTransformIdsCount in interface RunnerApi.PipelineOrBuilder

getRootTransformIds

public String getRootTransformIds(int index)

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

Specified by:

getRootTransformIds in interface RunnerApi.PipelineOrBuilder

getRootTransformIdsBytes

public com.google.protobuf.ByteString getRootTransformIdsBytes(int index)

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

Specified by:

getRootTransformIdsBytes in interface RunnerApi.PipelineOrBuilder

setRootTransformIds

public RunnerApi.Pipeline.Builder setRootTransformIds(int index,
                                                      String value)

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

addRootTransformIds

public RunnerApi.Pipeline.Builder addRootTransformIds(String value)

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

addAllRootTransformIds

public RunnerApi.Pipeline.Builder addAllRootTransformIds(Iterable<String> values)

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

clearRootTransformIds

public RunnerApi.Pipeline.Builder clearRootTransformIds()

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

addRootTransformIdsBytes

public RunnerApi.Pipeline.Builder addRootTransformIdsBytes(com.google.protobuf.ByteString value)

 (Required) The ids of all PTransforms that are not contained within another PTransform.
 These must be in shallow topological order, so that traversing them recursively
 in this order yields a recursively topological traversal.
 

repeated string root_transform_ids = 2;

hasDisplayData

public boolean hasDisplayData()

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

Specified by:

hasDisplayData in interface RunnerApi.PipelineOrBuilder

getDisplayData

public RunnerApi.DisplayData getDisplayData()

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

Specified by:

getDisplayData in interface RunnerApi.PipelineOrBuilder

setDisplayData

public RunnerApi.Pipeline.Builder setDisplayData(RunnerApi.DisplayData value)

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

setDisplayData

public RunnerApi.Pipeline.Builder setDisplayData(RunnerApi.DisplayData.Builder builderForValue)

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

mergeDisplayData

public RunnerApi.Pipeline.Builder mergeDisplayData(RunnerApi.DisplayData value)

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

clearDisplayData

public RunnerApi.Pipeline.Builder clearDisplayData()

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

getDisplayDataBuilder

public RunnerApi.DisplayData.Builder getDisplayDataBuilder()

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

getDisplayDataOrBuilder

public RunnerApi.DisplayDataOrBuilder getDisplayDataOrBuilder()

 (Optional) Static display data for the pipeline. If there is none,
 it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 3;

Specified by:

getDisplayDataOrBuilder in interface RunnerApi.PipelineOrBuilder

setUnknownFields

public final RunnerApi.Pipeline.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.Pipeline.Builder>

mergeUnknownFields

public final RunnerApi.Pipeline.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.Pipeline.Builder>