Class: LinodeOpenapiClient::PostCloneLinodeInstanceRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostCloneLinodeInstanceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 96

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

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

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

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

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

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

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

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

Instance Attribute Details

#backups_enabledObject

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. Pricing is included in the response from [List types](techdocs.akamai.com/linode-api/reference/get-linode-types). - Can only be included when cloning to a new Linode.



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

def backups_enabled
  @backups_enabled
end

#configsObject

An array of configuration profile IDs. - If the ‘configs` parameter __is not provided__, then __all configuration profiles and their associated disks will be cloned__ from the source Linode. Any disks specified by the `disks` parameter will also be cloned. - __If an empty array is provided__ for the `configs` parameter, then __no configuration profiles (nor their associated disks) will be cloned__ from the source Linode. Any disks specified by the `disks` parameter will still be cloned. - __If a non-empty array is provided__ for the `configs` parameter, then __the configuration profiles specified in the array (and their associated disks) will be cloned__ from the source Linode. Any disks specified by the `disks` parameter will also be cloned.



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

def configs
  @configs
end

#disksObject

An array of disk IDs. - If the ‘disks` parameter __is not provided__, then __no extra disks will be cloned__ from the source Linode. All disks associated with the configuration profiles specified by the `configs` parameter will still be cloned. - __If an empty array is provided__ for the `disks` parameter, then __no extra disks will be cloned__ from the source Linode. All disks associated with the configuration profiles specified by the `configs` parameter will still be cloned. - __If a non-empty array is provided__ for the `disks` parameter, then __the disks specified in the array will be cloned__ from the source Linode, in addition to any disks associated with the configuration profiles specified by the `configs` parameter.



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

def disks
  @disks
end

#groupObject

A label used to group Linodes for display. Linodes are not required to have a group.



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

def group
  @group
end

#labelObject

The label to assign this Linode when cloning to a new Linode. - Can only be provided when cloning to a new Linode. - Defaults to ‘linode`.



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

def label
  @label
end

#linode_idObject

If an existing Linode is the target for the clone, the ID of that Linode. The existing Linode must have enough resources to accept the clone.



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

def linode_id
  @linode_id
end

#metadataObject

Returns the value of attribute metadata.



47
48
49
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 47

def 
  @metadata
end

#placement_groupObject

Returns the value of attribute placement_group.



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

def placement_group
  @placement_group
end

#private_ipObject

If true, the created Linode will have private networking enabled and assigned a private IPv4 address. - Can only be provided when cloning to a new Linode.



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

def private_ip
  @private_ip
end

#regionObject

This is the Region where the Linode will be deployed. To view all available Regions you can deploy to, run [List regions](techdocs.akamai.com/linode-api/reference/get-regions). - Region can only be provided and is required when cloning to a new Linode.



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

def region
  @region
end

#typeObject

A Linode’s Type determines what resources are available to it, including disk space, memory, and virtual cpus. The amounts available to a specific Linode are returned as ‘specs` on the Linode object. To view all available Linode Types you can deploy with, run [List types](techdocs.akamai.com/linode-api/reference/get-linode-types). - Type can only be provided and is required when cloning to a new Linode.



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

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



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
295
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 258

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_attributesObject

Returns all the JSON keys this model knows about



67
68
69
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 50

def self.attribute_map
  {
    :'placement_group' => :'placement_group',
    :'configs' => :'configs',
    :'region' => :'region',
    :'private_ip' => :'private_ip',
    :'label' => :'label',
    :'backups_enabled' => :'backups_enabled',
    :'type' => :'type',
    :'linode_id' => :'linode_id',
    :'group' => :'group',
    :'disks' => :'disks',
    :'metadata' => :'metadata'
  }
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 234

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_nullableObject

List of attributes with nullable: true



89
90
91
92
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 89

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

.openapi_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 72

def self.openapi_types
  {
    :'placement_group' => :'PostCloneLinodeInstanceRequestPlacementGroup',
    :'configs' => :'Array<Integer>',
    :'region' => :'String',
    :'private_ip' => :'Boolean',
    :'label' => :'String',
    :'backups_enabled' => :'Boolean',
    :'type' => :'String',
    :'linode_id' => :'Integer',
    :'group' => :'String',
    :'disks' => :'Array<Integer>',
    :'metadata' => :'PostLinodeInstanceRequestAllOfMetadata'
  }
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
211
212
213
214
215
216
217
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      placement_group == o.placement_group &&
      configs == o.configs &&
      region == o.region &&
      private_ip == o.private_ip &&
      label == o.label &&
      backups_enabled == o.backups_enabled &&
      type == o.type &&
      linode_id == o.linode_id &&
      group == o.group &&
      disks == o.disks &&
       == o.
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



329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 329

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


221
222
223
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 221

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



227
228
229
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 227

def hash
  [placement_group, configs, region, private_ip, label, backups_enabled, type, linode_id, group, disks, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 160

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



305
306
307
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 305

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 311

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



299
300
301
# File 'lib/linode_openapi_client/models/post_clone_linode_instance_request.rb', line 299

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@label.nil? && @label.to_s.length > 64
  return false if !@label.nil? && @label.to_s.length < 3
  true
end