Class: LinodeOpenapiClient::PostRebuildLinodeInstanceRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostRebuildLinodeInstanceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 87

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

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

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

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

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

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

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

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

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



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

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.



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

def authorized_users
  @authorized_users
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`.



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

def booted
  @booted
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_rebuild_linode_instance_request.rb', line 36

def image
  @image
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

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



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

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.



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

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.



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

def stackscript_id
  @stackscript_id
end

#type ⇒ Object

The ID of the [Linode type](techdocs.akamai.com/linode-api/reference/get-linode-types) to resize to with this request.



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

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



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
295
296
297
298
299
300
301
302
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 265

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



60
61
62
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 45

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 241

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



80
81
82
83
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 65

def self.openapi_types
  {
    :'authorized_users' => :'Array<String>',
    :'root_pass' => :'String',
    :'booted' => :'Boolean',
    :'stackscript_data' => :'Object',
    :'metadata' => :'PostLinodeInstanceRequestAllOfMetadata',
    :'stackscript_id' => :'Integer',
    :'image' => :'String',
    :'authorized_keys' => :'Array<String>',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 212

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 336

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


228
229
230
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 234

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 149

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

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



312
313
314
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 318

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



306
307
308
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 306

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



173
174
175
176
177
178
179
180
 
# File 'lib/linode_openapi_client/models/post_rebuild_linode_instance_request.rb', line 173

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @root_pass.nil?
  return false if @root_pass.to_s.length > 128
  return false if @root_pass.to_s.length < 7
  return false if @image.nil?
  true
end