Class: OCI::ResourceManager::Models::Stack

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

Overview

The properties that define a stack. A stack is the collection of Oracle Cloud Infrastructure resources corresponding to a given Terraform configuration. For instructions on managing stacks, see Managing Stacks. For more information about stacks, see Key Concepts.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STACK_DRIFT_STATUS_ENUM = 
[
  STACK_DRIFT_STATUS_NOT_CHECKED = 'NOT_CHECKED'.freeze,
  STACK_DRIFT_STATUS_IN_SYNC = 'IN_SYNC'.freeze,
  STACK_DRIFT_STATUS_DRIFTED = 'DRIFTED'.freeze,
  STACK_DRIFT_STATUS_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):



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

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

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

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

  self.custom_terraform_provider = attributes[:'customTerraformProvider'] if attributes[:'customTerraformProvider']

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

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

  self.is_third_party_provider_experience_enabled = attributes[:'isThirdPartyProviderExperienceEnabled'] unless attributes[:'isThirdPartyProviderExperienceEnabled'].nil?

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

  self.is_third_party_provider_experience_enabled = attributes[:'is_third_party_provider_experience_enabled'] unless attributes[:'is_third_party_provider_experience_enabled'].nil?

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

  self.terraform_version = attributes[:'terraformVersion'] if attributes[:'terraformVersion']

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

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

  self.stack_drift_status = attributes[:'stackDriftStatus'] if attributes[:'stackDriftStatus']

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

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

  self.time_drift_last_checked = attributes[:'timeDriftLastChecked'] if attributes[:'timeDriftLastChecked']

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

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

  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

Unique identifier (OCID) for the compartment where the stack is located.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/resource_manager/models/stack.rb', line 40

def compartment_id
  @compartment_id
end

#config_source ⇒ OCI::ResourceManager::Models::ConfigSource

Returns:



66
67
68
 
# File 'lib/oci/resource_manager/models/stack.rb', line 66

def config_source
  @config_source
end

#custom_terraform_provider ⇒ OCI::ResourceManager::Models::CustomTerraformProvider

Returns:



69
70
71
 
# File 'lib/oci/resource_manager/models/stack.rb', line 69

def custom_terraform_provider
  @custom_terraform_provider
end

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

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


118
119
120
 
# File 'lib/oci/resource_manager/models/stack.rb', line 118

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the stack.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/resource_manager/models/stack.rb', line 49

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/resource_manager/models/stack.rb', line 45

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


111
112
113
 
# File 'lib/oci/resource_manager/models/stack.rb', line 111

def freeform_tags
  @freeform_tags
end

#id ⇒ String

Unique identifier (OCID) for the stack.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/resource_manager/models/stack.rb', line 36

def id
  @id
end

#is_third_party_provider_experience_enabled ⇒ BOOLEAN

When true, the stack sources third-party Terraform providers from Terraform Registry and allows #custom_terraform_provider custom_terraform_provider}. For more information about stack sourcing of third-party Terraform providers, see {Third-party Provider Configuration.

Returns:

  • (BOOLEAN) 


78
79
80
 
# File 'lib/oci/resource_manager/models/stack.rb', line 78

def is_third_party_provider_experience_enabled
  @is_third_party_provider_experience_enabled
end

#lifecycle_state ⇒ String

The current lifecycle state of the stack. For more information about stack lifecycle states in Resource Manager, see Key Concepts.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#stack_drift_status ⇒ String

Drift status of the stack. Drift refers to differences between the actual (current) state of the stack and the expected (defined) state of the stack.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/resource_manager/models/stack.rb', line 97

def stack_drift_status
  @stack_drift_status
end

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

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


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

def system_tags
  @system_tags
end

#terraform_version ⇒ String

The version of Terraform specified for the stack. Example: 1.5.x

Returns:

  • (String) 


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

def terraform_version
  @terraform_version
end

#time_created ⇒ DateTime

The date and time at which the stack was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/resource_manager/models/stack.rb', line 56

def time_created
  @time_created
end

#time_drift_last_checked ⇒ DateTime

The date and time when the drift detection was last executed. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/resource_manager/models/stack.rb', line 104

def time_drift_last_checked
  @time_drift_last_checked
end

#variables ⇒ Hash<String, String>

Terraform variables associated with this resource. Maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: {\"CompartmentId\": \"compartment-id-value\"}

Returns:

  • (Hash<String, String>) 


86
87
88
 
# File 'lib/oci/resource_manager/models/stack.rb', line 86

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'config_source': :'configSource',
    'custom_terraform_provider': :'customTerraformProvider',
    'is_third_party_provider_experience_enabled': :'isThirdPartyProviderExperienceEnabled',
    'variables': :'variables',
    'terraform_version': :'terraformVersion',
    'stack_drift_status': :'stackDriftStatus',
    'time_drift_last_checked': :'timeDriftLastChecked',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/resource_manager/models/stack.rb', line 152

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'config_source': :'OCI::ResourceManager::Models::ConfigSource',
    'custom_terraform_provider': :'OCI::ResourceManager::Models::CustomTerraformProvider',
    'is_third_party_provider_experience_enabled': :'BOOLEAN',
    'variables': :'Hash<String, String>',
    'terraform_version': :'String',
    'stack_drift_status': :'String',
    'time_drift_last_checked': :'DateTime',
    '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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/resource_manager/models/stack.rb', line 321

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    config_source == other.config_source &&
    custom_terraform_provider == other.custom_terraform_provider &&
    is_third_party_provider_experience_enabled == other.is_third_party_provider_experience_enabled &&
    variables == other.variables &&
    terraform_version == other.terraform_version &&
    stack_drift_status == other.stack_drift_status &&
    time_drift_last_checked == other.time_drift_last_checked &&
    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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/resource_manager/models/stack.rb', line 366

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


346
347
348
 
# File 'lib/oci/resource_manager/models/stack.rb', line 346

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



355
356
357
 
# File 'lib/oci/resource_manager/models/stack.rb', line 355

def hash
  [id, compartment_id, display_name, description, time_created, lifecycle_state, config_source, custom_terraform_provider, is_third_party_provider_experience_enabled, variables, terraform_version, stack_drift_status, time_drift_last_checked, 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



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/resource_manager/models/stack.rb', line 399

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



393
394
395
 
# File 'lib/oci/resource_manager/models/stack.rb', line 393

def to_s
  to_hash.to_s
end