Class: LinodeOpenapiClient::PostAddStackScriptRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostAddStackScriptRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

Read-only The date this StackScript was created.



52
53
54
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 52

def created
  @created
end

#deployments_active ⇒ Object

Read-only Count of currently active, deployed Linodes created from this StackScript.



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

def deployments_active
  @deployments_active
end

#deployments_total ⇒ Object

__Filterable__, Read-only The total number of times this StackScript has been deployed.



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

def deployments_total
  @deployments_total
end

#description ⇒ Object

__Filterable__ A description for the StackScript.



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

def description
  @description
end

#id ⇒ Object

Read-only The unique ID of this StackScript.



58
59
60
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 58

def id
  @id
end

#images ⇒ Object

An array of Image IDs. These are the Images that can be deployed with this StackScript. ‘any/all` indicates that all available Images, including private Images, are accepted.



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

def images
  @images
end

#is_public ⇒ Object

__Filterable__ This determines whether other users can use your StackScript. __Once a StackScript is made public, it cannot be made private.__



55
56
57
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 55

def is_public
  @is_public
end

#label ⇒ Object

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



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

def label
  @label
end

#mine ⇒ Object

__Filterable__, Read-only Returns ‘true` if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript.



61
62
63
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 61

def mine
  @mine
end

#rev_note ⇒ Object

__Filterable__ This field allows you to add notes for the set of revisions made to this StackScript.



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

def rev_note
  @rev_note
end

#script ⇒ Object

The script to execute when provisioning a new Linode with this StackScript.



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

def script
  @script
end

#updated ⇒ Object

Read-only The date this StackScript was last updated.



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

def updated
  @updated
end

#user_defined_fields ⇒ Object

Read-only This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See [Declare User-Defined Fields (UDFs)](www.linode.com/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs) for more information.



46
47
48
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 46

def user_defined_fields
  @user_defined_fields
end

#user_gravatar_id ⇒ Object

Read-only The Gravatar ID for the User who created the StackScript.



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

def user_gravatar_id
  @user_gravatar_id
end

#username ⇒ Object

Read-only The User who created the StackScript.



49
50
51
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 49

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



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
357
358
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 321

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



85
86
87
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 64

def self.attribute_map
  {
    :'updated' => :'updated',
    :'description' => :'description',
    :'label' => :'label',
    :'deployments_total' => :'deployments_total',
    :'deployments_active' => :'deployments_active',
    :'user_gravatar_id' => :'user_gravatar_id',
    :'script' => :'script',
    :'images' => :'images',
    :'rev_note' => :'rev_note',
    :'user_defined_fields' => :'user_defined_fields',
    :'username' => :'username',
    :'created' => :'created',
    :'is_public' => :'is_public',
    :'id' => :'id',
    :'mine' => :'mine'
  }
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



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

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



111
112
113
114
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 90

def self.openapi_types
  {
    :'updated' => :'Time',
    :'description' => :'String',
    :'label' => :'String',
    :'deployments_total' => :'Integer',
    :'deployments_active' => :'Integer',
    :'user_gravatar_id' => :'String',
    :'script' => :'String',
    :'images' => :'Array<String>',
    :'rev_note' => :'String',
    :'user_defined_fields' => :'Array<PostAddStackScriptRequestAllOfUserDefinedFieldsInner>',
    :'username' => :'String',
    :'created' => :'Time',
    :'is_public' => :'Boolean',
    :'id' => :'Integer',
    :'mine' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      updated == o.updated &&
      description == o.description &&
      label == o.label &&
      deployments_total == o.deployments_total &&
      deployments_active == o.deployments_active &&
      user_gravatar_id == o.user_gravatar_id &&
      script == o.script &&
      images == o.images &&
      rev_note == o.rev_note &&
      user_defined_fields == o.user_defined_fields &&
      username == o.username &&
      created == o.created &&
      is_public == o.is_public &&
      id == o.id &&
      mine == o.mine
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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 392

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


284
285
286
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 290

def hash
  [updated, description, label, deployments_total, deployments_active, user_gravatar_id, script, images, rev_note, user_defined_fields, username, created, is_public, id, mine].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



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

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

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

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

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

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



368
369
370
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 368

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 374

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



362
363
364
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 362

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



232
233
234
235
236
237
238
239
240
 
# File 'lib/linode_openapi_client/models/post_add_stack_script_request.rb', line 232

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