Class: OCI::Multicloud::Models::ResourceAnchorSummary

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

Overview

The properties that define a resource anchor.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceAnchorSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :compartment_name (String) —

    The value to assign to the #compartment_name property

  • :partner_cloud_account_identifier (String) —

    The value to assign to the #partner_cloud_account_identifier property

  • :csp_resource_anchor_id (String) —

    The value to assign to the #csp_resource_anchor_id property

  • :csp_resource_anchor_name (String) —

    The value to assign to the #csp_resource_anchor_name property

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

    The value to assign to the #csp_additional_properties property

  • :time_created (DateTime) —

    The value to assign to the #time_created 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

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details 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

  • :subscription_id (String) —

    The value to assign to the #subscription_id property

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

    The value to assign to the #system_tags property

  • :linked_compartment_id (String) —

    The value to assign to the #linked_compartment_id property

  • :linked_compartment_name (String) —

    The value to assign to the #linked_compartment_name property

  • :resource_anchor_uri (String) —

    The value to assign to the #resource_anchor_uri property



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
299
300
301
302
303
304
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 189

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

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

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

  self.csp_resource_anchor_id = attributes[:'cspResourceAnchorId'] if attributes[:'cspResourceAnchorId']

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

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

  self.csp_resource_anchor_name = attributes[:'cspResourceAnchorName'] if attributes[:'cspResourceAnchorName']

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

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

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

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

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

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

  self.linked_compartment_id = attributes[:'linkedCompartmentId'] if attributes[:'linkedCompartmentId']

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

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

  self.linked_compartment_name = attributes[:'linkedCompartmentName'] if attributes[:'linkedCompartmentName']

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

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

  self.resource_anchor_uri = attributes[:'resourceAnchorUri'] if attributes[:'resourceAnchorUri']

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

  self.resource_anchor_uri = attributes[:'resource_anchor_uri'] if attributes[:'resource_anchor_uri']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 21

def compartment_id
  @compartment_id
end

#compartment_name ⇒ String

The name assigned to the compartment during creation.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 25

def compartment_name
  @compartment_name
end

#csp_additional_properties ⇒ Hash<String, String>

Cloud service provider-specific properties, such as AzureSubnetId for Azure.

Returns:

  • (Hash<String, String>) 


41
42
43
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 41

def csp_additional_properties
  @csp_additional_properties
end

#csp_resource_anchor_id ⇒ String

Resource anchor ID in the cloud service provider.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 33

def csp_resource_anchor_id
  @csp_resource_anchor_id
end

#csp_resource_anchor_name ⇒ String

Resource anchor name in the cloud service provider.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 37

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


81
82
83
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 81

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) 


17
18
19
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 17

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


73
74
75
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 73

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource anchor.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 65

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the resource anchor.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#linked_compartment_id ⇒ String

The OCID of the optional OCI compartment that was created or linked with the resource anchor. This compartment is different from the compartment that contains the resource anchor.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 98

def linked_compartment_id
  @linked_compartment_id
end

#linked_compartment_name ⇒ String

The name of the optional OCI compartment that was created or linked with the resource anchor. This compartment is different from the compartment that contains the resource anchor.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 104

def linked_compartment_name
  @linked_compartment_name
end

#partner_cloud_account_identifier ⇒ String

Partner cloud account identifier of the cloud service provider.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 29

def 
  @partner_cloud_account_identifier
end

#resource_anchor_uri ⇒ String

URI for the cloud service provider's resource anchor.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 108

def resource_anchor_uri
  @resource_anchor_uri
end

#subscription_id ⇒ String

[Required] Oracle Cloud Infrastructure Subscription Id

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 85

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 55

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'compartment_name': :'compartmentName',
    'partner_cloud_account_identifier': :'partnerCloudAccountIdentifier',
    'csp_resource_anchor_id': :'cspResourceAnchorId',
    'csp_resource_anchor_name': :'cspResourceAnchorName',
    'csp_additional_properties': :'cspAdditionalProperties',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'subscription_id': :'subscriptionId',
    'system_tags': :'systemTags',
    'linked_compartment_id': :'linkedCompartmentId',
    'linked_compartment_name': :'linkedCompartmentName',
    'resource_anchor_uri': :'resourceAnchorUri'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'compartment_name': :'String',
    'partner_cloud_account_identifier': :'String',
    'csp_resource_anchor_id': :'String',
    'csp_resource_anchor_name': :'String',
    'csp_additional_properties': :'Hash<String, String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'subscription_id': :'String',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'linked_compartment_id': :'String',
    'linked_compartment_name': :'String',
    'resource_anchor_uri': :'String'
    # 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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 313

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    compartment_name == other.compartment_name &&
     == other. &&
    csp_resource_anchor_id == other.csp_resource_anchor_id &&
    csp_resource_anchor_name == other.csp_resource_anchor_name &&
    csp_additional_properties == other.csp_additional_properties &&
    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 &&
    subscription_id == other.subscription_id &&
    system_tags == other.system_tags &&
    linked_compartment_id == other.linked_compartment_id &&
    linked_compartment_name == other.linked_compartment_name &&
    resource_anchor_uri == other.resource_anchor_uri
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 361

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


341
342
343
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 341

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



350
351
352
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 350

def hash
  [id, display_name, compartment_id, compartment_name, , csp_resource_anchor_id, csp_resource_anchor_name, csp_additional_properties, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, subscription_id, system_tags, linked_compartment_id, linked_compartment_name, resource_anchor_uri].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 394

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



388
389
390
 
# File 'lib/oci/multicloud/models/resource_anchor_summary.rb', line 388

def to_s
  to_hash.to_s
end