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.


4176
4177
4178
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4176

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

Instance Attribute Details

#creation_timeFixnum

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

Returns:

  • (Fixnum)

4094
4095
4096
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4094

def creation_time
  @creation_time
end

#descriptionString

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

Returns:

  • (String)

4099
4100
4101
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4099

def description
  @description
end

#encryption_configurationGoogle::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


4107
4108
4109
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4107

def encryption_configuration
  @encryption_configuration
end

#etagString

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

Returns:

  • (String)

4112
4113
4114
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4112

def etag
  @etag
end

#expiration_timeFixnum

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)

4121
4122
4123
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4121

def expiration_time
  @expiration_time
end

#feature_columnsArray<Google::Apis::BigqueryV2::StandardSqlField>

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


4126
4127
4128
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4126

def feature_columns
  @feature_columns
end

#friendly_nameString

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

Returns:

  • (String)

4131
4132
4133
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4131

def friendly_name
  @friendly_name
end

#label_columnsArray<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


4137
4138
4139
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4137

def label_columns
  @label_columns
end

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

4146
4147
4148
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4146

def labels
  @labels
end

#last_modified_timeFixnum

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

Returns:

  • (Fixnum)

4152
4153
4154
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4152

def last_modified_time
  @last_modified_time
end

#locationString

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

Returns:

  • (String)

4158
4159
4160
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4158

def location
  @location
end

#model_referenceGoogle::Apis::BigqueryV2::ModelReference

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


4163
4164
4165
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4163

def model_reference
  @model_reference
end

#model_typeString

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

Returns:

  • (String)

4168
4169
4170
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4168

def model_type
  @model_type
end

#training_runsArray<Google::Apis::BigqueryV2::TrainingRun>

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


4174
4175
4176
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4174

def training_runs
  @training_runs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4181

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