Class PipelineDescription (0.56.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

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

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>

getOriginalPipelineTransform(int index)

public TransformSummary getOriginalPipelineTransform(int index)

Description of each transform in the pipeline and collections between them.

repeated .google.dataflow.v1beta3.TransformSummary original_pipeline_transform = 1;

Parameter
Name Description
index int
Returns
Type Description
TransformSummary

getOriginalPipelineTransformCount()

public int getOriginalPipelineTransformCount()

Description of each transform in the pipeline and collections between them.

repeated .google.dataflow.v1beta3.TransformSummary original_pipeline_transform = 1;

Returns
Type Description
int

getOriginalPipelineTransformList()

public List<TransformSummary> getOriginalPipelineTransformList()

Description of each transform in the pipeline and collections between them.

repeated .google.dataflow.v1beta3.TransformSummary original_pipeline_transform = 1;

Returns
Type Description
List<TransformSummary>

getOriginalPipelineTransformOrBuilder(int index)

public TransformSummaryOrBuilder getOriginalPipelineTransformOrBuilder(int index)

Description of each transform in the pipeline and collections between them.

repeated .google.dataflow.v1beta3.TransformSummary original_pipeline_transform = 1;

Parameter
Name Description
index int
Returns
Type Description
TransformSummaryOrBuilder

getOriginalPipelineTransformOrBuilderList()

public List<? extends TransformSummaryOrBuilder> getOriginalPipelineTransformOrBuilderList()

Description of each transform in the pipeline and collections between them.

repeated .google.dataflow.v1beta3.TransformSummary original_pipeline_transform = 1;

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

getParserForType()

public Parser<PipelineDescription> getParserForType()
Returns
Type Description
Parser<PipelineDescription>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PipelineDescription.Builder newBuilderForType()
Returns
Type Description
PipelineDescription.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PipelineDescription.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PipelineDescription.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PipelineDescription.Builder toBuilder()
Returns
Type Description
PipelineDescription.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException