bigquery  v2
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::JobStatistics Class Reference

#include <job_statistics.h>

Inheritance diagram for google_bigquery_api::JobStatistics:

Classes

class  JobStatisticsReservationUsage
 

Public Member Functions

 JobStatistics (const Json::Value &storage)
 
 JobStatistics (Json::Value *storage)
 
virtual ~JobStatistics ()
 
const StringPiece GetTypeName () const
 
bool has_completion_ratio () const
 
void clear_completion_ratio ()
 
double get_completion_ratio () const
 
void set_completion_ratio (double value)
 
bool has_creation_time () const
 
void clear_creation_time ()
 
int64 get_creation_time () const
 
void set_creation_time (int64 value)
 
bool has_end_time () const
 
void clear_end_time ()
 
int64 get_end_time () const
 
void set_end_time (int64 value)
 
bool has_extract () const
 
void clear_extract ()
 
const JobStatistics4 get_extract () const
 
JobStatistics4 mutable_extract ()
 
bool has_load () const
 
void clear_load ()
 
const JobStatistics3 get_load () const
 
JobStatistics3 mutable_load ()
 
bool has_num_child_jobs () const
 
void clear_num_child_jobs ()
 
int64 get_num_child_jobs () const
 
void set_num_child_jobs (int64 value)
 
bool has_parent_job_id () const
 
void clear_parent_job_id ()
 
const StringPiece get_parent_job_id () const
 
void set_parent_job_id (const StringPiece &value)
 
bool has_query () const
 
void clear_query ()
 
const JobStatistics2 get_query () const
 
JobStatistics2 mutable_query ()
 
bool has_quota_deferments () const
 
void clear_quota_deferments ()
 
const client::JsonCppArray< string > get_quota_deferments () const
 
client::JsonCppArray< string > mutable_quotaDeferments ()
 
bool has_reservation_usage () const
 
void clear_reservation_usage ()
 
const client::JsonCppArray< JobStatisticsReservationUsageget_reservation_usage () const
 
client::JsonCppArray< JobStatisticsReservationUsagemutable_reservationUsage ()
 
bool has_reservation_id () const
 
void clear_reservation_id ()
 
const StringPiece get_reservation_id () const
 
void set_reservation_id (const StringPiece &value)
 
bool has_script_statistics () const
 
void clear_script_statistics ()
 
const ScriptStatistics get_script_statistics () const
 
ScriptStatistics mutable_scriptStatistics ()
 
bool has_start_time () const
 
void clear_start_time ()
 
int64 get_start_time () const
 
void set_start_time (int64 value)
 
bool has_total_bytes_processed () const
 
void clear_total_bytes_processed ()
 
int64 get_total_bytes_processed () const
 
void set_total_bytes_processed (int64 value)
 
bool has_total_slot_ms () const
 
void clear_total_slot_ms ()
 
int64 get_total_slot_ms () const
 
void set_total_slot_ms (int64 value)
 

Static Public Member Functions

static JobStatisticsNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ JobStatistics() [1/2]

google_bigquery_api::JobStatistics::JobStatistics ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ JobStatistics() [2/2]

google_bigquery_api::JobStatistics::JobStatistics ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~JobStatistics()

google_bigquery_api::JobStatistics::~JobStatistics ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_completion_ratio()

void google_bigquery_api::JobStatistics::clear_completion_ratio ( )
inline

Clears the 'completionRatio' attribute.

◆ clear_creation_time()

void google_bigquery_api::JobStatistics::clear_creation_time ( )
inline

Clears the 'creationTime' attribute.

◆ clear_end_time()

void google_bigquery_api::JobStatistics::clear_end_time ( )
inline

Clears the 'endTime' attribute.

◆ clear_extract()

void google_bigquery_api::JobStatistics::clear_extract ( )
inline

Clears the 'extract' attribute.

◆ clear_load()

void google_bigquery_api::JobStatistics::clear_load ( )
inline

Clears the 'load' attribute.

◆ clear_num_child_jobs()

void google_bigquery_api::JobStatistics::clear_num_child_jobs ( )
inline

Clears the 'numChildJobs' attribute.

◆ clear_parent_job_id()

void google_bigquery_api::JobStatistics::clear_parent_job_id ( )
inline

Clears the 'parentJobId' attribute.

◆ clear_query()

void google_bigquery_api::JobStatistics::clear_query ( )
inline

Clears the 'query' attribute.

◆ clear_quota_deferments()

void google_bigquery_api::JobStatistics::clear_quota_deferments ( )
inline

Clears the 'quotaDeferments' attribute.

◆ clear_reservation_id()

void google_bigquery_api::JobStatistics::clear_reservation_id ( )
inline

Clears the 'reservation_id' attribute.

◆ clear_reservation_usage()

void google_bigquery_api::JobStatistics::clear_reservation_usage ( )
inline

