Class: LinodeOpenapiClient::Linode4PlacementGroup

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

Overview

Read-only Details on the [placement group](www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/) that this Linode belongs to. Empty if the Linode isn’t in a placement group.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Linode4PlacementGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::Linode4PlacementGroup` 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::Linode4PlacementGroup`. 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?(:'placement_group_policy')
    self.placement_group_policy = attributes[:'placement_group_policy']
  end

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

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

Instance Attribute Details

#id ⇒ Object

The placement group’s ID. You need to provide it for all operations impacting it.



26
27
28
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 26

def id
  @id
end

#label ⇒ Object

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



23
24
25
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 23

def label
  @label
end

#placement_group_policy ⇒ Object

How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ‘strict`. Don’t assign a new compute instance if it breaks the grouped-together or spread-apart model set by the ‘placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`). - `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it 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. <<LB>> > 📘 > > In rare cases, non-compliance can occur with a ‘strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.



20
21
22
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 20

def placement_group_policy
  @placement_group_policy
end

#placement_group_type ⇒ Object

__Filterable__, Read-only 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`.



29
30
31
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 29

def placement_group_type
  @placement_group_type
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



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

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



64
65
66
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 200

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



79
80
81
82
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      placement_group_policy == o.placement_group_policy &&
      label == o.label &&
      id == o.id &&
      placement_group_type == o.placement_group_type
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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 295

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


187
188
189
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 193

def hash
  [placement_group_policy, label, id, placement_group_type].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



118
119
120
121
122
123
124
125
126
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 118

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@label.nil? && @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



271
272
273
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 271

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 277

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



265
266
267
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 265

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



130
131
132
133
134
135
136
137
138
 
# File 'lib/linode_openapi_client/models/linode4_placement_group.rb', line 130

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