Class: OCI::Multicloud::Models::MulticloudResourceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/multicloud/models/multicloud_resource_summary.rb

Overview

The properties that define the Multicloud resource. Details for each resource include Multicloud base compartment, name, state, resource type, and network anchor. For more information, see Multicloud Resources.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ MulticloudResourceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :resource_display_name (String) —

    The value to assign to the #resource_display_name property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :compartment_name (String) —

    The value to assign to the #compartment_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :vcn_name (String) —

    The value to assign to the #vcn_name property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :network_anchor_name (String) —

    The value to assign to the #network_anchor_name property

  • :network_anchor_id (String) —

    The value to assign to the #network_anchor_id property

  • :csp_resource_id (String) —

    The value to assign to the #csp_resource_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :csp_additional_properties (Hash<String, String>) —

    The value to assign to the #csp_additional_properties property

  • :resource_additional_properties (Hash<String, Object>) —

    The value to assign to the #resource_additional_properties property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
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
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 185

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

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

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

  self.resource_display_name = attributes[:'resourceDisplayName'] if attributes[:'resourceDisplayName']

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

  self.compartment_name = attributes[:'compartmentName'] if attributes[:'compartmentName']

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

  self.compartment_name = attributes[:'compartment_name'] if attributes[:'compartment_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.vcn_name = attributes[:'vcnName'] if attributes[:'vcnName']

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

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

  self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId']

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

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

  self.network_anchor_name = attributes[:'networkAnchorName'] if attributes[:'networkAnchorName']

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

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

  self.network_anchor_id = attributes[:'networkAnchorId'] if attributes[:'networkAnchorId']

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

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

  self.csp_resource_id = attributes[:'cspResourceId'] if attributes[:'cspResourceId']

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

  self.csp_resource_id = attributes[:'csp_resource_id'] if attributes[:'csp_resource_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.csp_additional_properties = attributes[:'cspAdditionalProperties'] if attributes[:'cspAdditionalProperties']

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

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

  self.resource_additional_properties = attributes[:'resourceAdditionalProperties'] if attributes[:'resourceAdditionalProperties']

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

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

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

Id of the compartment associated with the resource.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 40

def compartment_id
  @compartment_id
end

#compartment_name ⇒ String

Name of the compartment associated with the resource.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 36

def compartment_name
  @compartment_name
end

#csp_additional_properties ⇒ Hash<String, String>

Properties specific to the cloud service provider. For example, AzureSubnetId for Azure.

Returns:

  • (Hash<String, String>) 


70
71
72
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 70

def csp_additional_properties
  @csp_additional_properties
end

#csp_resource_id ⇒ String

The resource Id that comes from the Multicloud control plane.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 60

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


100
101
102
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 100

def defined_tags
  @defined_tags
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. For more information, see Resource Tags.

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

Returns:

  • (Hash<String, String>) 


92
93
94
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 92

def freeform_tags
  @freeform_tags
end

#lifecycle_state ⇒ String

The current state of the Multicloud resource.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 84

def lifecycle_state
  @lifecycle_state
end

#network_anchor_id ⇒ String

The OCID of the network anchor associated with the resource.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 56

def network_anchor_id
  @network_anchor_id
end

#network_anchor_name ⇒ String

Name of the network anchor associated with the resource.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 52

def network_anchor_name
  @network_anchor_name
end

#resource_additional_properties ⇒ Hash<String, Object>

Additional attributes specific to certain resource types, used to construct a URL for accessing the resource in the OCI console.

Returns:

  • (Hash<String, Object>) 


74
75
76
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 74

def resource_additional_properties
  @resource_additional_properties
end

#resource_display_name ⇒ String

Endpoint used to retrieve the resource's display name and lifecycle state.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 28

def resource_display_name
  @resource_display_name
end

#resource_id ⇒ String

[Required] The Id of the multicloud resource.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 24

def resource_id
  @resource_id
end

#resource_type ⇒ String

Type of resource, such as VMCluster or ExaInfra,

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 32

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


107
108
109
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 107

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 66

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 80

def time_updated
  @time_updated
end

#vcn_id ⇒ String

Id of the virtual cloud network (VCN) associated with the resource.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 48

def vcn_id
  @vcn_id
end

#vcn_name ⇒ String

Name of the virtual cloud network (VCN) associated with the resource.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 44

def vcn_name
  @vcn_name
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 110

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_id': :'resourceId',
    'resource_display_name': :'resourceDisplayName',
    'resource_type': :'resourceType',
    'compartment_name': :'compartmentName',
    'compartment_id': :'compartmentId',
    'vcn_name': :'vcnName',
    'vcn_id': :'vcnId',
    'network_anchor_name': :'networkAnchorName',
    'network_anchor_id': :'networkAnchorId',
    'csp_resource_id': :'cspResourceId',
    'time_created': :'timeCreated',
    'csp_additional_properties': :'cspAdditionalProperties',
    'resource_additional_properties': :'resourceAdditionalProperties',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 136

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_id': :'String',
    'resource_display_name': :'String',
    'resource_type': :'String',
    'compartment_name': :'String',
    'compartment_id': :'String',
    'vcn_name': :'String',
    'vcn_id': :'String',
    'network_anchor_name': :'String',
    'network_anchor_id': :'String',
    'csp_resource_id': :'String',
    'time_created': :'DateTime',
    'csp_additional_properties': :'Hash<String, String>',
    'resource_additional_properties': :'Hash<String, Object>',
    'time_updated': :'DateTime',
    'lifecycle_state': :'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



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

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

  self.class == other.class &&
    resource_id == other.resource_id &&
    resource_display_name == other.resource_display_name &&
    resource_type == other.resource_type &&
    compartment_name == other.compartment_name &&
    compartment_id == other.compartment_id &&
    vcn_name == other.vcn_name &&
    vcn_id == other.vcn_id &&
    network_anchor_name == other.network_anchor_name &&
    network_anchor_id == other.network_anchor_id &&
    csp_resource_id == other.csp_resource_id &&
    time_created == other.time_created &&
    csp_additional_properties == other.csp_additional_properties &&
    resource_additional_properties == other.resource_additional_properties &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    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



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

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


347
348
349
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 347

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



356
357
358
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 356

def hash
  [resource_id, resource_display_name, resource_type, compartment_name, compartment_id, vcn_name, vcn_id, network_anchor_name, network_anchor_id, csp_resource_id, time_created, csp_additional_properties, resource_additional_properties, time_updated, lifecycle_state, 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



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 400

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



394
395
396
 
# File 'lib/oci/multicloud/models/multicloud_resource_summary.rb', line 394

def to_s
  to_hash.to_s
end