Class: LinodeOpenapiClient::PostPlacementGroupRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/post_placement_group_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostPlacementGroupRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::PostPlacementGroupRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LinodeOpenapiClient::PostPlacementGroupRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'region')
    self.region = attributes[:'region']
  else
    self.region = nil
  end

  if attributes.key?(:'placement_group_policy')
    self.placement_group_policy = attributes[:'placement_group_policy']
  else
    self.placement_group_policy = nil
  end

  if attributes.key?(:'placement_group_type')
    self.placement_group_type = attributes[:'placement_group_type']
  else
    self.placement_group_type = nil
  end

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  else
    self.label = nil
  end
end

Instance Attribute Details

#label ⇒ Object

A unique name for the placement group. A placement group ‘label` has the following constraints: - It needs to begin and end with an alphanumeric character. - It can only consist of alphanumeric characters, hyphens (`-`), underscores (`_`), or periods (`.`).



28
29
30
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 28

def label
  @label
end

#placement_group_policy ⇒ Object

How requests to add future compute instances to your placement group are handled: - ‘strict`. Don’t add a compute instance if it breaks the grouped-together or spread-apart model set by your ‘placement_group_type`. For example, with `anti-affinity:local` as your `placement_group_type`, assume it already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that’s on the same host as one of the existing three, an error is thrown and the system won’t add it. Ensures the placement group stays compliant with your selected model. - ‘flexible`. Add a new compute instance, even if it breaks the grouped-together or spread-apart model set by your `placement_group_type`. Breaking the model makes the placement group non-compliant. You need to wait for Akamai to move the offending compute instances to make the group compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn’t an immediate concern. > 📘 > > Once you create a placement group, you can’t change its ‘placement_group_policy` setting.



22
23
24
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 22

def placement_group_policy
  @placement_group_policy
end

#placement_group_type ⇒ Object

How compute instances are distributed in your placement group. A ‘placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency. > 📘 > > Currently, only `anti_affinity:local` is available for `placement_group_type`.



25
26
27
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 25

def placement_group_type
  @placement_group_type
end

#region ⇒ Object

The data center that houses the compute instances you want to add to your placement group. Run the [List Linodes](techdocs.akamai.com/linode-api/reference/get-linode-instances) operation to view your compute instances and store the ‘region` identifier.



19
20
21
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 19

def region
  @region
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 251

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 53

def self.attribute_map
  {
    :'region' => :'region',
    :'placement_group_policy' => :'placement_group_policy',
    :'placement_group_type' => :'placement_group_type',
    :'label' => :'label'
  }
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 227

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 78

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 68

def self.openapi_types
  {
    :'region' => :'String',
    :'placement_group_policy' => :'String',
    :'placement_group_type' => :'String',
    :'label' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      region == o.region &&
      placement_group_policy == o.placement_group_policy &&
      placement_group_type == o.placement_group_type &&
      label == o.label
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 322

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


214
215
216
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 220

def hash
  [region, placement_group_policy, placement_group_type, label].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 125

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @region.nil?
    invalid_properties.push('invalid value for "region", region cannot be nil.')
  end

  if @placement_group_policy.nil?
    invalid_properties.push('invalid value for "placement_group_policy", placement_group_policy cannot be nil.')
  end

  if @placement_group_type.nil?
    invalid_properties.push('invalid value for "placement_group_type", placement_group_type cannot be nil.')
  end

  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

  if @label.to_s.length < 1
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 298

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 304

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



292
293
294
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 292

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/linode_openapi_client/models/post_placement_group_request.rb', line 153

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @region.nil?
  return false if @placement_group_policy.nil?
  placement_group_policy_validator = EnumAttributeValidator.new('String', ["strict", "flexible"])
  return false unless placement_group_policy_validator.valid?(@placement_group_policy)
  return false if @placement_group_type.nil?
  placement_group_type_validator = EnumAttributeValidator.new('String', ["anti_affinity:local"])
  return false unless placement_group_type_validator.valid?(@placement_group_type)
  return false if @label.nil?
  return false if @label.to_s.length < 1
  true
end