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

Class RunnerApi.Pipeline

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

RunnerApi

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.Pipeline.Builder A Pipeline is a hierarchical graph of PTransforms, linked by PCollections.

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	COMPONENTS_FIELD_NUMBER
static int	DISPLAY_DATA_FIELD_NUMBER
static int	ROOT_TRANSFORM_IDS_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)
RunnerApi.Components	getComponents() (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.
static RunnerApi.Pipeline	getDefaultInstance()
RunnerApi.Pipeline	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RunnerApi.DisplayData	getDisplayData() (Optional) Static display data for the pipeline.
RunnerApi.DisplayDataOrBuilder	getDisplayDataOrBuilder() (Optional) Static display data for the pipeline.
com.google.protobuf.Parser<RunnerApi.Pipeline>	getParserForType()
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
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasComponents() (Required) The coders, UDFs, graph nodes, etc, that make up this pipeline.
boolean	hasDisplayData() (Optional) Static display data for the pipeline.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunnerApi.Pipeline.Builder	newBuilder()
static RunnerApi.Pipeline.Builder	newBuilder(RunnerApi.Pipeline prototype)
RunnerApi.Pipeline.Builder	newBuilderForType()
protected RunnerApi.Pipeline.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.Pipeline	parseDelimitedFrom(InputStream input)
static RunnerApi.Pipeline	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Pipeline	parseFrom(byte[] data)
static RunnerApi.Pipeline	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Pipeline	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.Pipeline	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Pipeline	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.Pipeline	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.Pipeline	parseFrom(InputStream input)
static RunnerApi.Pipeline	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.Pipeline>	parser()
RunnerApi.Pipeline.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

COMPONENTS_FIELD_NUMBER

public static final int COMPONENTS_FIELD_NUMBER

See Also:

Constant Field Values

ROOT_TRANSFORM_IDS_FIELD_NUMBER

public static final int ROOT_TRANSFORM_IDS_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_DATA_FIELD_NUMBER

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

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

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
 

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
 

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
 

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
 

repeated string root_transform_ids = 2;

Specified by:

getRootTransformIdsBytes in interface RunnerApi.PipelineOrBuilder

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

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

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunnerApi.Pipeline.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.Pipeline.Builder newBuilder()

newBuilder

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

toBuilder

public RunnerApi.Pipeline.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.Pipeline getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder