Class: OCI::Core::Models::CreateClusterNetworkDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_cluster_network_details.rb

Overview

The data to create a cluster network with instance pools.

Use cluster networks with instance pools when you want predictable capacity for a specific number of identical instances that are managed as a group.

For details about creating compute clusters, which let you manage instances in the RDMA network independently of each other or use different types of instances in the network group, see create_compute_cluster_details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateClusterNetworkDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



104
105
106
107
108
109
110
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 104

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

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

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

  self.placement_configuration = attributes[:'placementConfiguration'] if attributes[:'placementConfiguration']

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

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

  self.cluster_configuration = attributes[:'clusterConfiguration'] if attributes[:'clusterConfiguration']

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

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

Instance Attribute Details

#cluster_configuration ⇒ OCI::Core::Models::ClusterConfigurationDetails

Returns:



59
60
61
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 59

def cluster_configuration
  @cluster_configuration
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 23

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. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


31
32
33
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 31

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 37

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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


45
46
47
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 45

def freeform_tags
  @freeform_tags
end

#instance_pools ⇒ Array<OCI::Core::Models::CreateClusterNetworkInstancePoolDetails>

[Required] The data to create the instance pools in the cluster network.

Each cluster network can have one instance pool.

Returns:



52
53
54
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 52

def instance_pools
  @instance_pools
end

#placement_configuration ⇒ OCI::Core::Models::ClusterNetworkPlacementConfigurationDetails

This attribute is required.

Returns:



56
57
58
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 56

def placement_configuration
  @placement_configuration
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
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'instance_pools': :'instancePools',
    'placement_configuration': :'placementConfiguration',
    'cluster_configuration': :'clusterConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'instance_pools': :'Array<OCI::Core::Models::CreateClusterNetworkInstancePoolDetails>',
    'placement_configuration': :'OCI::Core::Models::ClusterNetworkPlacementConfigurationDetails',
    'cluster_configuration': :'OCI::Core::Models::ClusterConfigurationDetails'
    # 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



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 160

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    instance_pools == other.instance_pools &&
    placement_configuration == other.placement_configuration &&
    cluster_configuration == other.cluster_configuration
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 196

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


176
177
178
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 176

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 185

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, instance_pools, placement_configuration, cluster_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 229

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



223
224
225
 
# File 'lib/oci/core/models/create_cluster_network_details.rb', line 223

def to_s
  to_hash.to_s
end