Class: LinodeOpenapiClient::PostAddLinodeDiskRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostAddLinodeDiskRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 110

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

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

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

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

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

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

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

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

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  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.



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

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.



37
38
39
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 37

def authorized_users
  @authorized_users
end

#filesystem ⇒ Object

The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. - swap - Linux swap area. - ext3 - The ext3 journaling filesystem for Linux. - ext4 - The ext4 journaling filesystem for Linux. - initrd - initrd (uncompressed initrd, ext2, max 32 MB).



40
41
42
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 40

def filesystem
  @filesystem
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.



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

def image
  @image
end

#label ⇒ Object

__Filterable__ The Disk’s label is for display purposes only.



43
44
45
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 43

def label
  @label
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.



31
32
33
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 31

def root_pass
  @root_pass
end

#size ⇒ Object

__Filterable__ The size of the Disk in MB. Images require a minimum size. Run the [Get an image](techdocs.akamai.com/linode-api/reference/get-image) operation to view its size.



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

def size
  @size
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.



34
35
36
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 34

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.



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

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 319

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



83
84
85
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 68

def self.attribute_map
  {
    :'authorized_keys' => :'authorized_keys',
    :'size' => :'size',
    :'stackscript_id' => :'stackscript_id',
    :'image' => :'image',
    :'root_pass' => :'root_pass',
    :'stackscript_data' => :'stackscript_data',
    :'authorized_users' => :'authorized_users',
    :'filesystem' => :'filesystem',
    :'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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 295

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 88

def self.openapi_types
  {
    :'authorized_keys' => :'Array<String>',
    :'size' => :'Integer',
    :'stackscript_id' => :'Integer',
    :'image' => :'String',
    :'root_pass' => :'String',
    :'stackscript_data' => :'Object',
    :'authorized_users' => :'Array<String>',
    :'filesystem' => :'String',
    :'label' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorized_keys == o.authorized_keys &&
      size == o.size &&
      stackscript_id == o.stackscript_id &&
      image == o.image &&
      root_pass == o.root_pass &&
      stackscript_data == o.stackscript_data &&
      authorized_users == o.authorized_users &&
      filesystem == o.filesystem &&
      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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 390

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


282
283
284
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



288
289
290
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 288

def hash
  [authorized_keys, size, stackscript_id, image, root_pass, stackscript_data, authorized_users, filesystem, 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



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

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

  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 > 48
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 48.')
  end

  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



366
367
368
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 372

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



360
361
362
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 360

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



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/linode_openapi_client/models/post_add_linode_disk_request.rb', line 196

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @size.nil?
  return false if !@root_pass.nil? && @root_pass.to_s.length > 128
  return false if !@root_pass.nil? && @root_pass.to_s.length < 7
  filesystem_validator = EnumAttributeValidator.new('String', ["raw", "swap", "ext3", "ext4", "initrd"])
  return false unless filesystem_validator.valid?(@filesystem)
  return false if !@label.nil? && @label.to_s.length > 48
  return false if !@label.nil? && @label.to_s.length < 1
  true
end