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

#include <model.h>

Inheritance diagram for google_bigquery_api::Model:

Public Member Functions

 Model (const Json::Value &storage)
 
 Model (Json::Value *storage)
 
virtual ~Model ()
 
const StringPiece GetTypeName () const
 
bool has_creation_time () const
 
void clear_creation_time ()
 
int64 get_creation_time () const
 
void set_creation_time (int64 value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_encryption_configuration () const
 
void clear_encryption_configuration ()
 
const EncryptionConfiguration get_encryption_configuration () const
 
EncryptionConfiguration mutable_encryptionConfiguration ()
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_expiration_time () const
 
void clear_expiration_time ()
 
int64 get_expiration_time () const
 
void set_expiration_time (int64 value)
 
bool has_feature_columns () const
 
void clear_feature_columns ()
 
const client::JsonCppArray< StandardSqlFieldget_feature_columns () const
 
client::JsonCppArray< StandardSqlFieldmutable_featureColumns ()
 
bool has_friendly_name () const
 
void clear_friendly_name ()
 
const StringPiece get_friendly_name () const
 
void set_friendly_name (const StringPiece &value)
 
bool has_label_columns () const
 
void clear_label_columns ()
 
const client::JsonCppArray< StandardSqlFieldget_label_columns () const
 
client::JsonCppArray< StandardSqlFieldmutable_labelColumns ()
 
bool has_labels () const
 
void clear_labels ()
 
const client::JsonCppAssociativeArray< string > get_labels () const
 
client::JsonCppAssociativeArray< string > mutable_labels ()
 
bool has_last_modified_time () const
 
void clear_last_modified_time ()
 
int64 get_last_modified_time () const
 
void set_last_modified_time (int64 value)
 
bool has_location () const
 
void clear_location ()
 
const StringPiece get_location () const
 
void set_location (const StringPiece &value)
 
bool has_model_reference () const
 
void clear_model_reference ()
 
const ModelReference get_model_reference () const
 
ModelReference mutable_modelReference ()
 
bool has_model_type () const
 
void clear_model_type ()
 
const StringPiece get_model_type () const
 
void set_model_type (const StringPiece &value)
 
bool has_training_runs () const
 
void clear_training_runs ()
 
const client::JsonCppArray< TrainingRunget_training_runs () const
 
client::JsonCppArray< TrainingRunmutable_trainingRuns ()
 

Static Public Member Functions

static ModelNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ Model() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Model() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Model()

google_bigquery_api::Model::~Model ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_creation_time()

void google_bigquery_api::Model::clear_creation_time ( )
inline

Clears the 'creationTime' attribute.

◆ clear_description()

void google_bigquery_api::Model::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_encryption_configuration()

void google_bigquery_api::Model::clear_encryption_configuration ( )
inline

Clears the 'encryptionConfiguration' attribute.

◆ clear_etag()

void google_bigquery_api::Model::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_expiration_time()

void google_bigquery_api::Model::clear_expiration_time ( )
inline

Clears the 'expirationTime' attribute.

◆ clear_feature_columns()

void google_bigquery_api::Model::clear_feature_columns ( )
inline

Clears the 'featureColumns' attribute.

◆ clear_friendly_name()

void google_bigquery_api::Model::clear_friendly_name ( )
inline

Clears the 'friendlyName' attribute.

◆ clear_label_columns()

void google_bigquery_api::Model::clear_label_columns ( )
inline

Clears the 'labelColumns' attribute.

◆ clear_labels()

void google_bigquery_api::Model::clear_labels ( )
inline

Clears the 'labels' attribute.

◆ clear_last_modified_time()

void google_bigquery_api::Model::clear_last_modified_time ( )
inline

Clears the 'lastModifiedTime' attribute.

◆ clear_location()

void google_bigquery_api::Model::clear_location ( )
inline

Clears the 'location' attribute.

◆ clear_model_reference()

void google_bigquery_api::Model::clear_model_reference ( )
inline

Clears the 'modelReference' attribute.

◆ clear_model_type()

void google_bigquery_api::Model::clear_model_type ( )
inline

Clears the 'modelType' attribute.

◆ clear_training_runs()

void google_bigquery_api::Model::clear_training_runs ( )
inline

Clears the 'trainingRuns' attribute.

◆ get_creation_time()

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

Get the value of the 'creationTime' attribute.

◆ get_description()

const StringPiece google_bigquery_api::Model::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_encryption_configuration()

const EncryptionConfiguration google_bigquery_api::Model::get_encryption_configuration ( ) const

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

◆ get_etag()

const StringPiece google_bigquery_api::Model::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_expiration_time()

int64 google_bigquery_api::Model::get_expiration_time ( ) const
inline

Get the value of the 'expirationTime' attribute.

◆ get_feature_columns()

const client::JsonCppArray<StandardSqlField > google_bigquery_api::Model::get_feature_columns ( ) const

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

◆ get_friendly_name()

const StringPiece google_bigquery_api::Model::get_friendly_name ( ) const
inline

Get the value of the 'friendlyName' attribute.

◆ get_label_columns()

const client::JsonCppArray<StandardSqlField > google_bigquery_api::Model::get_label_columns ( ) const

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

◆ get_labels()

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

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

◆ get_last_modified_time()

int64 google_bigquery_api::Model::get_last_modified_time ( ) const
inline

Get the value of the 'lastModifiedTime' attribute.

◆ get_location()

const StringPiece google_bigquery_api::Model::get_location ( ) const
inline

Get the value of the 'location' attribute.

◆ get_model_reference()

const ModelReference google_bigquery_api::Model::get_model_reference ( ) const

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

◆ get_model_type()

const StringPiece google_bigquery_api::Model::get_model_type ( ) const
inline

Get the value of the 'modelType' attribute.

◆ get_training_runs()

const client::JsonCppArray<TrainingRun > google_bigquery_api::Model::get_training_runs ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::Model

◆ has_creation_time()

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

Determine if the 'creationTime' attribute was set.

Returns
true if the 'creationTime' attribute was set.

◆ has_description()

bool google_bigquery_api::Model::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_encryption_configuration()

bool google_bigquery_api::Model::has_encryption_configuration ( ) const
inline

Determine if the 'encryptionConfiguration' attribute was set.

Returns
true if the 'encryptionConfiguration' attribute was set.

◆ has_etag()

bool google_bigquery_api::Model::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_expiration_time()

bool google_bigquery_api::Model::has_expiration_time ( ) const
inline

Determine if the 'expirationTime' attribute was set.

Returns
true if the 'expirationTime' attribute was set.

◆ has_feature_columns()

bool google_bigquery_api::Model::has_feature_columns ( ) const
inline

Determine if the 'featureColumns' attribute was set.

Returns
true if the 'featureColumns' attribute was set.

◆ has_friendly_name()

bool google_bigquery_api::Model::has_friendly_name ( ) const
inline

Determine if the 'friendlyName' attribute was set.

Returns
true if the 'friendlyName' attribute was set.

◆ has_label_columns()

bool google_bigquery_api::Model::has_label_columns ( ) const
inline

Determine if the 'labelColumns' attribute was set.

Returns
true if the 'labelColumns' attribute was set.

◆ has_labels()

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

Determine if the 'labels' attribute was set.

Returns
true if the 'labels' attribute was set.

◆ has_last_modified_time()

bool google_bigquery_api::Model::has_last_modified_time ( ) const
inline

Determine if the 'lastModifiedTime' attribute was set.

Returns
true if the 'lastModifiedTime' attribute was set.

◆ has_location()

bool google_bigquery_api::Model::has_location ( ) const
inline

Determine if the 'location' attribute was set.

Returns
true if the 'location' attribute was set.

◆ has_model_reference()

bool google_bigquery_api::Model::has_model_reference ( ) const
inline

Determine if the 'modelReference' attribute was set.

Returns
true if the 'modelReference' attribute was set.

◆ has_model_type()

bool google_bigquery_api::Model::has_model_type ( ) const
inline

Determine if the 'modelType' attribute was set.

Returns
true if the 'modelType' attribute was set.

◆ has_training_runs()

bool google_bigquery_api::Model::has_training_runs ( ) const
inline

Determine if the 'trainingRuns' attribute was set.

Returns
true if the 'trainingRuns' attribute was set.

◆ mutable_encryptionConfiguration()

EncryptionConfiguration google_bigquery_api::Model::mutable_encryptionConfiguration ( )

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

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.

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

◆ mutable_featureColumns()

client::JsonCppArray<StandardSqlField > google_bigquery_api::Model::mutable_featureColumns ( )

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

Output only. Input feature columns that were used to train this model.

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

◆ mutable_labelColumns()

client::JsonCppArray<StandardSqlField > google_bigquery_api::Model::mutable_labelColumns ( )

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

Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.

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

◆ mutable_labels()

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

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

The labels associated with this model. You can use these to organize and group your models. 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_modelReference()

ModelReference google_bigquery_api::Model::mutable_modelReference ( )

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

Required. Unique identifier for this model.

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

◆ mutable_trainingRuns()

client::JsonCppArray<TrainingRun > google_bigquery_api::Model::mutable_trainingRuns ( )

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

Output only. Information for all training runs in increasing order of start_time.

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

◆ New()

Model * google_bigquery_api::Model::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_creation_time()

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

Change the 'creationTime' attribute.

Output only. The time when this model was created, in millisecs since the epoch.

Parameters
[in]valueThe new value.

◆ set_description()

void google_bigquery_api::Model::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

Optional. A user-friendly description of this model.

Parameters
[in]valueThe new value.

◆ set_etag()

void google_bigquery_api::Model::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

Output only. A hash of this resource.

Parameters
[in]valueThe new value.

◆ set_expiration_time()

void google_bigquery_api::Model::set_expiration_time ( int64  value)
inline

Change the 'expirationTime' attribute.

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.

Parameters
[in]valueThe new value.

◆ set_friendly_name()

void google_bigquery_api::Model::set_friendly_name ( const StringPiece &  value)
inline

Change the 'friendlyName' attribute.

Optional. A descriptive name for this model.

Parameters
[in]valueThe new value.

◆ set_last_modified_time()

void google_bigquery_api::Model::set_last_modified_time ( int64  value)
inline

Change the 'lastModifiedTime' attribute.

Output only. The time when this model was last modified, in millisecs since the epoch.

Parameters
[in]valueThe new value.

◆ set_location()

void google_bigquery_api::Model::set_location ( const StringPiece &  value)
inline

Change the 'location' attribute.

Output only. The geographic location where the model resides. This value is inherited from the dataset.

Parameters
[in]valueThe new value.

◆ set_model_type()

void google_bigquery_api::Model::set_model_type ( const StringPiece &  value)
inline

Change the 'modelType' attribute.

Output only. Type of the model resource.

Parameters
[in]valueThe new value.

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