Class: OCI::Datacc::Models::GenerateRecommendedVmClusterNetworkDetails

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

Overview

Generates a recommended VM cluster network configuration for VM cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateRecommendedVmClusterNetworkDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :infrastructure_id (String) —

    The value to assign to the #infrastructure_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :node_count (Integer) —

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

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

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

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
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
159
160
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
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 116

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 19

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


53
54
55
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 53

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) 


23
24
25
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 23

def display_name
  @display_name
end

#dns_servers ⇒ Array<String>

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

Returns:

  • (Array<String>) 


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

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


59
60
61
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 59

def freeform_tags
  @freeform_tags
end

#infrastructure_id ⇒ String

[Required] The OCID of the Database Infrastructure.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 14

def infrastructure_id
  @infrastructure_id
end

#listener_port ⇒ Integer

The listener TCP/IP port.

Returns:

  • (Integer) 


31
32
33
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 31

def listener_port
  @listener_port
end

#listener_port_ssl ⇒ Integer

The listener TCP/IP SSL port. Default is 2484.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 35

def listener_port_ssl
  @listener_port_ssl
end

#node_count ⇒ Integer

Count of virtual machines in this VM cluster.

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 27

def node_count
  @node_count
end

#ntp_servers ⇒ Array<String>

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

Returns:

  • (Array<String>) 


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

def ntp_servers
  @ntp_servers
end

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

[Required] Details of the client and backup networks.

Returns:



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

def vm_networks
  @vm_networks
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'infrastructure_id': :'infrastructureId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'node_count': :'nodeCount',
    'listener_port': :'listenerPort',
    'listener_port_ssl': :'listenerPortSsl',
    'vm_networks': :'vmNetworks',
    'dns_servers': :'dnsServers',
    'ntp_servers': :'ntpServers',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 81

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'infrastructure_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'node_count': :'Integer',
    'listener_port': :'Integer',
    'listener_port_ssl': :'Integer',
    'vm_networks': :'Array<OCI::Datacc::Models::InfoVmNetworkDetails>',
    'dns_servers': :'Array<String>',
    'ntp_servers': :'Array<String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, 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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 196

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

  self.class == other.class &&
    infrastructure_id == other.infrastructure_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    node_count == other.node_count &&
    listener_port == other.listener_port &&
    listener_port_ssl == other.listener_port_ssl &&
    vm_networks == other.vm_networks &&
    dns_servers == other.dns_servers &&
    ntp_servers == other.ntp_servers &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 236

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


216
217
218
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 216

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 225

def hash
  [infrastructure_id, compartment_id, display_name, node_count, listener_port, listener_port_ssl, vm_networks, dns_servers, ntp_servers, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 269

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



263
264
265
 
# File 'lib/oci/datacc/models/generate_recommended_vm_cluster_network_details.rb', line 263

def to_s
  to_hash.to_s
end