Class: OCI::DataScience::Models::PipelineRunSummary

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

Overview

Summary of the 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 = {}) ⇒ PipelineRunSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :time_accepted (DateTime) —

    The value to assign to the #time_accepted property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :created_by (String) —

    The value to assign to the #created_by property

  • :project_id (String) —

    The value to assign to the #project_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :pipeline_id (String) —

    The value to assign to the #pipeline_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 157

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.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.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.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_summary.rb', line 54

def compartment_id
  @compartment_id
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_summary.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>>) 


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

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


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

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


70
71
72
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The state of the pipeline run.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#pipeline_id ⇒ String

[Required] The OCID of the pipeline for which pipeline run is created.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/data_science/models/pipeline_run_summary.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_summary.rb', line 50

def project_id
  @project_id
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>>) 


88
89
90
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 88

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


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

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


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'pipeline_id': :'pipelineId',
    'display_name': :'displayName',
    '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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'project_id': :'String',
    'compartment_id': :'String',
    'pipeline_id': :'String',
    'display_name': :'String',
    '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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 270

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 &&
    time_updated == other.time_updated &&
    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 &&
    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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 314

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


294
295
296
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 294

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 303

def hash
  [id, time_accepted, time_started, time_finished, time_updated, created_by, project_id, compartment_id, pipeline_id, display_name, 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



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/data_science/models/pipeline_run_summary.rb', line 347

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



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

def to_s
  to_hash.to_s
end