Class: OCI::FusionApps::Models::FusionEnvironmentFamilySummary

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

Overview

Summary information for a Fusion environment family.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FusionEnvironmentFamilySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



120
121
122
123
124
125
126
127
128
129
130
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
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 120

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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


60
61
62
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 60

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) 


17
18
19
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 17

def display_name
  @display_name
end

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

Returns:



20
21
22
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 20

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


54
55
56
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 54

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) 


13
14
15
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 13

def id
  @id
end

#is_subscription_update_needed ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 32

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) 


48
49
50
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 48

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the FusionEnvironmentFamily.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 44

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


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

def subscription_ids
  @subscription_ids
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 36

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 40

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 63

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',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 83

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',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 202

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 243

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


223
224
225
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 232

def hash
  [id, display_name, family_maintenance_policy, compartment_id, subscription_ids, is_subscription_update_needed, time_created, time_updated, lifecycle_state, lifecycle_details, 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



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 276

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



270
271
272
 
# File 'lib/oci/fusion_apps/models/fusion_environment_family_summary.rb', line 270

def to_s
  to_hash.to_s
end