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

#include <job_configuration.h>

Inheritance diagram for google_bigquery_api::JobConfiguration:

Public Member Functions

 JobConfiguration (const Json::Value &storage)
 
 JobConfiguration (Json::Value *storage)
 
virtual ~JobConfiguration ()
 
const StringPiece GetTypeName () const
 
bool has_copy () const
 
void clear_copy ()
 
const JobConfigurationTableCopy get_copy () const
 
JobConfigurationTableCopy mutable_copy ()
 
bool has_dry_run () const
 
void clear_dry_run ()
 
bool get_dry_run () const
 
void set_dry_run (bool value)
 
bool has_extract () const
 
void clear_extract ()
 
const JobConfigurationExtract get_extract () const
 
JobConfigurationExtract mutable_extract ()
 
bool has_job_timeout_ms () const
 
void clear_job_timeout_ms ()
 
int64 get_job_timeout_ms () const
 
void set_job_timeout_ms (int64 value)
 
bool has_job_type () const
 
void clear_job_type ()
 
const StringPiece get_job_type () const
 
void set_job_type (const StringPiece &value)
 
bool has_labels () const
 
void clear_labels ()
 
const client::JsonCppAssociativeArray< string > get_labels () const
 
client::JsonCppAssociativeArray< string > mutable_labels ()
 
bool has_load () const
 
void clear_load ()
 
const JobConfigurationLoad get_load () const
 
JobConfigurationLoad mutable_load ()
 
bool has_query () const
 
void clear_query ()
 
const JobConfigurationQuery get_query () const
 
JobConfigurationQuery mutable_query ()
 

Static Public Member Functions

static JobConfigurationNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ JobConfiguration() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ JobConfiguration() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~JobConfiguration()

google_bigquery_api::JobConfiguration::~JobConfiguration ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_copy()

void google_bigquery_api::JobConfiguration::clear_copy ( )
inline

Clears the 'copy' attribute.

◆ clear_dry_run()

void google_bigquery_api::JobConfiguration::clear_dry_run ( )
inline

Clears the 'dryRun' attribute.

◆ clear_extract()

void google_bigquery_api::JobConfiguration::clear_extract ( )
inline

Clears the 'extract' attribute.

◆ clear_job_timeout_ms()

void google_bigquery_api::JobConfiguration::clear_job_timeout_ms ( )
inline

Clears the 'jobTimeoutMs' attribute.

◆ clear_job_type()

void google_bigquery_api::JobConfiguration::clear_job_type ( )
inline

Clears the 'jobType' attribute.

◆ clear_labels()

void google_bigquery_api::JobConfiguration::clear_labels ( )
inline

Clears the 'labels' attribute.

◆ clear_load()

void google_bigquery_api::JobConfiguration::clear_load ( )
inline

Clears the 'load' attribute.

◆ clear_query()

void google_bigquery_api::JobConfiguration::clear_query ( )
inline

Clears the 'query' attribute.

◆ get_copy()

const JobConfigurationTableCopy google_bigquery_api::JobConfiguration::get_copy ( ) const

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

◆ get_dry_run()

bool google_bigquery_api::JobConfiguration::get_dry_run ( ) const
inline

Get the value of the 'dryRun' attribute.

◆ get_extract()

const JobConfigurationExtract google_bigquery_api::JobConfiguration::get_extract ( ) const

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

◆ get_job_timeout_ms()

int64 google_bigquery_api::JobConfiguration::get_job_timeout_ms ( ) const
inline

Get the value of the 'jobTimeoutMs' attribute.

◆ get_job_type()

const StringPiece google_bigquery_api::JobConfiguration::get_job_type ( ) const
inline

Get the value of the 'jobType' attribute.

◆ get_labels()

const client::JsonCppAssociativeArray<string > google_bigquery_api::JobConfiguration::get_labels ( ) const
inline

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

◆ get_load()

const JobConfigurationLoad google_bigquery_api::JobConfiguration::get_load ( ) const

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

◆ get_query()

const JobConfigurationQuery google_bigquery_api::JobConfiguration::get_query ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::JobConfiguration

◆ has_copy()

bool google_bigquery_api::JobConfiguration::has_copy ( ) const
inline

Determine if the 'copy' attribute was set.

Returns
true if the 'copy' attribute was set.

◆ has_dry_run()

bool google_bigquery_api::JobConfiguration::has_dry_run ( ) const
inline

Determine if the 'dryRun' attribute was set.

Returns
true if the 'dryRun' attribute was set.

◆ has_extract()

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

Determine if the 'extract' attribute was set.

Returns
true if the 'extract' attribute was set.

◆ has_job_timeout_ms()

bool google_bigquery_api::JobConfiguration::has_job_timeout_ms ( ) const
inline

Determine if the 'jobTimeoutMs' attribute was set.

Returns
true if the 'jobTimeoutMs' attribute was set.

◆ has_job_type()

bool google_bigquery_api::JobConfiguration::has_job_type ( ) const
inline

Determine if the 'jobType' attribute was set.

Returns
true if the 'jobType' attribute was set.

◆ has_labels()

bool google_bigquery_api::JobConfiguration::has_labels ( ) const
inline

Determine if the 'labels' attribute was set.

Returns
true if the 'labels' attribute was set.

◆ has_load()

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

Determine if the 'load' attribute was set.

Returns
true if the 'load' attribute was set.

◆ has_query()

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

Determine if the 'query' attribute was set.

Returns
true if the 'query' attribute was set.

◆ mutable_copy()

JobConfigurationTableCopy google_bigquery_api::JobConfiguration::mutable_copy ( )

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

[Pick one] Copies a table.

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

◆ mutable_extract()

JobConfigurationExtract google_bigquery_api::JobConfiguration::mutable_extract ( )

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

[Pick one] Configures an extract job.

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

◆ mutable_labels()

client::JsonCppAssociativeArray<string > google_bigquery_api::JobConfiguration::mutable_labels ( )
inline

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

The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

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

◆ mutable_load()

JobConfigurationLoad google_bigquery_api::JobConfiguration::mutable_load ( )

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

[Pick one] Configures a load job.

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

◆ mutable_query()

JobConfigurationQuery google_bigquery_api::JobConfiguration::mutable_query ( )

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

[Pick one] Configures a query job.

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

◆ New()

JobConfiguration * google_bigquery_api::JobConfiguration::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_dry_run()

void google_bigquery_api::JobConfiguration::set_dry_run ( bool  value)
inline

Change the 'dryRun' attribute.

[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.

Parameters
[in]valueThe new value.

◆ set_job_timeout_ms()

void google_bigquery_api::JobConfiguration::set_job_timeout_ms ( int64  value)
inline

Change the 'jobTimeoutMs' attribute.

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

Parameters
[in]valueThe new value.

◆ set_job_type()

void google_bigquery_api::JobConfiguration::set_job_type ( const StringPiece &  value)
inline

Change the 'jobType' attribute.

[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

Parameters
[in]valueThe new value.

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