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

#include <approximate_reported_progress.h>

Inheritance diagram for google_dataflow_api::ApproximateReportedProgress:

Public Member Functions

 ApproximateReportedProgress (const Json::Value &storage)
 
 ApproximateReportedProgress (Json::Value *storage)
 
virtual ~ApproximateReportedProgress ()
 
const StringPiece GetTypeName () const
 
bool has_consumed_parallelism () const
 
void clear_consumed_parallelism ()
 
const ReportedParallelism get_consumed_parallelism () const
 
ReportedParallelism mutable_consumedParallelism ()
 
bool has_fraction_consumed () const
 
void clear_fraction_consumed ()
 
double get_fraction_consumed () const
 
void set_fraction_consumed (double value)
 
bool has_position () const
 
void clear_position ()
 
const Position get_position () const
 
Position mutable_position ()
 
bool has_remaining_parallelism () const
 
void clear_remaining_parallelism ()
 
const ReportedParallelism get_remaining_parallelism () const
 
ReportedParallelism mutable_remainingParallelism ()
 

Static Public Member Functions

static ApproximateReportedProgress * New ()
 

Detailed Description

A progress measurement of a WorkItem by a worker.

Constructor & Destructor Documentation

◆ ApproximateReportedProgress() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ ApproximateReportedProgress() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~ApproximateReportedProgress()

google_dataflow_api::ApproximateReportedProgress::~ApproximateReportedProgress ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_consumed_parallelism()

void google_dataflow_api::ApproximateReportedProgress::clear_consumed_parallelism ( )
inline

Clears the 'consumedParallelism' attribute.

◆ clear_fraction_consumed()

void google_dataflow_api::ApproximateReportedProgress::clear_fraction_consumed ( )
inline

Clears the 'fractionConsumed' attribute.

◆ clear_position()

void google_dataflow_api::ApproximateReportedProgress::clear_position ( )
inline

Clears the 'position' attribute.

◆ clear_remaining_parallelism()

void google_dataflow_api::ApproximateReportedProgress::clear_remaining_parallelism ( )
inline

Clears the 'remainingParallelism' attribute.

◆ get_consumed_parallelism()

const ReportedParallelism google_dataflow_api::ApproximateReportedProgress::get_consumed_parallelism ( ) const

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

◆ get_fraction_consumed()

double google_dataflow_api::ApproximateReportedProgress::get_fraction_consumed ( ) const
inline

Get the value of the 'fractionConsumed' attribute.

◆ get_position()

const Position google_dataflow_api::ApproximateReportedProgress::get_position ( ) const

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

◆ get_remaining_parallelism()

const ReportedParallelism google_dataflow_api::ApproximateReportedProgress::get_remaining_parallelism ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::ApproximateReportedProgress

◆ has_consumed_parallelism()

bool google_dataflow_api::ApproximateReportedProgress::has_consumed_parallelism ( ) const
inline

Determine if the 'consumedParallelism' attribute was set.

Returns
true if the 'consumedParallelism' attribute was set.

◆ has_fraction_consumed()

bool google_dataflow_api::ApproximateReportedProgress::has_fraction_consumed ( ) const
inline

Determine if the 'fractionConsumed' attribute was set.

Returns
true if the 'fractionConsumed' attribute was set.

◆ has_position()

bool google_dataflow_api::ApproximateReportedProgress::has_position ( ) const
inline

Determine if the 'position' attribute was set.

Returns
true if the 'position' attribute was set.

◆ has_remaining_parallelism()

bool google_dataflow_api::ApproximateReportedProgress::has_remaining_parallelism ( ) const
inline

Determine if the 'remainingParallelism' attribute was set.

Returns
true if the 'remainingParallelism' attribute was set.

◆ mutable_consumedParallelism()

ReportedParallelism google_dataflow_api::ApproximateReportedProgress::mutable_consumedParallelism ( )

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

Total amount of parallelism in the portion of input of this task that has already been consumed and is no longer active. In the first two examples above (see remaining_parallelism), the value should be 29 or 2 respectively. The sum of remaining_parallelism and consumed_parallelism should equal the total amount of parallelism in this work item. If specified, must be finite.

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

◆ mutable_position()

Position google_dataflow_api::ApproximateReportedProgress::mutable_position ( )

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

A Position within the work to represent a progress.

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

◆ mutable_remainingParallelism()

ReportedParallelism google_dataflow_api::ApproximateReportedProgress::mutable_remainingParallelism ( )

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

Total amount of parallelism in the input of this task that remains, (i.e. can be delegated to this task and any new tasks via dynamic splitting). Always at least 1 for non-finished work items and 0 for finished.

"Amount of parallelism" refers to how many non-empty parts of the input can be read in parallel. This does not necessarily equal number of records. An input that can be read in parallel down to the individual records is called "perfectly splittable". An example of non-perfectly parallelizable input is a block-compressed file format where a block of records has to be read as a whole, but different blocks can be read in parallel.

Examples:

  • If we are processing record #30 (starting at 1) out of 50 in a perfectly splittable 50-record input, this value should be 21 (20 remaining + 1 current).
  • If we are reading through block 3 in a block-compressed file consisting of 5 blocks, this value should be 3 (since blocks 4 and 5 can be processed in parallel by new tasks via dynamic splitting and the current task remains processing block 3).
  • If we are reading through the last block in a block-compressed file, or reading or processing the last record in a perfectly splittable input, this value should be 1, because apart from the current task, no additional remainder can be split off.
Returns
The result can be modified to change the attribute value.

◆ New()

ApproximateReportedProgress * google_dataflow_api::ApproximateReportedProgress::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_fraction_consumed()

void google_dataflow_api::ApproximateReportedProgress::set_fraction_consumed ( double  value)
inline

Change the 'fractionConsumed' attribute.

Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed).

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: