Class: OCI::DataScience::Models::Pipeline

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

Overview

A Pipeline to orchestrate and execute machine learning workflows.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ Pipeline

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/data_science/models/pipeline.rb', line 169

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_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

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

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

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

  self.infrastructure_configuration_details = attributes[:'infrastructureConfigurationDetails'] if attributes[:'infrastructureConfigurationDetails']

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

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

  self.step_details = attributes[:'stepDetails'] if attributes[:'stepDetails']

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

  self.step_details = attributes[:'step_details'] if attributes[:'step_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']

  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.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_science/models/pipeline.rb', line 47

def compartment_id
  @compartment_id
end

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

Returns:



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

def configuration_details
  @configuration_details
end

#created_by ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_science/models/pipeline.rb', line 39

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the pipeline.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/data_science/models/pipeline.rb', line 55

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_science/models/pipeline.rb', line 51

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the pipeline.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_science/models/pipeline.rb', line 23

def id
  @id
end

#infrastructure_configuration_details ⇒ OCI::DataScience::Models::PipelineInfrastructureConfigurationDetails

Returns:



64
65
66
 
# File 'lib/oci/data_science/models/pipeline.rb', line 64

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


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the pipeline.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/data_science/models/pipeline.rb', line 72

def lifecycle_state
  @lifecycle_state
end

#log_configuration_details ⇒ OCI::DataScience::Models::PipelineLogConfigurationDetails

Returns:



61
62
63
 
# File 'lib/oci/data_science/models/pipeline.rb', line 61

def log_configuration_details
  @log_configuration_details
end

#project_id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_science/models/pipeline.rb', line 43

def project_id
  @project_id
end

#step_details ⇒ Array<OCI::DataScience::Models::PipelineStepDetails>

[Required] Array of step details for each step.

Returns:



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

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


94
95
96
 
# File 'lib/oci/data_science/models/pipeline.rb', line 94

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/oci/data_science/models/pipeline.rb', line 29

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the resource was updated in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/data_science/models/pipeline.rb', line 35

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'configuration_details': :'configurationDetails',
    'log_configuration_details': :'logConfigurationDetails',
    'infrastructure_configuration_details': :'infrastructureConfigurationDetails',
    'step_details': :'stepDetails',
    '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.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/data_science/models/pipeline.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'project_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'configuration_details': :'OCI::DataScience::Models::PipelineConfigurationDetails',
    'log_configuration_details': :'OCI::DataScience::Models::PipelineLogConfigurationDetails',
    'infrastructure_configuration_details': :'OCI::DataScience::Models::PipelineInfrastructureConfigurationDetails',
    'step_details': :'Array<OCI::DataScience::Models::PipelineStepDetails>',
    '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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/data_science/models/pipeline.rb', line 290

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

  self.class == other.class &&
    id == other.id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by == other.created_by &&
    project_id == other.project_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    configuration_details == other.configuration_details &&
    log_configuration_details == other.log_configuration_details &&
    infrastructure_configuration_details == other.infrastructure_configuration_details &&
    step_details == other.step_details &&
    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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/data_science/models/pipeline.rb', line 336

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


316
317
318
 
# File 'lib/oci/data_science/models/pipeline.rb', line 316

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



325
326
327
 
# File 'lib/oci/data_science/models/pipeline.rb', line 325

def hash
  [id, time_created, time_updated, created_by, project_id, compartment_id, display_name, description, configuration_details, log_configuration_details, infrastructure_configuration_details, step_details, 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



369
370
371
372
373
374
375
376
377
378
 
# File 'lib/oci/data_science/models/pipeline.rb', line 369

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



363
364
365
 
# File 'lib/oci/data_science/models/pipeline.rb', line 363

def to_s
  to_hash.to_s
end