Class: OCI::FusionApps::Models::FusionEnvironmentFamily

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fusion_apps/models/fusion_environment_family.rb

Overview

Details of a Fusion environment family. An environment family is a logical grouping of environments. The environment family defines a set of characteristics that are shared across the environments to allow consistent management and maintenance across your production, test, and development environments. For more information, see Planning an Environment Family.

Constant Summary collapse

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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FusionEnvironmentFamily

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



131
132
133
134
135
136
137
138
139
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
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
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 131

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

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

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

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

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

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

  self.is_subscription_update_needed = attributes[:'isSubscriptionUpdateNeeded'] unless attributes[:'isSubscriptionUpdateNeeded'].nil?

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where the environment family is located.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 35

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


71
72
73
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 71

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A friendly name for the environment family. The name must contain only letters, numbers, dashes, and underscores. Can be changed later.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 28

def display_name
  @display_name
end

#family_maintenance_policy ⇒ OCI::FusionApps::Models::FamilyMaintenancePolicy

Returns:



31
32
33
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 31

def family_maintenance_policy
  @family_maintenance_policy
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


65
66
67
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 65

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The unique identifier (OCID) of the environment family. Can't be changed after creation.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 24

def id
  @id
end

#is_subscription_update_needed ⇒ BOOLEAN

When set to True, a subscription update is required for the environment family.

Returns:

  • (BOOLEAN) 


43
44
45
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 43

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


55
56
57
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 55

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the FusionEnvironmentFamily.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 51

def lifecycle_state
  @lifecycle_state
end

#subscription_ids ⇒ Array<String>

[Required] The list of the IDs of the applications subscriptions that are associated with the environment family.

Returns:

  • (Array<String>) 


39
40
41
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 39

def subscription_ids
  @subscription_ids
end

#system_name ⇒ String

Environment Specific Guid/ System Name

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 59

def system_name
  @system_name
end

#time_created ⇒ DateTime

The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 47

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 74

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'family_maintenance_policy': :'familyMaintenancePolicy',
    'compartment_id': :'compartmentId',
    'subscription_ids': :'subscriptionIds',
    'is_subscription_update_needed': :'isSubscriptionUpdateNeeded',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'system_name': :'systemName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'family_maintenance_policy': :'OCI::FusionApps::Models::FamilyMaintenancePolicy',
    'compartment_id': :'String',
    'subscription_ids': :'Array<String>',
    'is_subscription_update_needed': :'BOOLEAN',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'system_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 226

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    family_maintenance_policy == other.family_maintenance_policy &&
    compartment_id == other.compartment_id &&
    subscription_ids == other.subscription_ids &&
    is_subscription_update_needed == other.is_subscription_update_needed &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    system_name == other.system_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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

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


247
248
249
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 247

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 256

def hash
  [id, display_name, family_maintenance_policy, compartment_id, subscription_ids, is_subscription_update_needed, time_created, lifecycle_state, lifecycle_details, system_name, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 300

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



294
295
296
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family.rb', line 294

def to_s
  to_hash.to_s
end