Class: OCI::Dif::Models::Stack

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dif/models/stack.rb

Overview

A Stack is a collection of a templates and services.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

STACK_TEMPLATES_ENUM = 
[
  STACK_TEMPLATES_DATALAKE = 'DATALAKE'.freeze,
  STACK_TEMPLATES_DATAPIPELINE = 'DATAPIPELINE'.freeze,
  STACK_TEMPLATES_AISERVICES = 'AISERVICES'.freeze,
  STACK_TEMPLATES_DATATRANSFORMATION = 'DATATRANSFORMATION'.freeze,
  STACK_TEMPLATES_DEVOPSTOOLKIT = 'DEVOPSTOOLKIT'.freeze,
  STACK_TEMPLATES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SERVICES_ENUM = 
[
  SERVICES_ADB = 'ADB'.freeze,
  SERVICES_GGCS = 'GGCS'.freeze,
  SERVICES_OBJECTSTORAGE = 'OBJECTSTORAGE'.freeze,
  SERVICES_GENAI = 'GENAI'.freeze,
  SERVICES_DATAFLOW = 'DATAFLOW'.freeze,
  SERVICES_AIDATAPLATFORM = 'AIDATAPLATFORM'.freeze,
  SERVICES_OMK = 'OMK'.freeze,
  SERVICES_OKE = 'OKE'.freeze,
  SERVICES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ Stack

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/dif/models/stack.rb', line 244

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

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

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

  self.stack_templates = attributes[:'stackTemplates'] if attributes[:'stackTemplates']

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

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

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

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

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

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

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

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

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

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

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

  self.service_details = attributes[:'serviceDetails'] if attributes[:'serviceDetails']

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

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

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

#adb ⇒ Array<OCI::Dif::Models::AdbDetail>

ADB details if adb is included in the services.

Returns:



75
76
77
 
# File 'lib/oci/dif/models/stack.rb', line 75

def adb
  @adb
end

#aidataplatform ⇒ Array<OCI::Dif::Models::AiDataPlatformDetail>

AI Data Platform Details if aidataplatform is included in services.

Returns:



95
96
97
 
# File 'lib/oci/dif/models/stack.rb', line 95

def aidataplatform
  @aidataplatform
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/dif/models/stack.rb', line 59

def compartment_id
  @compartment_id
end

#dataflow ⇒ Array<OCI::Dif::Models::DataflowDetail>

DATAFLOW details if dataflow is included in the services.

Returns:



83
84
85
 
# File 'lib/oci/dif/models/stack.rb', line 83

def dataflow
  @dataflow
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


147
148
149
 
# File 'lib/oci/dif/models/stack.rb', line 147

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/dif/models/stack.rb', line 55

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


139
140
141
 
# File 'lib/oci/dif/models/stack.rb', line 139

def freeform_tags
  @freeform_tags
end

#genai ⇒ Array<OCI::Dif::Models::GenAiDetail>

GenAI Details if genai is included in services.

Returns:



91
92
93
 
# File 'lib/oci/dif/models/stack.rb', line 91

def genai
  @genai
end

#ggcs ⇒ Array<OCI::Dif::Models::GgcsDetail>

GGCS details if ggcs is included in the services.

Returns:



79
80
81
 
# File 'lib/oci/dif/models/stack.rb', line 79

def ggcs
  @ggcs
end

#id ⇒ String

[Required] The OCID of the Stack.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/dif/models/stack.rb', line 51

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the Stack in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/dif/models/stack.rb', line 131

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Stack.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/dif/models/stack.rb', line 125

def lifecycle_state
  @lifecycle_state
end

#notification_email ⇒ String

email id to which the stack notifications would be sent.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/dif/models/stack.rb', line 63

def notification_email
  @notification_email
end

#objectstorage ⇒ Array<OCI::Dif::Models::ObjectStorageDetail>

Object Storage Details if object storage is included in services.

Returns:



87
88
89
 
# File 'lib/oci/dif/models/stack.rb', line 87

def objectstorage
  @objectstorage
end

#oke ⇒ Array<OCI::Dif::Models::OkeDetail>

OKE Details if oke is included in services.

Returns:



103
104
105
 
# File 'lib/oci/dif/models/stack.rb', line 103

def oke
  @oke
end

#omk ⇒ Array<OCI::Dif::Models::OmkDetail>

OMK Details if omk is included in services.

Returns:



99
100
101
 
# File 'lib/oci/dif/models/stack.rb', line 99

def omk
  @omk
end

#service_details ⇒ Array<OCI::Dif::Models::ServiceDetailResponse>

Details of the service onboarded for the data intelligence stack.

Returns:



107
108
109
 
# File 'lib/oci/dif/models/stack.rb', line 107

def service_details
  @service_details
end

#services ⇒ Array<String>

[Required] List of services to be onboarded for the stack.

Returns:

  • (Array<String>) 


71
72
73
 
# File 'lib/oci/dif/models/stack.rb', line 71

def services
  @services
end

#stack_templates ⇒ Array<String>

[Required] List of templates to be onboarded for the stack.

Returns:

  • (Array<String>) 


67
68
69
 
# File 'lib/oci/dif/models/stack.rb', line 67

def stack_templates
  @stack_templates
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


154
155
156
 
# File 'lib/oci/dif/models/stack.rb', line 154

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Stack was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


114
115
116
 
# File 'lib/oci/dif/models/stack.rb', line 114

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the Stack was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


121
122
123
 
# File 'lib/oci/dif/models/stack.rb', line 121

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/dif/models/stack.rb', line 157

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'notification_email': :'notificationEmail',
    'stack_templates': :'stackTemplates',
    'services': :'services',
    'adb': :'adb',
    'ggcs': :'ggcs',
    'dataflow': :'dataflow',
    'objectstorage': :'objectstorage',
    'genai': :'genai',
    'aidataplatform': :'aidataplatform',
    'omk': :'omk',
    'oke': :'oke',
    'service_details': :'serviceDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    '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.



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
 
# File 'lib/oci/dif/models/stack.rb', line 187

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'notification_email': :'String',
    'stack_templates': :'Array<String>',
    'services': :'Array<String>',
    'adb': :'Array<OCI::Dif::Models::AdbDetail>',
    'ggcs': :'Array<OCI::Dif::Models::GgcsDetail>',
    'dataflow': :'Array<OCI::Dif::Models::DataflowDetail>',
    'objectstorage': :'Array<OCI::Dif::Models::ObjectStorageDetail>',
    'genai': :'Array<OCI::Dif::Models::GenAiDetail>',
    'aidataplatform': :'Array<OCI::Dif::Models::AiDataPlatformDetail>',
    'omk': :'Array<OCI::Dif::Models::OmkDetail>',
    'oke': :'Array<OCI::Dif::Models::OkeDetail>',
    'service_details': :'Array<OCI::Dif::Models::ServiceDetailResponse>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/oci/dif/models/stack.rb', line 403

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    notification_email == other.notification_email &&
    stack_templates == other.stack_templates &&
    services == other.services &&
    adb == other.adb &&
    ggcs == other.ggcs &&
    dataflow == other.dataflow &&
    objectstorage == other.objectstorage &&
    genai == other.genai &&
    aidataplatform == other.aidataplatform &&
    omk == other.omk &&
    oke == other.oke &&
    service_details == other.service_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/oci/dif/models/stack.rb', line 454

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


434
435
436
 
# File 'lib/oci/dif/models/stack.rb', line 434

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



443
444
445
 
# File 'lib/oci/dif/models/stack.rb', line 443

def hash
  [id, display_name, compartment_id, notification_email, stack_templates, services, adb, ggcs, dataflow, objectstorage, genai, aidataplatform, omk, oke, service_details, time_created, time_updated, 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



487
488
489
490
491
492
493
494
495
496
 
# File 'lib/oci/dif/models/stack.rb', line 487

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



481
482
483
 
# File 'lib/oci/dif/models/stack.rb', line 481

def to_s
  to_hash.to_s
end