Clears the 'reservationUsage' attribute.

◆ clear_script_statistics()

void google_bigquery_api::JobStatistics::clear_script_statistics ( )
inline

Clears the 'scriptStatistics' attribute.

◆ clear_start_time()

void google_bigquery_api::JobStatistics::clear_start_time ( )
inline

Clears the 'startTime' attribute.

◆ clear_total_bytes_processed()

void google_bigquery_api::JobStatistics::clear_total_bytes_processed ( )
inline

Clears the 'totalBytesProcessed' attribute.

◆ clear_total_slot_ms()

void google_bigquery_api::JobStatistics::clear_total_slot_ms ( )
inline

Clears the 'totalSlotMs' attribute.

◆ get_completion_ratio()

double google_bigquery_api::JobStatistics::get_completion_ratio ( ) const
inline

Get the value of the 'completionRatio' attribute.

◆ get_creation_time()

int64 google_bigquery_api::JobStatistics::get_creation_time ( ) const
inline

Get the value of the 'creationTime' attribute.

◆ get_end_time()

int64 google_bigquery_api::JobStatistics::get_end_time ( ) const
inline

Get the value of the 'endTime' attribute.

◆ get_extract()

const JobStatistics4 google_bigquery_api::JobStatistics::get_extract ( ) const

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

◆ get_load()

const JobStatistics3 google_bigquery_api::JobStatistics::get_load ( ) const

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

◆ get_num_child_jobs()

int64 google_bigquery_api::JobStatistics::get_num_child_jobs ( ) const
inline

Get the value of the 'numChildJobs' attribute.

◆ get_parent_job_id()

const StringPiece google_bigquery_api::JobStatistics::get_parent_job_id ( ) const
inline

Get the value of the 'parentJobId' attribute.

◆ get_query()

const JobStatistics2 google_bigquery_api::JobStatistics::get_query ( ) const

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

◆ get_quota_deferments()

const client::JsonCppArray<string > google_bigquery_api::JobStatistics::get_quota_deferments ( ) const
inline

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

◆ get_reservation_id()

const StringPiece google_bigquery_api::JobStatistics::get_reservation_id ( ) const
inline

Get the value of the 'reservation_id' attribute.

◆ get_reservation_usage()

const client::JsonCppArray<JobStatisticsReservationUsage > google_bigquery_api::JobStatistics::get_reservation_usage ( ) const
inline

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

◆ get_script_statistics()

const ScriptStatistics google_bigquery_api::JobStatistics::get_script_statistics ( ) const

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

◆ get_start_time()

int64 google_bigquery_api::JobStatistics::get_start_time ( ) const
inline

Get the value of the 'startTime' attribute.

◆ get_total_bytes_processed()

int64 google_bigquery_api::JobStatistics::get_total_bytes_processed ( ) const
inline

Get the value of the 'totalBytesProcessed' attribute.

◆ get_total_slot_ms()

int64 google_bigquery_api::JobStatistics::get_total_slot_ms ( ) const
inline

Get the value of the 'totalSlotMs' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::JobStatistics::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::JobStatistics

◆ has_completion_ratio()

bool google_bigquery_api::JobStatistics::has_completion_ratio ( ) const
inline

Determine if the 'completionRatio' attribute was set.

Returns
true if the 'completionRatio' attribute was set.

◆ has_creation_time()

bool google_bigquery_api::JobStatistics::has_creation_time ( ) const
inline

Determine if the 'creationTime' attribute was set.

Returns
true if the 'creationTime' attribute was set.

◆ has_end_time()

bool google_bigquery_api::JobStatistics::has_end_time ( ) const
inline

Determine if the 'endTime' attribute was set.

Returns
true if the 'endTime' attribute was set.

◆ has_extract()

bool google_bigquery_api::JobStatistics::has_extract ( ) const
inline

Determine if the 'extract' attribute was set.

Returns
true if the 'extract' attribute was set.

◆ has_load()

bool google_bigquery_api::JobStatistics::has_load ( ) const
inline

Determine if the 'load' attribute was set.

Returns
true if the 'load' attribute was set.

◆ has_num_child_jobs()

bool google_bigquery_api::JobStatistics::has_num_child_jobs ( ) const
inline

Determine if the 'numChildJobs' attribute was set.

Returns
true if the 'numChildJobs' attribute was set.

◆ has_parent_job_id()

bool google_bigquery_api::JobStatistics::has_parent_job_id ( ) const
inline

Determine if the 'parentJobId' attribute was set.

Returns
true if the 'parentJobId' attribute was set.

◆ has_query()

bool google_bigquery_api::JobStatistics::has_query ( ) const
inline

Determine if the 'query' attribute was set.

Returns
true if the 'query' attribute was set.

◆ has_quota_deferments()

