Class: LinodeOpenapiClient::PostLinodeInstanceRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostLinodeInstanceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 141

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

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

  if attributes.key?(:'booted')
    self.booted = attributes[:'booted']
  else
    self.booted = true
  end

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

  if attributes.key?(:'authorized_users')
    if (value = attributes[:'authorized_users']).is_a?(Array)
      self.authorized_users = value
    end
  end

  if attributes.key?(:'authorized_keys')
    if (value = attributes[:'authorized_keys']).is_a?(Array)
      self.authorized_keys = value
    end
  end

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

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

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

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

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

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

  if attributes.key?(:'swap_size')
    self.swap_size = attributes[:'swap_size']
  else
    self.swap_size = 512
  end

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

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

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

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.key?(:'interfaces')
    if (value = attributes[:'interfaces']).is_a?(Array)
      self.interfaces = value
    end
  end

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

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

Instance Attribute Details

#authorized_keys ⇒ Object

Write-only A list of public SSH keys that will be automatically appended to the root user’s ‘~/.ssh/authorized_keys` file when deploying from an Image.



33
34
35
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 33

def authorized_keys
  @authorized_keys
end

#authorized_users ⇒ Object

Write-only A list of usernames. If the usernames have associated SSH keys, the keys will be appended to the root users ‘~/.ssh/authorized_keys` file automatically when deploying from an Image.



30
31
32
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 30

def authorized_users
  @authorized_users
end

#backup_id ⇒ Object

A Backup ID from another Linode’s available backups. Your User must have ‘read_write` access to that Linode, the Backup must have a `status` of `successful`, and the Linode must be deployed to the same `region` as the Backup. Run [List backups](techdocs.akamai.com/linode-api/reference/get-backups) for a Linode’s available backups. This field and the ‘image` field are mutually exclusive.



59
60
61
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 59

def backup_id
  @backup_id
end

#backups_enabled ⇒ Object

If this field is set to ‘true`, the created Linode will automatically be enrolled in the Linode Backup service. This will incur an additional charge. The cost for the Backup service is dependent on the Type of Linode deployed. This option is always treated as `true` if the account-wide `backups_enabled` setting is `true`. See [Get account settings](techdocs.akamai.com/linode-api/reference/get-account-settings) for more information. Backup pricing is included in the response from [List types](techdocs.akamai.com/linode-api/reference/get-linode-types)



45
46
47
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 45

def backups_enabled
  @backups_enabled
end

#booted ⇒ Object

Write-only This field defaults to ‘true` if the Linode is created with an Image or from a Backup. If it is deployed from an Image or a Backup and you wish it to remain `offline` after deployment, set this to `false`.



24
25
26
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 24

def booted
  @booted
end

#firewall_id ⇒ Object

