Class PipelineDescription (0.18.0)

public final class PipelineDescription extends GeneratedMessageV3 implements PipelineDescriptionOrBuilder

A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics.

Protobuf type google.dataflow.v1beta3.PipelineDescription

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PipelineDescription

Implements

PipelineDescriptionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DISPLAY_DATA_FIELD_NUMBER

public static final int DISPLAY_DATA_FIELD_NUMBER

Field Value
Type	Description
`int`

EXECUTION_PIPELINE_STAGE_FIELD_NUMBER

public static final int EXECUTION_PIPELINE_STAGE_FIELD_NUMBER

Field Value
Type	Description
`int`

ORIGINAL_PIPELINE_TRANSFORM_FIELD_NUMBER

public static final int ORIGINAL_PIPELINE_TRANSFORM_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static PipelineDescription getDefaultInstance()

Returns
Type	Description
`PipelineDescription`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PipelineDescription.Builder newBuilder()

Returns
Type	Description
`PipelineDescription.Builder`

newBuilder(PipelineDescription prototype)

public static PipelineDescription.Builder newBuilder(PipelineDescription prototype)

Parameter
Name	Description
`prototype`	`PipelineDescription`

Returns
Type	Description
`PipelineDescription.Builder`

parseDelimitedFrom(InputStream input)

public static PipelineDescription parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PipelineDescription parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PipelineDescription parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PipelineDescription parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PipelineDescription parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PipelineDescription parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PipelineDescription`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PipelineDescription> parser()

Returns
Type	Description
`Parser<PipelineDescription>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public PipelineDescription getDefaultInstanceForType()

Returns
Type	Description
`PipelineDescription`

getDisplayData(int index)

public DisplayData getDisplayData(int index)

Pipeline level display data.

repeated .google.dataflow.v1beta3.DisplayData display_data = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DisplayData`

getDisplayDataCount()

public int getDisplayDataCount()

Pipeline level display data.

repeated .google.dataflow.v1beta3.DisplayData display_data = 3;

Returns
Type	Description
`int`

getDisplayDataList()

public List<DisplayData> getDisplayDataList()

Pipeline level display data.

repeated .google.dataflow.v1beta3.DisplayData display_data = 3;

Returns
Type	Description
`List<DisplayData>`

getDisplayDataOrBuilder(int index)

public DisplayDataOrBuilder getDisplayDataOrBuilder(int index)

Pipeline level display data.

repeated .google.dataflow.v1beta3.DisplayData display_data = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`DisplayDataOrBuilder`

getDisplayDataOrBuilderList()

public List<? extends DisplayDataOrBuilder> getDisplayDataOrBuilderList()

Pipeline level display data.

repeated .google.dataflow.v1beta3.DisplayData display_data = 3;

Returns
Type	Description
`List<? extends com.google.dataflow.v1beta3.DisplayDataOrBuilder>`

getExecutionPipelineStage(int index)

public ExecutionStageSummary getExecutionPipelineStage(int index)

Description of each stage of execution of the pipeline.

repeated .google.dataflow.v1beta3.ExecutionStageSummary execution_pipeline_stage = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExecutionStageSummary`

getExecutionPipelineStageCount()

public int getExecutionPipelineStageCount()

Description of each stage of execution of the pipeline.

repeated .google.dataflow.v1beta3.ExecutionStageSummary execution_pipeline_stage = 2;

Returns
Type	Description
`int`

getExecutionPipelineStageList()

public List<ExecutionStageSummary> getExecutionPipelineStageList()

Description of each stage of execution of the pipeline.

repeated .google.dataflow.v1beta3.ExecutionStageSummary execution_pipeline_stage = 2;

Returns
Type	Description
`List<ExecutionStageSummary>`

getExecutionPipelineStageOrBuilder(int index)

public ExecutionStageSummaryOrBuilder getExecutionPipelineStageOrBuilder(int index)

Description of each stage of execution of the pipeline.

repeated .google.dataflow.v1beta3.ExecutionStageSummary execution_pipeline_stage = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExecutionStageSummaryOrBuilder`

getExecutionPipelineStageOrBuilderList()

public List<? extends ExecutionStageSummaryOrBuilder> getExecutionPipelineStageOrBuilderList()

Description of each stage of execution of the pipeline.

repeated .google.dataflow.v1beta3.ExecutionStageSummary execution_pipeline_stage = 2;

Returns
Type	Description
`List<? extends com.google.dataflow.v1beta3.ExecutionStageSummaryOrBuilder>`