Class: Google::Apis::BigqueryV2::Model

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Model

Returns a new instance of Model.



4433
4434
4435
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4433

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_time ⇒ Fixnum

Output only. The time when this model was created, in millisecs since the epoch. Corresponds to the JSON property creationTime

Returns:

  • (Fixnum) 


4351
4352
4353
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4351

def creation_time
  @creation_time
end

#description ⇒ String

Optional. A user-friendly description of this model. Corresponds to the JSON property description

Returns:

  • (String) 


4356
4357
4358
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4356

def description
  @description
end

#encryption_configuration ⇒ Google::Apis::BigqueryV2::EncryptionConfiguration

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. Corresponds to the JSON property encryptionConfiguration

Returns:



4364
4365
4366
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4364

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

Output only. A hash of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


4369
4370
4371
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4369

def etag
  @etag
end

#expiration_time ⇒ Fixnum

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. Corresponds to the JSON property expirationTime

Returns:

  • (Fixnum) 


4378
4379
4380
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4378

def expiration_time
  @expiration_time
end

#feature_columns ⇒ Array<Google::Apis::BigqueryV2::StandardSqlField>

Output only. Input feature columns that were used to train this model. Corresponds to the JSON property featureColumns

Returns:



4383
4384
4385
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4383

def feature_columns
  @feature_columns
end

#friendly_name ⇒ String

Optional. A descriptive name for this model. Corresponds to the JSON property friendlyName

Returns:

  • (String) 


4388
4389
4390
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4388

def friendly_name
  @friendly_name
end

#label_columns ⇒ Array<Google::Apis::BigqueryV2::StandardSqlField>

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

Returns:



4394
4395
4396
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4394

def label_columns
  @label_columns
end

#labels ⇒ Hash<String,String>

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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4403
4404
4405
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4403

def labels
  @labels
end

#last_modified_time ⇒ Fixnum

Output only. The time when this model was last modified, in millisecs since the epoch. Corresponds to the JSON property lastModifiedTime

Returns:

  • (Fixnum) 


4409
4410
4411
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4409

def last_modified_time
  @last_modified_time
end

#location ⇒ String

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

Returns:

  • (String) 


4415
4416
4417
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4415

def location
  @location
end

#model_reference ⇒ Google::Apis::BigqueryV2::ModelReference

Required. Unique identifier for this model. Corresponds to the JSON property modelReference

Returns:



4420
4421
4422
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4420

def model_reference
  @model_reference
end

#model_type ⇒ String

Output only. Type of the model resource. Corresponds to the JSON property modelType

Returns:

  • (String) 


4425
4426
4427
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4425

def model_type
  @model_type
end

#training_runs ⇒ Array<Google::Apis::BigqueryV2::TrainingRun>

Output only. Information for all training runs in increasing order of start_time. Corresponds to the JSON property trainingRuns

Returns:



4431
4432
4433
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4431

def training_runs
  @training_runs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4438

def update!(**args)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @description = args[:description] if args.key?(:description)
  @encryption_configuration = args[:encryption_configuration] if args.key?(:encryption_configuration)
  @etag = args[:etag] if args.key?(:etag)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @feature_columns = args[:feature_columns] if args.key?(:feature_columns)
  @friendly_name = args[:friendly_name] if args.key?(:friendly_name)
  @label_columns = args[:label_columns] if args.key?(:label_columns)
  @labels = args[:labels] if args.key?(:labels)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @location = args[:location] if args.key?(:location)
  @model_reference = args[:model_reference] if args.key?(:model_reference)
  @model_type = args[:model_type] if args.key?(:model_type)
  @training_runs = args[:training_runs] if args.key?(:training_runs)
end