The ‘id` of the Firewall to attach this Linode to upon creation.



56
57
58
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 56

def firewall_id
  @firewall_id
end

#group ⇒ Object

__Filterable__ A deprecated property denoting a group label for this Linode.



62
63
64
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 62

def group
  @group
end

#image ⇒ Object

An Image ID to deploy the Linode Disk from. Run the [List images](techdocs.akamai.com/linode-api/reference/get-images) operation with authentication to view all available Images. Official Linode Images start with ‘linode/`, while your Account’s Images start with ‘private/`. Creating a disk from a Private Image requires `read_only` or `read_write` permissions for that Image. Run the [Update a user’s grants](techdocs.akamai.com/linode-api/reference/put-user-grants) operation to adjust permissions for an Account Image.



36
37
38
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 36

def image
  @image
end

#interfaces ⇒ Object

An array of Network Interfaces to add to this Linode’s Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode’s network Interfaces is configured: - First [0]: eth0 - Second [1]: eth1 - Third [2]: eth2 When updating a Linode’s Interfaces, _each Interface must be redefined_. An empty ‘interfaces` array results in a default `public` type Interface configuration only. If no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration. __Note__. Changes to Linode Interface configurations can be enabled by rebooting the Linode. `vpc` details See the [VPC documentation](www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. `vlan` details - Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support. - See the [VLANs Overview](www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.



68
69
70
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 68

def interfaces
  @interfaces
end

#label ⇒ Object

__Filterable__ The Linode’s label is for display purposes only. If no label is provided for a Linode, a default will be assigned. Linode labels have the following constraints: - Must begin and end with an alphanumeric character. - May only consist of alphanumeric characters, hyphens (‘-`), underscores (`_`) or periods (`.`). - Cannot have two hyphens (`–`), underscores (`__`) or periods (`..`) in a row.



42
43
44
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 42

def label
  @label
end

#metadata ⇒ Object

Returns the value of attribute metadata.



18
19
20
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 18

def metadata
  @metadata
end

#placement_group ⇒ Object

Returns the value of attribute placement_group.



50
51
52
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 50

def placement_group
  @placement_group
end

#private_ip ⇒ Object

If true, the created Linode will have private networking enabled and assigned a private IPv4 address.



74
75
76
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 74

def private_ip
  @private_ip
end

#region ⇒ Object

The [region](techdocs.akamai.com/linode-api/reference/get-regions) where the Linode will be located.



71
72
73
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 71

def region
  @region
end

#root_pass ⇒ Object

Write-only This sets the root user’s password on a newly-created Linode Disk when deploying from an Image. - __Required__ when creating a Linode Disk from an Image, including when using a StackScript. - Must meet a password strength score requirement that is calculated internally by the API. If the strength requirement is not met, you will receive a ‘Password does not meet strength requirement` error.



27
28
29
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 27

def root_pass
  @root_pass
end

#stackscript_data ⇒ Object

This field is required only if the StackScript being deployed requires input data from the User for successful completion. See [User Defined Fields (UDFs)](www.linode.com/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs) for more details. This field is required to be valid JSON. Total length cannot exceed 65,535 characters.



21
22
23
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 21

def stackscript_data
  @stackscript_data
end

#stackscript_id ⇒ Object

A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. A compatible ‘image` is required to use a StackScript. To get a list of available StackScript and their permitted Images, run [List StackScripts](techdocs.akamai.com/linode-api/reference/get-stack-scripts). This field cannot be used when deploying from a Backup or a Private Image.



39
40
41
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 39

def stackscript_id
  @stackscript_id
end

#swap_size ⇒ Object

When deploying from an Image, this field is optional, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.



53
54
55
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 53

def swap_size
  @swap_size
end

#tags ⇒ Object

__Filterable__ An array of tags applied to this object. Tags are for organizational purposes only.



65
66
67
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 65

def tags
  @tags
end

#type ⇒ Object

The [Linode type](techdocs.akamai.com/linode-api/reference/get-linode-types) of the Linode you are creating.



48
49
50
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 48

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 447

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



103
104
105
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 77

def self.attribute_map
  {
    :'metadata' => :'metadata',
    :'stackscript_data' => :'stackscript_data',
    :'booted' => :'booted',
    :'root_pass' => :'root_pass',
    :'authorized_users' => :'authorized_users',
    :'authorized_keys' => :'authorized_keys',
    :'image' => :'image',
    :'stackscript_id' => :'stackscript_id',
    :'label' => :'label',
    :'backups_enabled' => :'backups_enabled',
    :'type' => :'type',
    :'placement_group' => :'placement_group',
    :'swap_size' => :'swap_size',
    :'firewall_id' => :'firewall_id',
    :'backup_id' => :'backup_id',
    :'group' => :'group',
    :'tags' => :'tags',
    :'interfaces' => :'interfaces',
    :'region' => :'region',
    :'private_ip' => :'private_ip'
  }
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



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 423

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



134
135
136
137
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 134

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 108

def self.openapi_types
  {
    :'metadata' => :'PostLinodeInstanceRequestAllOfMetadata',
    :'stackscript_data' => :'Object',
    :'booted' => :'Boolean',
    :'root_pass' => :'String',
    :'authorized_users' => :'Array<String>',
    :'authorized_keys' => :'Array<String>',
    :'image' => :'String',
    :'stackscript_id' => :'Integer',
    :'label' => :'String',
    :'backups_enabled' => :'Boolean',
    :'type' => :'String',
    :'placement_group' => :'PostLinodeInstanceRequestAllOfPlacementGroup',
    :'swap_size' => :'Integer',
    :'firewall_id' => :'Integer',
    :'backup_id' => :'Integer',
    :'group' => :'String',
    :'tags' => :'Array<String>',
    :'interfaces' => :'Array<PostLinodeInstanceRequestAllOfInterfacesInner>',
    :'region' => :'String',
    :'private_ip' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      metadata == o.metadata &&
      stackscript_data == o.stackscript_data &&
      booted == o.booted &&
      root_pass == o.root_pass &&
      authorized_users == o.authorized_users &&
      authorized_keys == o.authorized_keys &&
      image == o.image &&
      stackscript_id == o.stackscript_id &&
      label == o.label &&
      backups_enabled == o.backups_enabled &&
      type == o.type &&
      placement_group == o.placement_group &&
      swap_size == o.swap_size &&
      firewall_id == o.firewall_id &&
      backup_id == o.backup_id &&
      group == o.group &&
      tags == o.tags &&
      interfaces == o.interfaces &&
      region == o.region &&
      private_ip == o.private_ip
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



518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 518

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


410
411
412
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 410

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



416
417
418
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 416

def hash
  [metadata, stackscript_data, booted, root_pass, authorized_users, authorized_keys, image, stackscript_id, label, backups_enabled, type, placement_group, swap_size, firewall_id, backup_id, group, tags, interfaces, region, private_ip].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@root_pass.nil? && @root_pass.to_s.length > 128
    invalid_properties.push('invalid value for "root_pass", the character length must be smaller than or equal to 128.')
  end

  if !@root_pass.nil? && @root_pass.to_s.length < 7
    invalid_properties.push('invalid value for "root_pass", the character length must be great than or equal to 7.')
  end

  if !@label.nil? && @label.to_s.length > 64
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 64.')
  end

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

  pattern = Regexp.new(/^[a-zA-Z]((?!--|__|..)[a-zA-Z0-9-_.])+$/)
  if !@label.nil? && @label !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  end

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

  if !@interfaces.nil? && @interfaces.length > 3
    invalid_properties.push('invalid value for "interfaces", number of items must be less than or equal to 3.')
  end

  if !@interfaces.nil? && @interfaces.length < 1
    invalid_properties.push('invalid value for "interfaces", number of items must be greater than or equal to 1.')
  end

  if @region.nil?
    invalid_properties.push('invalid value for "region", region cannot be nil.')
  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



494
495
496
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 494

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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 500

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



488
489
490
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 488

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/linode_openapi_client/models/post_linode_instance_request.rb', line 298

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@root_pass.nil? && @root_pass.to_s.length > 128
  return false if !@root_pass.nil? && @root_pass.to_s.length < 7
  return false if !@label.nil? && @label.to_s.length > 64
  return false if !@label.nil? && @label.to_s.length < 3
  return false if !@label.nil? && @label !~ Regexp.new(/^[a-zA-Z]((?!--|__|..)[a-zA-Z0-9-_.])+$/)
  return false if @type.nil?
  return false if !@interfaces.nil? && @interfaces.length > 3
  return false if !@interfaces.nil? && @interfaces.length < 1
  return false if @region.nil?
  true
end