#include <work_item_service_state.h>

Inheritance diagram for google_dataflow_api::WorkItemServiceState:

Public Member Functions
	WorkItemServiceState (const Json::Value &storage)

	WorkItemServiceState (Json::Value *storage)

virtual	~WorkItemServiceState ()

const StringPiece	GetTypeName () const

bool	has_harness_data () const

void	clear_harness_data ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_harness_data () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_harnessData ()

bool	has_hot_key_detection () const

void	clear_hot_key_detection ()

const HotKeyDetection	get_hot_key_detection () const

HotKeyDetection	mutable_hotKeyDetection ()

bool	has_lease_expire_time () const

void	clear_lease_expire_time ()

const StringPiece	get_lease_expire_time () const

void	set_lease_expire_time (const StringPiece &value)

bool	has_metric_short_id () const

void	clear_metric_short_id ()

const client::JsonCppArray< MetricShortId >	get_metric_short_id () const

client::JsonCppArray< MetricShortId >	mutable_metricShortId ()

bool	has_next_report_index () const

void	clear_next_report_index ()

int64	get_next_report_index () const

void	set_next_report_index (int64 value)

bool	has_report_status_interval () const

void	clear_report_status_interval ()

const StringPiece	get_report_status_interval () const

void	set_report_status_interval (const StringPiece &value)

bool	has_split_request () const

void	clear_split_request ()

const ApproximateSplitRequest	get_split_request () const

ApproximateSplitRequest	mutable_splitRequest ()

bool	has_suggested_stop_point () const

void	clear_suggested_stop_point ()

const ApproximateProgress	get_suggested_stop_point () const

ApproximateProgress	mutable_suggestedStopPoint ()

bool	has_suggested_stop_position () const

void	clear_suggested_stop_position ()

const Position	get_suggested_stop_position () const

Position	mutable_suggestedStopPosition ()

Static Public Member Functions
static WorkItemServiceState *	New ()

Detailed Description

The Dataflow service's idea of the current state of a WorkItem being processed by a worker.

Constructor & Destructor Documentation

◆ WorkItemServiceState() [1/2]

google_dataflow_api::WorkItemServiceState::WorkItemServiceState ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ WorkItemServiceState() [2/2]

google_dataflow_api::WorkItemServiceState::WorkItemServiceState ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~WorkItemServiceState()

google_dataflow_api::WorkItemServiceState::~WorkItemServiceState ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_harness_data()

void google_dataflow_api::WorkItemServiceState::clear_harness_data ( )

inline

Clears the 'harnessData' attribute.

◆ clear_hot_key_detection()

void google_dataflow_api::WorkItemServiceState::clear_hot_key_detection ( )

inline

Clears the 'hotKeyDetection' attribute.

◆ clear_lease_expire_time()

void google_dataflow_api::WorkItemServiceState::clear_lease_expire_time ( )

inline

Clears the 'leaseExpireTime' attribute.

◆ clear_metric_short_id()

void google_dataflow_api::WorkItemServiceState::clear_metric_short_id ( )

inline

Clears the 'metricShortId' attribute.

◆ clear_next_report_index()

void google_dataflow_api::WorkItemServiceState::clear_next_report_index ( )

inline

Clears the 'nextReportIndex' attribute.

◆ clear_report_status_interval()

void google_dataflow_api::WorkItemServiceState::clear_report_status_interval ( )

inline

Clears the 'reportStatusInterval' attribute.

◆ clear_split_request()

void google_dataflow_api::WorkItemServiceState::clear_split_request ( )

inline

Clears the 'splitRequest' attribute.

◆ clear_suggested_stop_point()

void google_dataflow_api::WorkItemServiceState::clear_suggested_stop_point ( )

inline

Clears the 'suggestedStopPoint' attribute.

◆ clear_suggested_stop_position()

void google_dataflow_api::WorkItemServiceState::clear_suggested_stop_position ( )

inline

Clears the 'suggestedStopPosition' attribute.

◆ get_harness_data()

const client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::WorkItemServiceState::get_harness_data ( ) const

inline

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

◆ get_hot_key_detection()

const HotKeyDetection google_dataflow_api::WorkItemServiceState::get_hot_key_detection ( ) const

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

◆ get_lease_expire_time()

const StringPiece google_dataflow_api::WorkItemServiceState::get_lease_expire_time ( ) const

inline

Get the value of the 'leaseExpireTime' attribute.

◆ get_metric_short_id()

const client::JsonCppArray<MetricShortId > google_dataflow_api::WorkItemServiceState::get_metric_short_id ( ) const

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

◆ get_next_report_index()

int64 google_dataflow_api::WorkItemServiceState::get_next_report_index ( ) const

inline

Get the value of the 'nextReportIndex' attribute.

◆ get_report_status_interval()

const StringPiece google_dataflow_api::WorkItemServiceState::get_report_status_interval ( ) const

inline

Get the value of the 'reportStatusInterval' attribute.

◆ get_split_request()

const ApproximateSplitRequest google_dataflow_api::WorkItemServiceState::get_split_request ( ) const

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

◆ get_suggested_stop_point()

const ApproximateProgress google_dataflow_api::WorkItemServiceState::get_suggested_stop_point ( ) const

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

◆ get_suggested_stop_position()

const Position google_dataflow_api::WorkItemServiceState::get_suggested_stop_position ( ) const

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

◆ GetTypeName()

const StringPiece google_dataflow_api::WorkItemServiceState::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::WorkItemServiceState

◆ has_harness_data()

bool google_dataflow_api::WorkItemServiceState::has_harness_data ( ) const

inline

Determine if the 'harnessData' attribute was set.

Returns: true if the 'harnessData' attribute was set.

◆ has_hot_key_detection()

bool google_dataflow_api::WorkItemServiceState::has_hot_key_detection ( ) const

inline

Determine if the 'hotKeyDetection' attribute was set.

Returns: true if the 'hotKeyDetection' attribute was set.

◆ has_lease_expire_time()

bool google_dataflow_api::WorkItemServiceState::has_lease_expire_time ( ) const

inline

Determine if the 'leaseExpireTime' attribute was set.

Returns: true if the 'leaseExpireTime' attribute was set.

◆ has_metric_short_id()

bool google_dataflow_api::WorkItemServiceState::has_metric_short_id ( ) const

inline

Determine if the 'metricShortId' attribute was set.

Returns: true if the 'metricShortId' attribute was set.

◆ has_next_report_index()

bool google_dataflow_api::WorkItemServiceState::has_next_report_index ( ) const

inline

Determine if the 'nextReportIndex' attribute was set.

Returns: true if the 'nextReportIndex' attribute was set.

◆ has_report_status_interval()

bool google_dataflow_api::WorkItemServiceState::has_report_status_interval ( ) const

inline

Determine if the 'reportStatusInterval' attribute was set.

Returns: true if the 'reportStatusInterval' attribute was set.

◆ has_split_request()

bool google_dataflow_api::WorkItemServiceState::has_split_request ( ) const

inline

Determine if the 'splitRequest' attribute was set.

Returns: true if the 'splitRequest' attribute was set.

◆ has_suggested_stop_point()

bool google_dataflow_api::WorkItemServiceState::has_suggested_stop_point ( ) const

inline

Determine if the 'suggestedStopPoint' attribute was set.

Returns: true if the 'suggestedStopPoint' attribute was set.

◆ has_suggested_stop_position()

bool google_dataflow_api::WorkItemServiceState::has_suggested_stop_position ( ) const

inline

Determine if the 'suggestedStopPosition' attribute was set.

Returns: true if the 'suggestedStopPosition' attribute was set.

◆ mutable_harnessData()

client::JsonCppAssociativeArray<client::JsonCppData > google_dataflow_api::WorkItemServiceState::mutable_harnessData ( )

inline

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

Other data returned by the service, specific to the particular worker harness.

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

◆ mutable_hotKeyDetection()

HotKeyDetection google_dataflow_api::WorkItemServiceState::mutable_hotKeyDetection ( )

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

A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance. When present, this field includes metadata associated with any hot key.

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

◆ mutable_metricShortId()

client::JsonCppArray<MetricShortId > google_dataflow_api::WorkItemServiceState::mutable_metricShortId ( )

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

The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics.

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

◆ mutable_splitRequest()

ApproximateSplitRequest google_dataflow_api::WorkItemServiceState::mutable_splitRequest ( )

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

The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.

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

◆ mutable_suggestedStopPoint()

ApproximateProgress google_dataflow_api::WorkItemServiceState::mutable_suggestedStopPoint ( )

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

Deprecated:

DEPRECATED in favor of split_request.

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

◆ mutable_suggestedStopPosition()

Position google_dataflow_api::WorkItemServiceState::mutable_suggestedStopPosition ( )

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

Obsolete, always empty.

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

◆ New()

WorkItemServiceState * google_dataflow_api::WorkItemServiceState::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_lease_expire_time()

void google_dataflow_api::WorkItemServiceState::set_lease_expire_time ( const StringPiece & value )

inline

Change the 'leaseExpireTime' attribute.

Time at which the current lease will expire.

Parameters

[in] value The new value.

◆ set_next_report_index()

void google_dataflow_api::WorkItemServiceState::set_next_report_index ( int64 value )

inline

Change the 'nextReportIndex' attribute.

The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts.

Parameters

[in] value The new value.

◆ set_report_status_interval()

void google_dataflow_api::WorkItemServiceState::set_report_status_interval ( const StringPiece & value )

inline

Change the 'reportStatusInterval' attribute.

New recommended reporting interval.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/dataflow_api/work_item_service_state.h
google/dataflow_api/work_item_service_state.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WorkItemServiceState() [1/2]

◆ WorkItemServiceState() [2/2]

◆ ~WorkItemServiceState()

Member Function Documentation

◆ clear_harness_data()

◆ clear_hot_key_detection()

◆ clear_lease_expire_time()

◆ clear_metric_short_id()

◆ clear_next_report_index()

◆ clear_report_status_interval()

◆ clear_split_request()

◆ clear_suggested_stop_point()

◆ clear_suggested_stop_position()

◆ get_harness_data()

◆ get_hot_key_detection()

◆ get_lease_expire_time()

◆ get_metric_short_id()

◆ get_next_report_index()

◆ get_report_status_interval()

◆ get_split_request()

◆ get_suggested_stop_point()

◆ get_suggested_stop_position()

◆ GetTypeName()

◆ has_harness_data()

◆ has_hot_key_detection()

◆ has_lease_expire_time()

◆ has_metric_short_id()

◆ has_next_report_index()

◆ has_report_status_interval()

◆ has_split_request()

◆ has_suggested_stop_point()

◆ has_suggested_stop_position()

◆ mutable_harnessData()

◆ mutable_hotKeyDetection()

◆ mutable_metricShortId()

◆ mutable_splitRequest()

◆ mutable_suggestedStopPoint()

◆ mutable_suggestedStopPosition()

◆ New()

◆ set_lease_expire_time()

◆ set_next_report_index()

◆ set_report_status_interval()