dataflow  v1b3
Public Member Functions | Static Public Member Functions | List of all members
google_dataflow_api::WorkItem Class Reference

#include <work_item.h>

Inheritance diagram for google_dataflow_api::WorkItem:

Public Member Functions

 WorkItem (const Json::Value &storage)
 
 WorkItem (Json::Value *storage)
 
virtual ~WorkItem ()
 
const StringPiece GetTypeName () const
 
bool has_configuration () const
 
void clear_configuration ()
 
const StringPiece get_configuration () const
 
void set_configuration (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
int64 get_id () const
 
void set_id (int64 value)
 
bool has_initial_report_index () const
 
void clear_initial_report_index ()
 
int64 get_initial_report_index () const
 
void set_initial_report_index (int64 value)
 
bool has_job_id () const
 
void clear_job_id ()
 
const StringPiece get_job_id () const
 
void set_job_id (const StringPiece &value)
 
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_map_task () const
 
void clear_map_task ()
 
const MapTask get_map_task () const
 
MapTask mutable_mapTask ()
 
bool has_packages () const
 
void clear_packages ()
 
const client::JsonCppArray< Packageget_packages () const
 
client::JsonCppArray< Packagemutable_packages ()
 
bool has_project_id () const
 
void clear_project_id ()
 
const StringPiece get_project_id () const
 
void set_project_id (const StringPiece &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_seq_map_task () const
 
void clear_seq_map_task ()
 
const SeqMapTask get_seq_map_task () const
 
SeqMapTask mutable_seqMapTask ()
 
bool has_shell_task () const
 
void clear_shell_task ()
 
const ShellTask get_shell_task () const
 
ShellTask mutable_shellTask ()
 
bool has_source_operation_task () const
 
void clear_source_operation_task ()
 
const SourceOperationRequest get_source_operation_task () const
 
SourceOperationRequest mutable_sourceOperationTask ()
 
bool has_streaming_computation_task () const
 
void clear_streaming_computation_task ()
 
const StreamingComputationTask get_streaming_computation_task () const
 
StreamingComputationTask mutable_streamingComputationTask ()
 
bool has_streaming_config_task () const
 
void clear_streaming_config_task ()
 
const StreamingConfigTask get_streaming_config_task () const
 
StreamingConfigTask mutable_streamingConfigTask ()
 
bool has_streaming_setup_task () const
 
void clear_streaming_setup_task ()
 
const StreamingSetupTask get_streaming_setup_task () const
 
StreamingSetupTask mutable_streamingSetupTask ()
 

Static Public Member Functions

static WorkItemNew ()
 

Detailed Description

WorkItem represents basic information about a WorkItem to be executed in the cloud.

Constructor & Destructor Documentation

◆ WorkItem() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ WorkItem() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~WorkItem()

google_dataflow_api::WorkItem::~WorkItem ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_configuration()

void google_dataflow_api::WorkItem::clear_configuration ( )
inline

Clears the 'configuration' attribute.

◆ clear_id()

void google_dataflow_api::WorkItem::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_initial_report_index()

void google_dataflow_api::WorkItem::clear_initial_report_index ( )
inline

Clears the 'initialReportIndex' attribute.

◆ clear_job_id()

void google_dataflow_api::WorkItem::clear_job_id ( )
inline

Clears the 'jobId' attribute.

◆ clear_lease_expire_time()

void google_dataflow_api::WorkItem::clear_lease_expire_time ( )
inline

Clears the 'leaseExpireTime' attribute.

◆ clear_map_task()

void google_dataflow_api::WorkItem::clear_map_task ( )
inline

Clears the 'mapTask' attribute.

◆ clear_packages()

void google_dataflow_api::WorkItem::clear_packages ( )
inline

Clears the 'packages' attribute.

◆ clear_project_id()

void google_dataflow_api::WorkItem::clear_project_id ( )
inline

Clears the 'projectId' attribute.

◆ clear_report_status_interval()

void google_dataflow_api::WorkItem::clear_report_status_interval ( )
inline

Clears the 'reportStatusInterval' attribute.

◆ clear_seq_map_task()

void google_dataflow_api::WorkItem::clear_seq_map_task ( )
inline

Clears the 'seqMapTask' attribute.

◆ clear_shell_task()

void google_dataflow_api::WorkItem::clear_shell_task ( )
inline

Clears the 'shellTask' attribute.

◆ clear_source_operation_task()

void google_dataflow_api::WorkItem::clear_source_operation_task ( )
inline

Clears the 'sourceOperationTask' attribute.

◆ clear_streaming_computation_task()

void google_dataflow_api::WorkItem::clear_streaming_computation_task ( )
inline

Clears the 'streamingComputationTask' attribute.

◆ clear_streaming_config_task()

void google_dataflow_api::WorkItem::clear_streaming_config_task ( )
inline

Clears the 'streamingConfigTask' attribute.

◆ clear_streaming_setup_task()

void google_dataflow_api::WorkItem::clear_streaming_setup_task ( )
inline

Clears the 'streamingSetupTask' attribute.

◆ get_configuration()

const StringPiece google_dataflow_api::WorkItem::get_configuration ( ) const
inline

Get the value of the 'configuration' attribute.

◆ get_id()

int64 google_dataflow_api::WorkItem::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_initial_report_index()

int64 google_dataflow_api::WorkItem::get_initial_report_index ( ) const
inline

Get the value of the 'initialReportIndex' attribute.

◆ get_job_id()

const StringPiece google_dataflow_api::WorkItem::get_job_id ( ) const
inline

Get the value of the 'jobId' attribute.

◆ get_lease_expire_time()

const StringPiece google_dataflow_api::WorkItem::get_lease_expire_time ( ) const
inline

Get the value of the 'leaseExpireTime' attribute.

◆ get_map_task()

const MapTask google_dataflow_api::WorkItem::get_map_task ( ) const

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

◆ get_packages()

const client::JsonCppArray<Package > google_dataflow_api::WorkItem::get_packages ( ) const

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

◆ get_project_id()

const StringPiece google_dataflow_api::WorkItem::get_project_id ( ) const
inline

Get the value of the 'projectId' attribute.

◆ get_report_status_interval()

const StringPiece google_dataflow_api::WorkItem::get_report_status_interval ( ) const
inline

Get the value of the 'reportStatusInterval' attribute.

◆ get_seq_map_task()

const SeqMapTask google_dataflow_api::WorkItem::get_seq_map_task ( ) const

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

◆ get_shell_task()

const ShellTask google_dataflow_api::WorkItem::get_shell_task ( ) const

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

◆ get_source_operation_task()

const SourceOperationRequest google_dataflow_api::WorkItem::get_source_operation_task ( ) const

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

◆ get_streaming_computation_task()

const StreamingComputationTask google_dataflow_api::WorkItem::get_streaming_computation_task ( ) const

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

◆ get_streaming_config_task()

const StreamingConfigTask google_dataflow_api::WorkItem::get_streaming_config_task ( ) const

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

◆ get_streaming_setup_task()

const StreamingSetupTask google_dataflow_api::WorkItem::get_streaming_setup_task ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::WorkItem

◆ has_configuration()

bool google_dataflow_api::WorkItem::has_configuration ( ) const
inline

Determine if the 'configuration' attribute was set.

Returns
true if the 'configuration' attribute was set.

◆ has_id()

bool google_dataflow_api::WorkItem::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_initial_report_index()

bool google_dataflow_api::WorkItem::has_initial_report_index ( ) const
inline

Determine if the 'initialReportIndex' attribute was set.

Returns
true if the 'initialReportIndex' attribute was set.

◆ has_job_id()

bool google_dataflow_api::WorkItem::has_job_id ( ) const
inline

Determine if the 'jobId' attribute was set.

Returns
true if the 'jobId' attribute was set.

◆ has_lease_expire_time()

bool google_dataflow_api::WorkItem::has_lease_expire_time ( ) const
inline

Determine if the 'leaseExpireTime' attribute was set.

Returns
true if the 'leaseExpireTime' attribute was set.

◆ has_map_task()

bool google_dataflow_api::WorkItem::has_map_task ( ) const
inline

Determine if the 'mapTask' attribute was set.

Returns
true if the 'mapTask' attribute was set.

◆ has_packages()

bool google_dataflow_api::WorkItem::has_packages ( ) const
inline

Determine if the 'packages' attribute was set.

Returns
true if the 'packages' attribute was set.

◆ has_project_id()

bool google_dataflow_api::WorkItem::has_project_id ( ) const
inline

Determine if the 'projectId' attribute was set.

Returns
true if the 'projectId' attribute was set.

◆ has_report_status_interval()

bool google_dataflow_api::WorkItem::has_report_status_interval ( ) const
inline

Determine if the 'reportStatusInterval' attribute was set.

Returns
true if the 'reportStatusInterval' attribute was set.

◆ has_seq_map_task()

bool google_dataflow_api::WorkItem::has_seq_map_task ( ) const
inline

Determine if the 'seqMapTask' attribute was set.

Returns
true if the 'seqMapTask' attribute was set.

◆ has_shell_task()

bool google_dataflow_api::WorkItem::has_shell_task ( ) const
inline

Determine if the 'shellTask' attribute was set.

Returns
true if the 'shellTask' attribute was set.

◆ has_source_operation_task()

bool google_dataflow_api::WorkItem::has_source_operation_task ( ) const
inline

Determine if the 'sourceOperationTask' attribute was set.

Returns
true if the 'sourceOperationTask' attribute was set.

◆ has_streaming_computation_task()

bool google_dataflow_api::WorkItem::has_streaming_computation_task ( ) const
inline

Determine if the 'streamingComputationTask' attribute was set.

Returns
true if the 'streamingComputationTask' attribute was set.

◆ has_streaming_config_task()

bool google_dataflow_api::WorkItem::has_streaming_config_task ( ) const
inline

Determine if the 'streamingConfigTask' attribute was set.

Returns
true if the 'streamingConfigTask' attribute was set.

◆ has_streaming_setup_task()

bool google_dataflow_api::WorkItem::has_streaming_setup_task ( ) const
inline

Determine if the 'streamingSetupTask' attribute was set.

Returns
true if the 'streamingSetupTask' attribute was set.

◆ mutable_mapTask()

MapTask google_dataflow_api::WorkItem::mutable_mapTask ( )

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

Additional information for MapTask WorkItems.

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

◆ mutable_packages()

client::JsonCppArray<Package > google_dataflow_api::WorkItem::mutable_packages ( )

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

Any required packages that need to be fetched in order to execute this WorkItem.

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

◆ mutable_seqMapTask()

SeqMapTask google_dataflow_api::WorkItem::mutable_seqMapTask ( )

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

Additional information for SeqMapTask WorkItems.

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

◆ mutable_shellTask()

ShellTask google_dataflow_api::WorkItem::mutable_shellTask ( )

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

Additional information for ShellTask WorkItems.

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

◆ mutable_sourceOperationTask()

SourceOperationRequest google_dataflow_api::WorkItem::mutable_sourceOperationTask ( )

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

Additional information for source operation WorkItems.

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

◆ mutable_streamingComputationTask()

StreamingComputationTask google_dataflow_api::WorkItem::mutable_streamingComputationTask ( )

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

Additional information for StreamingComputationTask WorkItems.

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

◆ mutable_streamingConfigTask()

StreamingConfigTask google_dataflow_api::WorkItem::mutable_streamingConfigTask ( )

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

Additional information for StreamingConfigTask WorkItems.

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

◆ mutable_streamingSetupTask()

StreamingSetupTask google_dataflow_api::WorkItem::mutable_streamingSetupTask ( )

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

Additional information for StreamingSetupTask WorkItems.

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

◆ New()

WorkItem * google_dataflow_api::WorkItem::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_configuration()

void google_dataflow_api::WorkItem::set_configuration ( const StringPiece &  value)
inline

Change the 'configuration' attribute.

Work item-specific configuration as an opaque blob.

Parameters
[in]valueThe new value.

◆ set_id()

void google_dataflow_api::WorkItem::set_id ( int64  value)
inline

Change the 'id' attribute.

Identifies this WorkItem.

Parameters
[in]valueThe new value.

◆ set_initial_report_index()

void google_dataflow_api::WorkItem::set_initial_report_index ( int64  value)
inline

Change the 'initialReportIndex' attribute.

The initial index to use when reporting the status of the WorkItem.

Parameters
[in]valueThe new value.

◆ set_job_id()

void google_dataflow_api::WorkItem::set_job_id ( const StringPiece &  value)
inline

Change the 'jobId' attribute.

Identifies the workflow job this WorkItem belongs to.

Parameters
[in]valueThe new value.

◆ set_lease_expire_time()

void google_dataflow_api::WorkItem::set_lease_expire_time ( const StringPiece &  value)
inline

Change the 'leaseExpireTime' attribute.

Time when the lease on this Work will expire.

Parameters
[in]valueThe new value.

◆ set_project_id()

void google_dataflow_api::WorkItem::set_project_id ( const StringPiece &  value)
inline

Change the 'projectId' attribute.

Identifies the cloud project this WorkItem belongs to.

Parameters
[in]valueThe new value.

◆ set_report_status_interval()

void google_dataflow_api::WorkItem::set_report_status_interval ( const StringPiece &  value)
inline

Change the 'reportStatusInterval' attribute.

Recommended reporting interval.

Parameters
[in]valueThe new value.

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