google_dataflow_api::Package Class Reference

#include <package.h>

Inheritance diagram for google_dataflow_api::Package:

Public Member Functions
	Package (const Json::Value &storage)
	Package (Json::Value *storage)
virtual	~Package ()
const StringPiece	GetTypeName () const
bool	has_location () const
void	clear_location ()
const StringPiece	get_location () const
void	set_location (const StringPiece &value)
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)

Static Public Member Functions
static Package *	New ()

Detailed Description

The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool.

This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run.

Constructor & Destructor Documentation

Package() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Package() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Package()

google_dataflow_api::Package::~Package ( )

virtual

Standard destructor.

Member Function Documentation

clear_location()

void google_dataflow_api::Package::clear_location ( )

inline

Clears the 'location' attribute.

clear_name()

void google_dataflow_api::Package::clear_name ( )

inline

Clears the 'name' attribute.

get_location()

const StringPiece google_dataflow_api::Package::get_location ( ) const

inline

Get the value of the 'location' attribute.

get_name()

const StringPiece google_dataflow_api::Package::get_name ( ) const

inline

Get the value of the 'name' attribute.

GetTypeName()

const StringPiece google_dataflow_api::Package::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::Package

has_location()

bool google_dataflow_api::Package::has_location ( ) const

inline

Determine if the 'location' attribute was set.

Returns

true if the 'location' attribute was set.

has_name()

bool google_dataflow_api::Package::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

New()

Package * google_dataflow_api::Package::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_location()

void google_dataflow_api::Package::set_location ( const StringPiece &  value )

inline

Change the 'location' attribute.

The resource to read the package from. The supported resource type is:

Google Cloud Storage:

storage.googleapis.com/{bucket} bucket.storage.googleapis.com/.

Parameters

[in]

value

The new value.

set_name()

void google_dataflow_api::Package::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

The name of the package.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/package.h
• google/dataflow_api/package.cc