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

Static Fields

DISPLAY_DATA_FIELD_NUMBER

public static final int DISPLAY_DATA_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTION_PIPELINE_STAGE_FIELD_NUMBER

public static final int EXECUTION_PIPELINE_STAGE_FIELD_NUMBER
Field Value
TypeDescription
int

ORIGINAL_PIPELINE_TRANSFORM_FIELD_NUMBER

public static final int ORIGINAL_PIPELINE_TRANSFORM_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PipelineDescription getDefaultInstance()
Returns
TypeDescription
PipelineDescription

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PipelineDescription.Builder newBuilder()
Returns
TypeDescription
PipelineDescription.Builder

newBuilder(PipelineDescription prototype)

public static PipelineDescription.Builder newBuilder(PipelineDescription prototype)
Parameter
NameDescription
prototypePipelineDescription
Returns
TypeDescription
PipelineDescription.Builder

parseDelimitedFrom(InputStream input)

public static PipelineDescription parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PipelineDescription parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PipelineDescription parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PipelineDescription parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PipelineDescription parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PipelineDescription parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PipelineDescription parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PipelineDescription> parser()
Returns
TypeDescription
Parser<PipelineDescription>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PipelineDescription getDefaultInstanceForType()
Returns
TypeDescription
PipelineDescription

getDisplayData(int index)

public DisplayData getDisplayData(int index)

Pipeline level display data.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DisplayData

getDisplayDataCount()

public int getDisplayDataCount()

Pipeline level display data.

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

Returns
TypeDescription
int

getDisplayDataList()

public List<DisplayData> getDisplayDataList()

Pipeline level display data.

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

Returns
TypeDescription
List<DisplayData>

getDisplayDataOrBuilder(int index)

public DisplayDataOrBuilder getDisplayDataOrBuilder(int index)

Pipeline level display data.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DisplayDataOrBuilder

getDisplayDataOrBuilderList()

public List<? extends DisplayDataOrBuilder> getDisplayDataOrBuilderList()

Pipeline level display data.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
ExecutionStageSummary

getExecutionPipelineStageCount()

public int getExecutionPipelineStageCount()

Description of each stage of execution of the pipeline.

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.dataflow.v1beta3.TransformSummaryOrBuilder>

getParserForType()

public Parser<PipelineDescription> getParserForType()
Returns
TypeDescription
Parser<PipelineDescription>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PipelineDescription.Builder newBuilderForType()
Returns
TypeDescription
PipelineDescription.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PipelineDescription.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PipelineDescription.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PipelineDescription.Builder toBuilder()
Returns
TypeDescription
PipelineDescription.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException