Class: OCI::DataScience::Models::PipelineRun

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

Overview

Description of PipelineRun.

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_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ PipelineRun

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 195

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_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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.pipeline_id = attributes[:'pipelineId'] if attributes[:'pipelineId']

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

  self.pipeline_id = attributes[:'pipeline_id'] if attributes[:'pipeline_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.configuration_details = attributes[:'configurationDetails'] if attributes[:'configurationDetails']

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

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

  self.configuration_override_details = attributes[:'configurationOverrideDetails'] if attributes[:'configurationOverrideDetails']

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

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

  self.log_configuration_override_details = attributes[:'logConfigurationOverrideDetails'] if attributes[:'logConfigurationOverrideDetails']

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

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

  self.step_override_details = attributes[:'stepOverrideDetails'] if attributes[:'stepOverrideDetails']

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

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

  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.step_runs = attributes[:'stepRuns'] if attributes[:'stepRuns']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#configuration_details ⇒ OCI::DataScience::Models::PipelineConfigurationDetails

Returns:



65
66
67
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 65

def configuration_details
  @configuration_details
end

#configuration_override_details ⇒ OCI::DataScience::Models::PipelineConfigurationDetails

Returns:



68
69
70
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 68

def configuration_override_details
  @configuration_override_details
end

#created_by ⇒ String

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

Returns:

  • (String) 


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

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


102
103
104
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 102

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly display name for the resource.

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the pipeline run.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the pipeline run.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 86

def lifecycle_state
  @lifecycle_state
end

#log_configuration_override_details ⇒ OCI::DataScience::Models::PipelineLogConfigurationDetails

Returns:



71
72
73
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 71

def log_configuration_override_details
  @log_configuration_override_details
end

#log_details ⇒ OCI::DataScience::Models::PipelineRunLogDetails

Returns:



78
79
80
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 78

def log_details
  @log_details
end

#pipeline_id ⇒ String

[Required] The OCID of the pipeline.

Returns:

  • (String) 


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

def pipeline_id
  @pipeline_id
end

#project_id ⇒ String

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

Returns:

  • (String) 


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

def project_id
  @project_id
end

#step_override_details ⇒ Array<OCI::DataScience::Models::PipelineStepOverrideDetails>

Array of step override details. Only Step Configuration is allowed to be overridden.

Returns:



75
76
77
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 75

def step_override_details
  @step_override_details
end

#step_runs ⇒ Array<OCI::DataScience::Models::PipelineStepRun>

[Required] Array of StepRun object for each step.

Returns:



82
83
84
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 82

def step_runs
  @step_runs
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


108
109
110
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 108

def system_tags
  @system_tags
end

#time_accepted ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_started
  @time_started
end

#time_updated ⇒ DateTime

The date and time the pipeline run was updated in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_updated': :'timeUpdated',
    'time_finished': :'timeFinished',
    'created_by': :'createdBy',
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'pipeline_id': :'pipelineId',
    'display_name': :'displayName',
    'configuration_details': :'configurationDetails',
    'configuration_override_details': :'configurationOverrideDetails',
    'log_configuration_override_details': :'logConfigurationOverrideDetails',
    'step_override_details': :'stepOverrideDetails',
    'log_details': :'logDetails',
    'step_runs': :'stepRuns',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_updated': :'DateTime',
    'time_finished': :'DateTime',
    'created_by': :'String',
    'project_id': :'String',
    'compartment_id': :'String',
    'pipeline_id': :'String',
    'display_name': :'String',
    'configuration_details': :'OCI::DataScience::Models::PipelineConfigurationDetails',
    'configuration_override_details': :'OCI::DataScience::Models::PipelineConfigurationDetails',
    'log_configuration_override_details': :'OCI::DataScience::Models::PipelineLogConfigurationDetails',
    'step_override_details': :'Array<OCI::DataScience::Models::PipelineStepOverrideDetails>',
    'log_details': :'OCI::DataScience::Models::PipelineRunLogDetails',
    'step_runs': :'Array<OCI::DataScience::Models::PipelineStepRun>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 344

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_updated == other.time_updated &&
    time_finished == other.time_finished &&
    created_by == other.created_by &&
    project_id == other.project_id &&
    compartment_id == other.compartment_id &&
    pipeline_id == other.pipeline_id &&
    display_name == other.display_name &&
    configuration_details == other.configuration_details &&
    configuration_override_details == other.configuration_override_details &&
    log_configuration_override_details == other.log_configuration_override_details &&
    step_override_details == other.step_override_details &&
    log_details == other.log_details &&
    step_runs == other.step_runs &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 394

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


374
375
376
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 374

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



383
384
385
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 383

def hash
  [id, time_accepted, time_started, time_updated, time_finished, created_by, project_id, compartment_id, pipeline_id, display_name, configuration_details, configuration_override_details, log_configuration_override_details, step_override_details, log_details, step_runs, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 427

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



421
422
423
 
# File 'lib/oci/data_science/models/pipeline_run.rb', line 421

def to_s
  to_hash.to_s
end