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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Model

Returns a new instance of Model



3715
3716
3717
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3715

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) 


3633
3634
3635
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3633

def creation_time
  @creation_time
end

#description ⇒ String

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

Returns:

  • (String) 


3638
3639
3640
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3638

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

Returns:



3645
3646
3647
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3645

def encryption_configuration
  @encryption_configuration
end

#etag ⇒ String

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

Returns:

  • (String) 


3650
3651
3652
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3650

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) 


3659
3660
3661
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3659

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:



3664
3665
3666
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3664

def feature_columns
  @feature_columns
end

#friendly_name ⇒ String

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

Returns:

  • (String) 


3669
3670
3671
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3669

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:



3675
3676
3677
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3675

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>) 


3685
3686
3687
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3685

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) 


3691
3692
3693
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3691

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) 


3697
3698
3699
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3697

def location
  @location
end

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

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

Returns:



3702
3703
3704
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3702

def model_reference
  @model_reference
end

#model_type ⇒ String

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

Returns:

  • (String) 


3707
3708
3709
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3707

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:



3713
3714
3715
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3713

def training_runs
  @training_runs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3720

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