Class: OCI::Datacc::Models::VmClusterNetwork

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/datacc/models/vm_cluster_network.rb

Overview

Details of the VM cluster network on Database Infrastructure.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_REQUIRES_VALIDATION = 'REQUIRES_VALIDATION'.freeze,
  LIFECYCLE_STATE_VALIDATING = 'VALIDATING'.freeze,
  LIFECYCLE_STATE_VALIDATED = 'VALIDATED'.freeze,
  LIFECYCLE_STATE_VALIDATION_FAILED = 'VALIDATION_FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ALLOCATED = 'ALLOCATED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CONSUMER_TYPE_ENUM = 
[
  CONSUMER_TYPE_INSTANCE = 'INSTANCE'.freeze,
  CONSUMER_TYPE_CLUSTER = 'CLUSTER'.freeze,
  CONSUMER_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 = {}) ⇒ VmClusterNetwork

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :node_count (Integer) —

    The value to assign to the #node_count property

  • :infrastructure_id (String) —

    The value to assign to the #infrastructure_id property

  • :base_vm_cluster_id (String) —

    The value to assign to the #base_vm_cluster_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :is_scan_enabled (BOOLEAN) —

    The value to assign to the #is_scan_enabled property

  • :scans (Array<OCI::Datacc::Models::ScanDetails>) —

    The value to assign to the #scans property

  • :listener_port (Integer) —

    The value to assign to the #listener_port property

  • :listener_port_ssl (Integer) —

    The value to assign to the #listener_port_ssl property

  • :dns_servers (Array<String>) —

    The value to assign to the #dns_servers property

  • :ntp_servers (Array<String>) —

    The value to assign to the #ntp_servers property

  • :vm_networks (Array<OCI::Datacc::Models::VmNetworkDetails>) —

    The value to assign to the #vm_networks property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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_details (String) —

    The value to assign to the #lifecycle_details property

  • :associated_resource_id (String) —

    The value to assign to the #associated_resource_id property

  • :consumer_type (String) —

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



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
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 218

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

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

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

  self.infrastructure_id = attributes[:'infrastructureId'] if attributes[:'infrastructureId']

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

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

  self.base_vm_cluster_id = attributes[:'baseVmClusterId'] if attributes[:'baseVmClusterId']

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

  self.base_vm_cluster_id = attributes[:'base_vm_cluster_id'] if attributes[:'base_vm_cluster_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.is_scan_enabled = attributes[:'isScanEnabled'] unless attributes[:'isScanEnabled'].nil?

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

  self.is_scan_enabled = attributes[:'is_scan_enabled'] unless attributes[:'is_scan_enabled'].nil?

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

  self.listener_port = attributes[:'listenerPort'] if attributes[:'listenerPort']

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

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

  self.listener_port_ssl = attributes[:'listenerPortSsl'] if attributes[:'listenerPortSsl']

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

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

  self.dns_servers = attributes[:'dnsServers'] if attributes[:'dnsServers']

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

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

  self.ntp_servers = attributes[:'ntpServers'] if attributes[:'ntpServers']

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

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

  self.vm_networks = attributes[:'vmNetworks'] if attributes[:'vmNetworks']

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

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

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

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

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

  self.consumer_type = attributes[:'consumerType'] if attributes[:'consumerType']

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

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

  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

#associated_resource_id ⇒ String

The OCID of the associated resource.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 106

def associated_resource_id
  @associated_resource_id
end

#base_vm_cluster_id ⇒ String

The OCID of the associated VM cluster.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 51

def base_vm_cluster_id
  @base_vm_cluster_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the VM cluster network.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 39

def compartment_id
  @compartment_id
end

#consumer_type ⇒ String

Consumer type for the VM cluster network.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 110

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


122
123
124
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 122

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the VM cluster network. The name does not need to be unique.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 55

def display_name
  @display_name
end

#dns_servers ⇒ Array<String>

The list of DNS server IP addresses. Maximum of 3 allowed.

Returns:

  • (Array<String>) 


76
77
78
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 76

def dns_servers
  @dns_servers
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


116
117
118
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 116

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the VM cluster network.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 34

def id
  @id
end

#infrastructure_id ⇒ String

[Required] The OCID of the Database Infrastructure.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 47

def infrastructure_id
  @infrastructure_id
end

#is_scan_enabled ⇒ BOOLEAN

Indicates whether Single Client Access Name (SCAN) is enabled on the VM cluster.

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 60

def is_scan_enabled
  @is_scan_enabled
end

#lifecycle_details ⇒ String

Lifecycle state details of the VM cluster network.

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 102

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the virtual machine cluster network.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 88

def lifecycle_state
  @lifecycle_state
end

#listener_port ⇒ Integer

The listener TCP/IP port.

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 68

def listener_port
  @listener_port
end

#listener_port_ssl ⇒ Integer

The listener TCP/IP SSL port.

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 72

def listener_port_ssl
  @listener_port_ssl
end

#node_count ⇒ Integer

Count of virtual machines in this VM cluster.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 43

def node_count
  @node_count
end

#ntp_servers ⇒ Array<String>

The list of NTP server IP addresses. Maximum of 3 allowed.

Returns:

  • (Array<String>) 


80
81
82
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 80

def ntp_servers
  @ntp_servers
end

#scans ⇒ Array<OCI::Datacc::Models::ScanDetails>

[Required] The SCAN details.

Returns:



64
65
66
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 64

def scans
  @scans
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }

Returns:

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


128
129
130
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 128

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time that the VM cluster network was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


93
94
95
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 93

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time that the VM cluster network was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 98

def time_updated
  @time_updated
end

#vm_networks ⇒ Array<OCI::Datacc::Models::VmNetworkDetails>

[Required] Details of the client and backup networks.

Returns:



84
85
86
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 84

def vm_networks
  @vm_networks
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 131

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'node_count': :'nodeCount',
    'infrastructure_id': :'infrastructureId',
    'base_vm_cluster_id': :'baseVmClusterId',
    'display_name': :'displayName',
    'is_scan_enabled': :'isScanEnabled',
    'scans': :'scans',
    'listener_port': :'listenerPort',
    'listener_port_ssl': :'listenerPortSsl',
    'dns_servers': :'dnsServers',
    'ntp_servers': :'ntpServers',
    'vm_networks': :'vmNetworks',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_details': :'lifecycleDetails',
    'associated_resource_id': :'associatedResourceId',
    'consumer_type': :'consumerType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

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
187
188
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'node_count': :'Integer',
    'infrastructure_id': :'String',
    'base_vm_cluster_id': :'String',
    'display_name': :'String',
    'is_scan_enabled': :'BOOLEAN',
    'scans': :'Array<OCI::Datacc::Models::ScanDetails>',
    'listener_port': :'Integer',
    'listener_port_ssl': :'Integer',
    'dns_servers': :'Array<String>',
    'ntp_servers': :'Array<String>',
    'vm_networks': :'Array<OCI::Datacc::Models::VmNetworkDetails>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_details': :'String',
    'associated_resource_id': :'String',
    'consumer_type': :'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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 382

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    node_count == other.node_count &&
    infrastructure_id == other.infrastructure_id &&
    base_vm_cluster_id == other.base_vm_cluster_id &&
    display_name == other.display_name &&
    is_scan_enabled == other.is_scan_enabled &&
    scans == other.scans &&
    listener_port == other.listener_port &&
    listener_port_ssl == other.listener_port_ssl &&
    dns_servers == other.dns_servers &&
    ntp_servers == other.ntp_servers &&
    vm_networks == other.vm_networks &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_details == other.lifecycle_details &&
    associated_resource_id == other.associated_resource_id &&
    consumer_type == other.consumer_type &&
    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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 433

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


413
414
415
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 413

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



422
423
424
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 422

def hash
  [id, compartment_id, node_count, infrastructure_id, base_vm_cluster_id, display_name, is_scan_enabled, scans, listener_port, listener_port_ssl, dns_servers, ntp_servers, vm_networks, lifecycle_state, time_created, time_updated, lifecycle_details, associated_resource_id, consumer_type, 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



466
467
468
469
470
471
472
473
474
475
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 466

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



460
461
462
 
# File 'lib/oci/datacc/models/vm_cluster_network.rb', line 460

def to_s
  to_hash.to_s
end