Class: OCI::DataScience::Models::JobRun

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/job_run.rb

Overview

A job run.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobRun

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/data_science/models/job_run.rb', line 174

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

  raise 'You cannot provide both :timeAccepted and :time_accepted' if attributes.key?(:'timeAccepted') && attributes.key?(:'time_accepted')

  self.time_accepted = attributes[:'time_accepted'] if attributes[:'time_accepted']

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

  raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started')

  self.time_started = attributes[:'time_started'] if attributes[:'time_started']

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

  raise 'You cannot provide both :timeFinished and :time_finished' if attributes.key?(:'timeFinished') && attributes.key?(:'time_finished')

  self.time_finished = attributes[:'time_finished'] if attributes[:'time_finished']

  self.created_by = attributes[:'createdBy'] if attributes[:'createdBy']

  raise 'You cannot provide both :createdBy and :created_by' if attributes.key?(:'createdBy') && attributes.key?(:'created_by')

  self.created_by = attributes[:'created_by'] if attributes[:'created_by']

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

  raise 'You cannot provide both :projectId and :project_id' if attributes.key?(:'projectId') && attributes.key?(:'project_id')

  self.project_id = attributes[:'project_id'] if attributes[:'project_id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.job_id = attributes[:'jobId'] if attributes[:'jobId']

  raise 'You cannot provide both :jobId and :job_id' if attributes.key?(:'jobId') && attributes.key?(:'job_id')

  self.job_id = attributes[:'job_id'] if attributes[:'job_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.job_configuration_override_details = attributes[:'jobConfigurationOverrideDetails'] if attributes[:'jobConfigurationOverrideDetails']

  raise 'You cannot provide both :jobConfigurationOverrideDetails and :job_configuration_override_details' if attributes.key?(:'jobConfigurationOverrideDetails') && attributes.key?(:'job_configuration_override_details')

  self.job_configuration_override_details = attributes[:'job_configuration_override_details'] if attributes[:'job_configuration_override_details']

  self.job_infrastructure_configuration_details = attributes[:'jobInfrastructureConfigurationDetails'] if attributes[:'jobInfrastructureConfigurationDetails']

  raise 'You cannot provide both :jobInfrastructureConfigurationDetails and :job_infrastructure_configuration_details' if attributes.key?(:'jobInfrastructureConfigurationDetails') && attributes.key?(:'job_infrastructure_configuration_details')

  self.job_infrastructure_configuration_details = attributes[:'job_infrastructure_configuration_details'] if attributes[:'job_infrastructure_configuration_details']

  self.job_log_configuration_override_details = attributes[:'jobLogConfigurationOverrideDetails'] if attributes[:'jobLogConfigurationOverrideDetails']

  raise 'You cannot provide both :jobLogConfigurationOverrideDetails and :job_log_configuration_override_details' if attributes.key?(:'jobLogConfigurationOverrideDetails') && attributes.key?(:'job_log_configuration_override_details')

  self.job_log_configuration_override_details = attributes[:'job_log_configuration_override_details'] if attributes[:'job_log_configuration_override_details']

  self.job_storage_mount_configuration_details_list = attributes[:'jobStorageMountConfigurationDetailsList'] if attributes[:'jobStorageMountConfigurationDetailsList']

  raise 'You cannot provide both :jobStorageMountConfigurationDetailsList and :job_storage_mount_configuration_details_list' if attributes.key?(:'jobStorageMountConfigurationDetailsList') && attributes.key?(:'job_storage_mount_configuration_details_list')

  self.job_storage_mount_configuration_details_list = attributes[:'job_storage_mount_configuration_details_list'] if attributes[:'job_storage_mount_configuration_details_list']

  self.log_details = attributes[:'logDetails'] if attributes[:'logDetails']

  raise 'You cannot provide both :logDetails and :log_details' if attributes.key?(:'logDetails') && attributes.key?(:'log_details')

  self.log_details = attributes[:'log_details'] if attributes[:'log_details']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create the job.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/data_science/models/job_run.rb', line 50

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] The OCID of the user who created the job run.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_science/models/job_run.rb', line 42

def created_by
  @created_by
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


96
97
98
 
# File 'lib/oci/data_science/models/job_run.rb', line 96

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly display name for the resource.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/data_science/models/job_run.rb', line 58

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


90
91
92
 
# File 'lib/oci/data_science/models/job_run.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the job run.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_science/models/job_run.rb', line 26

def id
  @id
end

#job_configuration_override_details ⇒ OCI::DataScience::Models::JobConfigurationDetails

This attribute is required.

Returns:



62
63
64
 
# File 'lib/oci/data_science/models/job_run.rb', line 62

def job_configuration_override_details
  @job_configuration_override_details
end

#job_id ⇒ String

[Required] The OCID of the job run.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_science/models/job_run.rb', line 54

def job_id
  @job_id
end

#job_infrastructure_configuration_details ⇒ OCI::DataScience::Models::JobInfrastructureConfigurationDetails

This attribute is required.

Returns:



66
67
68
 
# File 'lib/oci/data_science/models/job_run.rb', line 66

def job_infrastructure_configuration_details
  @job_infrastructure_configuration_details
end

#job_log_configuration_override_details ⇒ OCI::DataScience::Models::JobLogConfigurationDetails

Returns:



69
70
71
 
# File 'lib/oci/data_science/models/job_run.rb', line 69

def job_log_configuration_override_details
  @job_log_configuration_override_details
end

#job_storage_mount_configuration_details_list ⇒ Array<OCI::DataScience::Models::StorageMountConfigurationDetails>

Collection of JobStorageMountConfigurationDetails.

Returns:



73
74
75
 
# File 'lib/oci/data_science/models/job_run.rb', line 73

def job_storage_mount_configuration_details_list
  @job_storage_mount_configuration_details_list
end

#lifecycle_details ⇒ String

Details of the state of the job run.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/data_science/models/job_run.rb', line 84

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The state of the job run.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/data_science/models/job_run.rb', line 80

def lifecycle_state
  @lifecycle_state
end

#log_details ⇒ OCI::DataScience::Models::JobRunLogDetails

Returns:



76
77
78
 
# File 'lib/oci/data_science/models/job_run.rb', line 76

def log_details
  @log_details
end

#project_id ⇒ String

[Required] The OCID of the project to associate the job with.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_science/models/job_run.rb', line 46

def project_id
  @project_id
end

#time_accepted ⇒ DateTime

[Required] The date and time the job run was accepted in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


30
31
32
 
# File 'lib/oci/data_science/models/job_run.rb', line 30

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time the job run request was finished in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/data_science/models/job_run.rb', line 38

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The date and time the job run request was started in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


34
35
36
 
# File 'lib/oci/data_science/models/job_run.rb', line 34

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/data_science/models/job_run.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'created_by': :'createdBy',
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'job_id': :'jobId',
    'display_name': :'displayName',
    'job_configuration_override_details': :'jobConfigurationOverrideDetails',
    'job_infrastructure_configuration_details': :'jobInfrastructureConfigurationDetails',
    'job_log_configuration_override_details': :'jobLogConfigurationOverrideDetails',
    'job_storage_mount_configuration_details_list': :'jobStorageMountConfigurationDetailsList',
    'log_details': :'logDetails',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/data_science/models/job_run.rb', line 125

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'created_by': :'String',
    'project_id': :'String',
    'compartment_id': :'String',
    'job_id': :'String',
    'display_name': :'String',
    'job_configuration_override_details': :'OCI::DataScience::Models::JobConfigurationDetails',
    'job_infrastructure_configuration_details': :'OCI::DataScience::Models::JobInfrastructureConfigurationDetails',
    'job_log_configuration_override_details': :'OCI::DataScience::Models::JobLogConfigurationDetails',
    'job_storage_mount_configuration_details_list': :'Array<OCI::DataScience::Models::StorageMountConfigurationDetails>',
    'log_details': :'OCI::DataScience::Models::JobRunLogDetails',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/oci/data_science/models/job_run.rb', line 305

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    created_by == other.created_by &&
    project_id == other.project_id &&
    compartment_id == other.compartment_id &&
    job_id == other.job_id &&
    display_name == other.display_name &&
    job_configuration_override_details == other.job_configuration_override_details &&
    job_infrastructure_configuration_details == other.job_infrastructure_configuration_details &&
    job_log_configuration_override_details == other.job_log_configuration_override_details &&
    job_storage_mount_configuration_details_list == other.job_storage_mount_configuration_details_list &&
    log_details == other.log_details &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/data_science/models/job_run.rb', line 352

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


332
333
334
 
# File 'lib/oci/data_science/models/job_run.rb', line 332

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



341
342
343
 
# File 'lib/oci/data_science/models/job_run.rb', line 341

def hash
  [id, time_accepted, time_started, time_finished, created_by, project_id, compartment_id, job_id, display_name, job_configuration_override_details, job_infrastructure_configuration_details, job_log_configuration_override_details, job_storage_mount_configuration_details_list, log_details, lifecycle_state, lifecycle_details, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



385
386
387
388
389
390
391
392
393
394
 
# File 'lib/oci/data_science/models/job_run.rb', line 385

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



379
380
381
 
# File 'lib/oci/data_science/models/job_run.rb', line 379

def to_s
  to_hash.to_s
end