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

#include <snapshot.h>

Inheritance diagram for google_dataflow_api::Snapshot:

Public Member Functions

 Snapshot (const Json::Value &storage)
 
 Snapshot (Json::Value *storage)
 
virtual ~Snapshot ()
 
const StringPiece GetTypeName () const
 
bool has_creation_time () const
 
void clear_creation_time ()
 
const StringPiece get_creation_time () const
 
void set_creation_time (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_disk_size_bytes () const
 
void clear_disk_size_bytes ()
 
int64 get_disk_size_bytes () const
 
void set_disk_size_bytes (int64 value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_project_id () const
 
void clear_project_id ()
 
const StringPiece get_project_id () const
 
void set_project_id (const StringPiece &value)
 
bool has_pubsub_metadata () const
 
void clear_pubsub_metadata ()
 
const client::JsonCppArray< PubsubSnapshotMetadataget_pubsub_metadata () const
 
client::JsonCppArray< PubsubSnapshotMetadatamutable_pubsubMetadata ()
 
bool has_source_job_id () const
 
void clear_source_job_id ()
 
const StringPiece get_source_job_id () const
 
void set_source_job_id (const StringPiece &value)
 
bool has_state () const
 
void clear_state ()
 
const StringPiece get_state () const
 
void set_state (const StringPiece &value)
 
bool has_ttl () const
 
void clear_ttl ()
 
const StringPiece get_ttl () const
 
void set_ttl (const StringPiece &value)
 

Static Public Member Functions

static SnapshotNew ()
 

Detailed Description

Represents a snapshot of a job.

Constructor & Destructor Documentation

◆ Snapshot() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Snapshot() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Snapshot()

google_dataflow_api::Snapshot::~Snapshot ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_creation_time()

void google_dataflow_api::Snapshot::clear_creation_time ( )
inline

Clears the 'creationTime' attribute.

◆ clear_description()

void google_dataflow_api::Snapshot::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_disk_size_bytes()

void google_dataflow_api::Snapshot::clear_disk_size_bytes ( )
inline

Clears the 'diskSizeBytes' attribute.

◆ clear_id()

void google_dataflow_api::Snapshot::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_project_id()

void google_dataflow_api::Snapshot::clear_project_id ( )
inline

Clears the 'projectId' attribute.

◆ clear_pubsub_metadata()

void google_dataflow_api::Snapshot::clear_pubsub_metadata ( )
inline

Clears the 'pubsubMetadata' attribute.

◆ clear_source_job_id()

void google_dataflow_api::Snapshot::clear_source_job_id ( )
inline

Clears the 'sourceJobId' attribute.

◆ clear_state()

void google_dataflow_api::Snapshot::clear_state ( )
inline

Clears the 'state' attribute.

◆ clear_ttl()

void google_dataflow_api::Snapshot::clear_ttl ( )
inline

Clears the 'ttl' attribute.

◆ get_creation_time()

const StringPiece google_dataflow_api::Snapshot::get_creation_time ( ) const
inline

Get the value of the 'creationTime' attribute.

◆ get_description()

const StringPiece google_dataflow_api::Snapshot::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_disk_size_bytes()

int64 google_dataflow_api::Snapshot::get_disk_size_bytes ( ) const
inline

Get the value of the 'diskSizeBytes' attribute.

◆ get_id()

const StringPiece google_dataflow_api::Snapshot::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_project_id()

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

Get the value of the 'projectId' attribute.

◆ get_pubsub_metadata()

const client::JsonCppArray<PubsubSnapshotMetadata > google_dataflow_api::Snapshot::get_pubsub_metadata ( ) const

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

◆ get_source_job_id()

const StringPiece google_dataflow_api::Snapshot::get_source_job_id ( ) const
inline

Get the value of the 'sourceJobId' attribute.

◆ get_state()

const StringPiece google_dataflow_api::Snapshot::get_state ( ) const
inline

Get the value of the 'state' attribute.

◆ get_ttl()

const StringPiece google_dataflow_api::Snapshot::get_ttl ( ) const
inline

Get the value of the 'ttl' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_dataflow_api::Snapshot

◆ has_creation_time()

bool google_dataflow_api::Snapshot::has_creation_time ( ) const
inline

Determine if the 'creationTime' attribute was set.

Returns
true if the 'creationTime' attribute was set.

◆ has_description()

bool google_dataflow_api::Snapshot::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_disk_size_bytes()

bool google_dataflow_api::Snapshot::has_disk_size_bytes ( ) const
inline

Determine if the 'diskSizeBytes' attribute was set.

Returns
true if the 'diskSizeBytes' attribute was set.

◆ has_id()

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

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_project_id()

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

Determine if the 'projectId' attribute was set.

Returns
true if the 'projectId' attribute was set.

◆ has_pubsub_metadata()

bool google_dataflow_api::Snapshot::has_pubsub_metadata ( ) const
inline

Determine if the 'pubsubMetadata' attribute was set.

Returns
true if the 'pubsubMetadata' attribute was set.

◆ has_source_job_id()

bool google_dataflow_api::Snapshot::has_source_job_id ( ) const
inline

Determine if the 'sourceJobId' attribute was set.

Returns
true if the 'sourceJobId' attribute was set.

◆ has_state()

bool google_dataflow_api::Snapshot::has_state ( ) const
inline

Determine if the 'state' attribute was set.

Returns
true if the 'state' attribute was set.

◆ has_ttl()

bool google_dataflow_api::Snapshot::has_ttl ( ) const
inline

Determine if the 'ttl' attribute was set.

Returns
true if the 'ttl' attribute was set.

◆ mutable_pubsubMetadata()

client::JsonCppArray<PubsubSnapshotMetadata > google_dataflow_api::Snapshot::mutable_pubsubMetadata ( )

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

PubSub snapshot metadata.

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

◆ New()

Snapshot * google_dataflow_api::Snapshot::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_creation_time()

void google_dataflow_api::Snapshot::set_creation_time ( const StringPiece &  value)
inline

Change the 'creationTime' attribute.

The time this snapshot was created.

Parameters
[in]valueThe new value.

◆ set_description()

void google_dataflow_api::Snapshot::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

User specified description of the snapshot. Maybe empty.

Parameters
[in]valueThe new value.

◆ set_disk_size_bytes()

void google_dataflow_api::Snapshot::set_disk_size_bytes ( int64  value)
inline

Change the 'diskSizeBytes' attribute.

The disk byte size of the snapshot. Only available for snapshots in READY state.

Parameters
[in]valueThe new value.

◆ set_id()

void google_dataflow_api::Snapshot::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The unique ID of this snapshot.

Parameters
[in]valueThe new value.

◆ set_project_id()

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

Change the 'projectId' attribute.

The project this snapshot belongs to.

Parameters
[in]valueThe new value.

◆ set_source_job_id()

void google_dataflow_api::Snapshot::set_source_job_id ( const StringPiece &  value)
inline

Change the 'sourceJobId' attribute.

The job this snapshot was created from.

Parameters
[in]valueThe new value.

◆ set_state()

void google_dataflow_api::Snapshot::set_state ( const StringPiece &  value)
inline

Change the 'state' attribute.

State of the snapshot.

Parameters
[in]valueThe new value.

◆ set_ttl()

void google_dataflow_api::Snapshot::set_ttl ( const StringPiece &  value)
inline

Change the 'ttl' attribute.

The time after which this snapshot will be automatically deleted.

Parameters
[in]valueThe new value.

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