bool google_bigquery_api::JobStatistics::has_quota_deferments ( ) const
inline

Determine if the 'quotaDeferments' attribute was set.

Returns
true if the 'quotaDeferments' attribute was set.

◆ has_reservation_id()

bool google_bigquery_api::JobStatistics::has_reservation_id ( ) const
inline

Determine if the 'reservation_id' attribute was set.

Returns
true if the 'reservation_id' attribute was set.

◆ has_reservation_usage()

bool google_bigquery_api::JobStatistics::has_reservation_usage ( ) const
inline

Determine if the 'reservationUsage' attribute was set.

Returns
true if the 'reservationUsage' attribute was set.

◆ has_script_statistics()

bool google_bigquery_api::JobStatistics::has_script_statistics ( ) const
inline

Determine if the 'scriptStatistics' attribute was set.

Returns
true if the 'scriptStatistics' attribute was set.

◆ has_start_time()

bool google_bigquery_api::JobStatistics::has_start_time ( ) const
inline

Determine if the 'startTime' attribute was set.

Returns
true if the 'startTime' attribute was set.

◆ has_total_bytes_processed()

bool google_bigquery_api::JobStatistics::has_total_bytes_processed ( ) const
inline

Determine if the 'totalBytesProcessed' attribute was set.

Returns
true if the 'totalBytesProcessed' attribute was set.

◆ has_total_slot_ms()

bool google_bigquery_api::JobStatistics::has_total_slot_ms ( ) const
inline

Determine if the 'totalSlotMs' attribute was set.

Returns
true if the 'totalSlotMs' attribute was set.

◆ mutable_extract()

JobStatistics4 google_bigquery_api::JobStatistics::mutable_extract ( )

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

[Output-only] Statistics for an extract job.

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

◆ mutable_load()

JobStatistics3 google_bigquery_api::JobStatistics::mutable_load ( )

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

[Output-only] Statistics for a load job.

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

◆ mutable_query()

JobStatistics2 google_bigquery_api::JobStatistics::mutable_query ( )

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

[Output-only] Statistics for a query job.

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

◆ mutable_quotaDeferments()

client::JsonCppArray<string > google_bigquery_api::JobStatistics::mutable_quotaDeferments ( )
inline

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

[Output-only] Quotas which delayed this job's start time.

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

◆ mutable_reservationUsage()

client::JsonCppArray<JobStatisticsReservationUsage > google_bigquery_api::JobStatistics::mutable_reservationUsage ( )
inline

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

[Output-only] Job resource usage breakdown by reservation.

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

◆ mutable_scriptStatistics()

ScriptStatistics google_bigquery_api::JobStatistics::mutable_scriptStatistics ( )

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

[Output-only] Statistics for a child job of a script.

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

◆ New()

JobStatistics * google_bigquery_api::JobStatistics::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_completion_ratio()

void google_bigquery_api::JobStatistics::set_completion_ratio ( double  value)
inline

Change the 'completionRatio' attribute.

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

Parameters
[in]valueThe new value.

◆ set_creation_time()

void google_bigquery_api::JobStatistics::set_creation_time ( int64  value)
inline

Change the 'creationTime' attribute.

[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

Parameters
[in]valueThe new value.

◆ set_end_time()

void google_bigquery_api::JobStatistics::set_end_time ( int64  value)
inline

Change the 'endTime' attribute.

[Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.

Parameters
[in]valueThe new value.

◆ set_num_child_jobs()

void google_bigquery_api::JobStatistics::set_num_child_jobs ( int64  value)
inline

Change the 'numChildJobs' attribute.

[Output-only] Number of child jobs executed.

Parameters
[in]valueThe new value.

◆ set_parent_job_id()

void google_bigquery_api::JobStatistics::set_parent_job_id ( const StringPiece &  value)
inline

Change the 'parentJobId' attribute.

[Output-only] If this is a child job, the id of the parent.

Parameters
[in]valueThe new value.

◆ set_reservation_id()

void google_bigquery_api::JobStatistics::set_reservation_id ( const StringPiece &  value)
inline

Change the 'reservation_id' attribute.

[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.

Parameters
[in]valueThe new value.

◆ set_start_time()

void google_bigquery_api::JobStatistics::set_start_time ( int64  value)
inline

Change the 'startTime' attribute.

[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.

Parameters
[in]valueThe new value.

◆ set_total_bytes_processed()

void google_bigquery_api::JobStatistics::set_total_bytes_processed ( int64  value)
inline

Change the 'totalBytesProcessed' attribute.

[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

Parameters
[in]valueThe new value.

◆ set_total_slot_ms()

void google_bigquery_api::JobStatistics::set_total_slot_ms ( int64  value)
inline

Change the 'totalSlotMs' attribute.

[Output-only] Slot-milliseconds for the job.

Parameters
[in]valueThe new value.

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