dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::PipelineDescription Class Reference
Dataflow API Data Objects

#include <pipeline_description.h>

Inheritance diagram for google_dataflow_api::PipelineDescription:

Public Member Functions

 PipelineDescription (const Json::Value &storage)
 
 PipelineDescription (Json::Value *storage)
 
virtual ~PipelineDescription ()
 
const StringPiece GetTypeName () const
 
bool has_display_data () const
 
void clear_display_data ()
 
const client::JsonCppArray< DisplayData > get_display_data () const
 
client::JsonCppArray< DisplayData > mutable_displayData ()
 
bool has_execution_pipeline_stage () const
 
void clear_execution_pipeline_stage ()
 
const client::JsonCppArray< ExecutionStageSummary > get_execution_pipeline_stage () const
 
client::JsonCppArray< ExecutionStageSummary > mutable_executionPipelineStage ()
 
bool has_original_pipeline_transform () const
 
void clear_original_pipeline_transform ()
 
const client::JsonCppArray< TransformSummary > get_original_pipeline_transform () const
 
client::JsonCppArray< TransformSummary > mutable_originalPipelineTransform ()
 

Static Public Member Functions

static PipelineDescription * New ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ PipelineDescription() [1/2]

google_dataflow_api::PipelineDescription::PipelineDescription ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ PipelineDescription() [2/2]

google_dataflow_api::PipelineDescription::PipelineDescription ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~PipelineDescription()

google_dataflow_api::PipelineDescription::~PipelineDescription ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_display_data()

void google_dataflow_api::PipelineDescription::clear_display_data ( )
inline

Clears the 'displayData' attribute.

◆ clear_execution_pipeline_stage()

void google_dataflow_api::PipelineDescription::clear_execution_pipeline_stage ( )
inline

Clears the 'executionPipelineStage' attribute.

◆ clear_original_pipeline_transform()

void google_dataflow_api::PipelineDescription::clear_original_pipeline_transform ( )
inline

Clears the 'originalPipelineTransform' attribute.

◆ get_display_data()

const client::JsonCppArray<DisplayData > google_dataflow_api::PipelineDescription::get_display_data ( ) const

Get a reference to the value of the 'displayData' attribute.

◆ get_execution_pipeline_stage()

const client::JsonCppArray<ExecutionStageSummary > google_dataflow_api::PipelineDescription::get_execution_pipeline_stage ( ) const

Get a reference to the value of the 'executionPipelineStage' attribute.

◆ get_original_pipeline_transform()

const client::JsonCppArray<TransformSummary > google_dataflow_api::PipelineDescription::get_original_pipeline_transform ( ) const

Get a reference to the value of the 'originalPipelineTransform' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::PipelineDescription::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::PipelineDescription

◆ has_display_data()

bool google_dataflow_api::PipelineDescription::has_display_data ( ) const
inline

Determine if the 'displayData' attribute was set.

Returns
true if the 'displayData' attribute was set.

◆ has_execution_pipeline_stage()

bool google_dataflow_api::PipelineDescription::has_execution_pipeline_stage ( ) const
inline

Determine if the 'executionPipelineStage' attribute was set.

Returns
true if the 'executionPipelineStage' attribute was set.

◆ has_original_pipeline_transform()

bool google_dataflow_api::PipelineDescription::has_original_pipeline_transform ( ) const
inline

Determine if the 'originalPipelineTransform' attribute was set.

Returns
true if the 'originalPipelineTransform' attribute was set.

◆ mutable_displayData()

client::JsonCppArray<DisplayData > google_dataflow_api::PipelineDescription::mutable_displayData ( )

Gets a reference to a mutable value of the 'displayData' property.

Pipeline level display data.

Returns
The result can be modified to change the attribute value.

◆ mutable_executionPipelineStage()

client::JsonCppArray<ExecutionStageSummary > google_dataflow_api::PipelineDescription::mutable_executionPipelineStage ( )

Gets a reference to a mutable value of the 'executionPipelineStage' property.

Description of each stage of execution of the pipeline.

Returns
The result can be modified to change the attribute value.

◆ mutable_originalPipelineTransform()

client::JsonCppArray<TransformSummary > google_dataflow_api::PipelineDescription::mutable_originalPipelineTransform ( )

Gets a reference to a mutable value of the 'originalPipelineTransform' property.

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

Returns
The result can be modified to change the attribute value.

◆ New()

PipelineDescription * google_dataflow_api::PipelineDescription::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.
The documentation for this class was generated from the following files: