Class: OCI::Multicloud::Models::ResourceAnchor

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

Overview

A resource anchor.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

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
SETUP_MODE_ENUM = 
[
  SETUP_MODE_AUTO_BIND = 'AUTO_BIND'.freeze,
  SETUP_MODE_NO_AUTO_BIND = 'NO_AUTO_BIND'.freeze,
  SETUP_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SUBSCRIPTION_TYPE_ENUM = 
[
  SUBSCRIPTION_TYPE_ORACLEDBATAZURE = 'ORACLEDBATAZURE'.freeze,
  SUBSCRIPTION_TYPE_ORACLEDBATGOOGLE = 'ORACLEDBATGOOGLE'.freeze,
  SUBSCRIPTION_TYPE_ORACLEDBATAWS = 'ORACLEDBATAWS'.freeze,
  SUBSCRIPTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceAnchor

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 211

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cloud_service_provider_metadata_item ⇒ OCI::Multicloud::Models::CloudServiceProviderMetadataItem

Returns:



133
134
135
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 133

def cloud_service_provider_metadata_item
  @cloud_service_provider_metadata_item
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 54

def compartment_id
  @compartment_id
end

#compartment_name ⇒ String

The name assigned to the compartment during creation.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 58

def compartment_name
  @compartment_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>>) 


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

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) 


46
47
48
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 46

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


90
91
92
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource anchor.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 42

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) 


82
83
84
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 82

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the resource anchor.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#linked_compartment_id ⇒ String

Optional - Oracle Cloud Infrastructure compartment Id (OCID) which was created or linked by customer with resource anchor. This compartmentId is different from where resource Anchor live.

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 118

def linked_compartment_id
  @linked_compartment_id
end

#linked_compartment_name ⇒ String

The name assigned to the compartment which was created or linked by customer with resource anchor. This compartment is different from where resource Anchor live.

Returns:

  • (String) 


122
123
124
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 122

def linked_compartment_name
  @linked_compartment_name
end

#region ⇒ String

OCI Region that resource is created.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 50

def region
  @region
end

#setup_mode ⇒ String

AUTO_BIND - when passed compartment will be created on-behalf of customer and bind to this resource anchor NO_AUTO_BIND - compartment will not be created and later customer can bind existing compartment. to this resource anchor. This is for future use only

Returns:

  • (String) 


112
113
114
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 112

def setup_mode
  @setup_mode
end

#subscription_id ⇒ String

[Required] Oracle Cloud Infrastructure Subscription Id

Returns:

  • (String) 


130
131
132
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 130

def subscription_id
  @subscription_id
end

#subscription_type ⇒ String

subscription type

Returns:

  • (String) 


126
127
128
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 126

def subscription_type
  @subscription_type
end

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

[Required] 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>>) 


105
106
107
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 105

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) 


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

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) 


72
73
74
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 72

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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/resource_anchor.rb', line 136

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'region': :'region',
    'compartment_id': :'compartmentId',
    'compartment_name': :'compartmentName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'setup_mode': :'setupMode',
    'linked_compartment_id': :'linkedCompartmentId',
    'linked_compartment_name': :'linkedCompartmentName',
    'subscription_type': :'subscriptionType',
    'subscription_id': :'subscriptionId',
    'cloud_service_provider_metadata_item': :'cloudServiceProviderMetadataItem'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 162

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'region': :'String',
    'compartment_id': :'String',
    'compartment_name': :'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>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'setup_mode': :'String',
    'linked_compartment_id': :'String',
    'linked_compartment_name': :'String',
    'subscription_type': :'String',
    'subscription_id': :'String',
    'cloud_service_provider_metadata_item': :'OCI::Multicloud::Models::CloudServiceProviderMetadataItem'
    # 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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    region == other.region &&
    compartment_id == other.compartment_id &&
    compartment_name == other.compartment_name &&
    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 &&
    system_tags == other.system_tags &&
    setup_mode == other.setup_mode &&
    linked_compartment_id == other.linked_compartment_id &&
    linked_compartment_name == other.linked_compartment_name &&
    subscription_type == other.subscription_type &&
    subscription_id == other.subscription_id &&
    cloud_service_provider_metadata_item == other.cloud_service_provider_metadata_item
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



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 411

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


391
392
393
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 391

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



400
401
402
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 400

def hash
  [id, display_name, region, compartment_id, compartment_name, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags, setup_mode, linked_compartment_id, linked_compartment_name, subscription_type, subscription_id, cloud_service_provider_metadata_item].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



444
445
446
447
448
449
450
451
452
453
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 444

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



438
439
440
 
# File 'lib/oci/multicloud/models/resource_anchor.rb', line 438

def to_s
  to_hash.to_s
end