Class PipelineDescription.Builder (0.28.0)

public static final class PipelineDescription.Builder extends GeneratedMessageV3.Builder<PipelineDescription.Builder> 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 Methods

getDescriptor()

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

Methods

addAllDisplayData(Iterable<? extends DisplayData> values)

public PipelineDescription.Builder addAllDisplayData(Iterable<? extends DisplayData> values)

Pipeline level display data.

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

Parameter
NameDescription
valuesIterable<? extends com.google.dataflow.v1beta3.DisplayData>
Returns
TypeDescription
PipelineDescription.Builder

addAllExecutionPipelineStage(Iterable<? extends ExecutionStageSummary> values)

public PipelineDescription.Builder addAllExecutionPipelineStage(Iterable<? extends ExecutionStageSummary> values)

Description of each stage of execution of the pipeline.

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

Parameter
NameDescription
valuesIterable<? extends com.google.dataflow.v1beta3.ExecutionStageSummary>
Returns
TypeDescription
PipelineDescription.Builder

addAllOriginalPipelineTransform(Iterable<? extends TransformSummary> values)

public PipelineDescription.Builder addAllOriginalPipelineTransform(Iterable<? extends TransformSummary> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.dataflow.v1beta3.TransformSummary>
Returns
TypeDescription
PipelineDescription.Builder

addDisplayData(DisplayData value)

public PipelineDescription.Builder addDisplayData(DisplayData value)

Pipeline level display data.

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

Parameter
NameDescription
valueDisplayData
Returns
TypeDescription
PipelineDescription.Builder

addDisplayData(DisplayData.Builder builderForValue)

public PipelineDescription.Builder addDisplayData(DisplayData.Builder builderForValue)

Pipeline level display data.

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

Parameter
NameDescription
builderForValueDisplayData.Builder
Returns
TypeDescription
PipelineDescription.Builder

addDisplayData(int index, DisplayData value)

public PipelineDescription.Builder addDisplayData(int index, DisplayData value)

Pipeline level display data.

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

Parameters
NameDescription
indexint
valueDisplayData
Returns
TypeDescription
PipelineDescription.Builder

addDisplayData(int index, DisplayData.Builder builderForValue)

public PipelineDescription.Builder addDisplayData(int index, DisplayData.Builder builderForValue)

Pipeline level display data.

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

Parameters
NameDescription
indexint
builderForValueDisplayData.Builder
Returns
TypeDescription
PipelineDescription.Builder

addDisplayDataBuilder()

public DisplayData.Builder addDisplayDataBuilder()

Pipeline level display data.

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

Returns
TypeDescription
DisplayData.Builder

addDisplayDataBuilder(int index)

public DisplayData.Builder addDisplayDataBuilder(int index)

Pipeline level display data.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DisplayData.Builder

addExecutionPipelineStage(ExecutionStageSummary value)

public PipelineDescription.Builder addExecutionPipelineStage(ExecutionStageSummary value)

Description of each stage of execution of the pipeline.

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

Parameter
NameDescription
valueExecutionStageSummary
Returns
TypeDescription
PipelineDescription.Builder

addExecutionPipelineStage(ExecutionStageSummary.Builder builderForValue)

public PipelineDescription.Builder addExecutionPipelineStage(ExecutionStageSummary.Builder builderForValue)

Description of each stage of execution of the pipeline.

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

Parameter
NameDescription
builderForValueExecutionStageSummary.Builder
Returns
TypeDescription
PipelineDescription.Builder

addExecutionPipelineStage(int index, ExecutionStageSummary value)

public PipelineDescription.Builder addExecutionPipelineStage(int index, ExecutionStageSummary value)

Description of each stage of execution of the pipeline.

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

Parameters
NameDescription
indexint
valueExecutionStageSummary
Returns
TypeDescription
PipelineDescription.Builder

addExecutionPipelineStage(int index, ExecutionStageSummary.Builder builderForValue)

public PipelineDescription.Builder addExecutionPipelineStage(int index, ExecutionStageSummary.Builder builderForValue)

Description of each stage of execution of the pipeline.

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

Parameters
NameDescription
indexint
builderForValueExecutionStageSummary.Builder
Returns
TypeDescription
PipelineDescription.Builder

addExecutionPipelineStageBuilder()

public ExecutionStageSummary.Builder addExecutionPipelineStageBuilder()

Description of each stage of execution of the pipeline.

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

Returns
TypeDescription
ExecutionStageSummary.Builder

addExecutionPipelineStageBuilder(int index)

public ExecutionStageSummary.Builder addExecutionPipelineStageBuilder(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.Builder

addOriginalPipelineTransform(TransformSummary value)

public PipelineDescription.Builder addOriginalPipelineTransform(TransformSummary value)

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

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

Parameter
NameDescription
valueTransformSummary
Returns
TypeDescription
PipelineDescription.Builder

addOriginalPipelineTransform(TransformSummary.Builder builderForValue)

public PipelineDescription.Builder addOriginalPipelineTransform(TransformSummary.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueTransformSummary.Builder
Returns
TypeDescription
PipelineDescription.Builder

addOriginalPipelineTransform(int index, TransformSummary value)

public PipelineDescription.Builder addOriginalPipelineTransform(int index, TransformSummary value)

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

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

Parameters
NameDescription
indexint
valueTransformSummary
Returns
TypeDescription
PipelineDescription.Builder

addOriginalPipelineTransform(int index, TransformSummary.Builder builderForValue)

public PipelineDescription.Builder addOriginalPipelineTransform(int index, TransformSummary.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueTransformSummary.Builder
Returns
TypeDescription
PipelineDescription.Builder

addOriginalPipelineTransformBuilder()

public TransformSummary.Builder addOriginalPipelineTransformBuilder()

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

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

Returns
TypeDescription
TransformSummary.Builder

addOriginalPipelineTransformBuilder(int index)

public TransformSummary.Builder addOriginalPipelineTransformBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PipelineDescription.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PipelineDescription.Builder
Overrides

build()

public PipelineDescription build()
Returns
TypeDescription
PipelineDescription

buildPartial()

public PipelineDescription buildPartial()
Returns
TypeDescription
PipelineDescription

clear()

public PipelineDescription.Builder clear()
Returns
TypeDescription
PipelineDescription.Builder
Overrides

clearDisplayData()

public PipelineDescription.Builder clearDisplayData()

Pipeline level display data.

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

Returns
TypeDescription
PipelineDescription.Builder

clearExecutionPipelineStage()

public PipelineDescription.Builder clearExecutionPipelineStage()

Description of each stage of execution of the pipeline.

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

Returns
TypeDescription
PipelineDescription.Builder

clearField(Descriptors.FieldDescriptor field)

public PipelineDescription.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PipelineDescription.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PipelineDescription.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PipelineDescription.Builder
Overrides

clearOriginalPipelineTransform()

public PipelineDescription.Builder clearOriginalPipelineTransform()

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

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

Returns
TypeDescription
PipelineDescription.Builder

clone()

public PipelineDescription.Builder clone()
Returns
TypeDescription
PipelineDescription.Builder
Overrides

getDefaultInstanceForType()

public PipelineDescription getDefaultInstanceForType()
Returns
TypeDescription
PipelineDescription

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

getDisplayDataBuilder(int index)

public DisplayData.Builder getDisplayDataBuilder(int index)

Pipeline level display data.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DisplayData.Builder

getDisplayDataBuilderList()

public List<DisplayData.Builder> getDisplayDataBuilderList()

Pipeline level display data.

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

Returns
TypeDescription
List<Builder>

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

getExecutionPipelineStageBuilder(int index)

public ExecutionStageSummary.Builder getExecutionPipelineStageBuilder(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.Builder

getExecutionPipelineStageBuilderList()

public List<ExecutionStageSummary.Builder> getExecutionPipelineStageBuilderList()

Description of each stage of execution of the pipeline.

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

Returns
TypeDescription
List<Builder>

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

getOriginalPipelineTransformBuilder(int index)

public TransformSummary.Builder getOriginalPipelineTransformBuilder(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.Builder

getOriginalPipelineTransformBuilderList()

public List<TransformSummary.Builder> getOriginalPipelineTransformBuilderList()

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

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

Returns
TypeDescription
List<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PipelineDescription other)

public PipelineDescription.Builder mergeFrom(PipelineDescription other)
Parameter
NameDescription
otherPipelineDescription
Returns
TypeDescription
PipelineDescription.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PipelineDescription.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineDescription.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PipelineDescription.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PipelineDescription.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PipelineDescription.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PipelineDescription.Builder
Overrides

removeDisplayData(int index)

public PipelineDescription.Builder removeDisplayData(int index)

Pipeline level display data.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PipelineDescription.Builder

removeExecutionPipelineStage(int index)

public PipelineDescription.Builder removeExecutionPipelineStage(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
PipelineDescription.Builder

removeOriginalPipelineTransform(int index)

public PipelineDescription.Builder removeOriginalPipelineTransform(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
PipelineDescription.Builder

setDisplayData(int index, DisplayData value)

public PipelineDescription.Builder setDisplayData(int index, DisplayData value)

Pipeline level display data.

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

Parameters
NameDescription
indexint
valueDisplayData
Returns
TypeDescription
PipelineDescription.Builder

setDisplayData(int index, DisplayData.Builder builderForValue)

public PipelineDescription.Builder setDisplayData(int index, DisplayData.Builder builderForValue)

Pipeline level display data.

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

Parameters
NameDescription
indexint
builderForValueDisplayData.Builder
Returns
TypeDescription
PipelineDescription.Builder

setExecutionPipelineStage(int index, ExecutionStageSummary value)

public PipelineDescription.Builder setExecutionPipelineStage(int index, ExecutionStageSummary value)

Description of each stage of execution of the pipeline.

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

Parameters
NameDescription
indexint
valueExecutionStageSummary
Returns
TypeDescription
PipelineDescription.Builder

setExecutionPipelineStage(int index, ExecutionStageSummary.Builder builderForValue)

public PipelineDescription.Builder setExecutionPipelineStage(int index, ExecutionStageSummary.Builder builderForValue)

Description of each stage of execution of the pipeline.

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

Parameters
NameDescription
indexint
builderForValueExecutionStageSummary.Builder
Returns
TypeDescription
PipelineDescription.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PipelineDescription.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PipelineDescription.Builder
Overrides

setOriginalPipelineTransform(int index, TransformSummary value)

public PipelineDescription.Builder setOriginalPipelineTransform(int index, TransformSummary value)

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

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

Parameters
NameDescription
indexint
valueTransformSummary
Returns
TypeDescription
PipelineDescription.Builder

setOriginalPipelineTransform(int index, TransformSummary.Builder builderForValue)

public PipelineDescription.Builder setOriginalPipelineTransform(int index, TransformSummary.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueTransformSummary.Builder
Returns
TypeDescription
PipelineDescription.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PipelineDescription.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PipelineDescription.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PipelineDescription.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PipelineDescription.Builder
Overrides