Class: OCI::Multicloud::Models::NetworkAnchorSummary

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

Overview

Summary information about a NetworkAnchor.

Constant Summary collapse

NETWORK_ANCHOR_CONNECTION_STATUS_ENUM =
[
  NETWORK_ANCHOR_CONNECTION_STATUS_CONNECTED = 'CONNECTED'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_DISCONNECTED = 'DISCONNECTED'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_CONNECTING = 'CONNECTING'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_ACTIVE = 'ACTIVE'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_ERROR = 'ERROR'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_UPDATING = 'UPDATING'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_FAILED = 'FAILED'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_DELETING = 'DELETING'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_DELETED = 'DELETED'.freeze,
  NETWORK_ANCHOR_CONNECTION_STATUS_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 = {}) ⇒ NetworkAnchorSummary

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

  • :resource_anchor_id (String)

    The value to assign to the #resource_anchor_id property

  • :vcn_id (String)

    The value to assign to the #vcn_id property

  • :vcn_name (String)

    The value to assign to the #vcn_name property

  • :network_anchor_connection_status (String)

    The value to assign to the #network_anchor_connection_status property

  • :cluster_placement_group_id (String)

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

  • :csp_additional_properties (Hash<String, String>)

    The value to assign to the #csp_additional_properties property

  • :csp_network_anchor_id (String)

    The value to assign to the #csp_network_anchor_id property

  • :network_anchor_uri (String)

    The value to assign to the #network_anchor_uri property

  • :network_anchor_lifecycle_state (String)

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

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

    The value to assign to the #system_tags property

  • :subscription_type (String)

    The value to assign to the #subscription_type property

  • :cidr_blocks (Array<String>)

    The value to assign to the #cidr_blocks property



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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 214

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

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

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

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

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

  self.cluster_placement_group_id = attributes[:'cluster_placement_group_id'] if attributes[:'cluster_placement_group_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.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.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.csp_network_anchor_id = attributes[:'cspNetworkAnchorId'] if attributes[:'cspNetworkAnchorId']

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

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

  self.network_anchor_uri = attributes[:'networkAnchorUri'] if attributes[:'networkAnchorUri']

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

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

  self.network_anchor_lifecycle_state = attributes[:'networkAnchorLifecycleState'] if attributes[:'networkAnchorLifecycleState']

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

  self.network_anchor_lifecycle_state = attributes[:'network_anchor_lifecycle_state'] if attributes[:'network_anchor_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.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.cidr_blocks = attributes[:'cidrBlocks'] if attributes[:'cidrBlocks']

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

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

Instance Attribute Details

#cidr_blocksArray<String>

An Azure/GCP/AWS cidrBlocks

Returns:

  • (Array<String>)


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

def cidr_blocks
  @cidr_blocks
end

#cluster_placement_group_idString

The CPG ID in which Network Anchor will be created.

Returns:

  • (String)


63
64
65
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 63

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


43
44
45
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 43

def compartment_id
  @compartment_id
end

#csp_additional_propertiesHash<String, String>

CSP Specific Additional Properties, AzureSubnetId for Azure

Returns:

  • (Hash<String, String>)


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

def csp_additional_properties
  @csp_additional_properties
end

#csp_network_anchor_idString

Network Anchor Id in the Cloud Service Provider.

Returns:

  • (String)


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

def csp_network_anchor_id
  @csp_network_anchor_id
end

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


115
116
117
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 115

def defined_tags
  @defined_tags
end

#display_nameString

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String)


39
40
41
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 39

def display_name
  @display_name
end

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


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

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the NetworkAnchor.

Returns:

  • (String)


35
36
37
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 35

def id
  @id
end

#lifecycle_detailsString

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

Returns:

  • (String)


99
100
101
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 99

def lifecycle_details
  @lifecycle_details
end

#network_anchor_connection_statusString

[Required] Defines status of the Network Anchor.

Returns:

  • (String)


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

def network_anchor_connection_status
  @network_anchor_connection_status
end

#network_anchor_lifecycle_stateString

[Required] The current state of the NetworkAnchor.

Returns:

  • (String)


93
94
95
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 93

def network_anchor_lifecycle_state
  @network_anchor_lifecycle_state
end

#network_anchor_uriString

CSP network anchor Uri

Returns:

  • (String)


89
90
91
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 89

def network_anchor_uri
  @network_anchor_uri
end

#resource_anchor_idString

[Required] OCI resource anchor Id (OCID).

Returns:

  • (String)


47
48
49
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 47

def resource_anchor_id
  @resource_anchor_id
end

#subscription_typeString

Oracle Cloud Infrastructure Subscription Type.

Returns:

  • (String)


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

def subscription_type
  @subscription_type
end

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


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

def system_tags
  @system_tags
end

#time_createdDateTime

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

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updatedDateTime

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

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

Returns:

  • (DateTime)


77
78
79
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 77

def time_updated
  @time_updated
end

#vcn_idString

OCI resource Id of VCN.

Returns:

  • (String)


51
52
53
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 51

def vcn_id
  @vcn_id
end

#vcn_nameString

Name of the VCN associated to the Network Anchor.

Returns:

  • (String)


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

def vcn_name
  @vcn_name
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'resource_anchor_id': :'resourceAnchorId',
    'vcn_id': :'vcnId',
    'vcn_name': :'vcnName',
    'network_anchor_connection_status': :'networkAnchorConnectionStatus',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'csp_additional_properties': :'cspAdditionalProperties',
    'csp_network_anchor_id': :'cspNetworkAnchorId',
    'network_anchor_uri': :'networkAnchorUri',
    'network_anchor_lifecycle_state': :'networkAnchorLifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'subscription_type': :'subscriptionType',
    'cidr_blocks': :'cidrBlocks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'resource_anchor_id': :'String',
    'vcn_id': :'String',
    'vcn_name': :'String',
    'network_anchor_connection_status': :'String',
    'cluster_placement_group_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'csp_additional_properties': :'Hash<String, String>',
    'csp_network_anchor_id': :'String',
    'network_anchor_uri': :'String',
    'network_anchor_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>>',
    'subscription_type': :'String',
    'cidr_blocks': :'Array<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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 370

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    resource_anchor_id == other.resource_anchor_id &&
    vcn_id == other.vcn_id &&
    vcn_name == other.vcn_name &&
    network_anchor_connection_status == other.network_anchor_connection_status &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    csp_additional_properties == other.csp_additional_properties &&
    csp_network_anchor_id == other.csp_network_anchor_id &&
    network_anchor_uri == other.network_anchor_uri &&
    network_anchor_lifecycle_state == other.network_anchor_lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    subscription_type == other.subscription_type &&
    cidr_blocks == other.cidr_blocks
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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 419

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


399
400
401
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 399

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



408
409
410
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 408

def hash
  [id, display_name, compartment_id, resource_anchor_id, vcn_id, vcn_name, network_anchor_connection_status, cluster_placement_group_id, time_created, time_updated, csp_additional_properties, csp_network_anchor_id, network_anchor_uri, network_anchor_lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags, subscription_type, cidr_blocks].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



452
453
454
455
456
457
458
459
460
461
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 452

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



446
447
448
# File 'lib/oci/multicloud/models/network_anchor_summary.rb', line 446

def to_s
  to_hash.to_s
end