Class: CloudsmithApi::Format

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/models/format.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Format

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
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
 
# File 'lib/cloudsmith-api/models/format.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'premium')
    self.premium = attributes[:'premium']
  end

  if attributes.has_key?(:'premium_plan_id')
    self.premium_plan_id = attributes[:'premium_plan_id']
  end

  if attributes.has_key?(:'premium_plan_name')
    self.premium_plan_name = attributes[:'premium_plan_name']
  end

  if attributes.has_key?(:'slug')
    self.slug = attributes[:'slug']
  end

  if attributes.has_key?(:'supports')
    self.supports = attributes[:'supports']
  end
end

Instance Attribute Details

#description ⇒ Object

Description of the package format



18
19
20
 
# File 'lib/cloudsmith-api/models/format.rb', line 18

def description
  @description
end

#distributions ⇒ Object

The distributions supported by this package format



21
22
23
 
# File 'lib/cloudsmith-api/models/format.rb', line 21

def distributions
  @distributions
end

#extensions ⇒ Object

A non-exhaustive list of extensions supported



24
25
26
 
# File 'lib/cloudsmith-api/models/format.rb', line 24

def extensions
  @extensions
end

#name ⇒ Object

Name for the package format



27
28
29
 
# File 'lib/cloudsmith-api/models/format.rb', line 27

def name
  @name
end

#premium ⇒ Object

If true the package format is a premium-only feature



30
31
32
 
# File 'lib/cloudsmith-api/models/format.rb', line 30

def premium
  @premium
end

#premium_plan_id ⇒ Object

The minimum plan id required for this package format



33
34
35
 
# File 'lib/cloudsmith-api/models/format.rb', line 33

def premium_plan_id
  @premium_plan_id
end

#premium_plan_name ⇒ Object

The minimum plan name required for this package format



36
37
38
 
# File 'lib/cloudsmith-api/models/format.rb', line 36

def premium_plan_name
  @premium_plan_name
end

#slug ⇒ Object

Slug for the package format



39
40
41
 
# File 'lib/cloudsmith-api/models/format.rb', line 39

def slug
  @slug
end

#supports ⇒ Object

Returns the value of attribute supports.



41
42
43
 
# File 'lib/cloudsmith-api/models/format.rb', line 41

def supports
  @supports
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cloudsmith-api/models/format.rb', line 44

def self.attribute_map
  {
    :'description' => :'description',
    :'distributions' => :'distributions',
    :'extensions' => :'extensions',
    :'name' => :'name',
    :'premium' => :'premium',
    :'premium_plan_id' => :'premium_plan_id',
    :'premium_plan_name' => :'premium_plan_name',
    :'slug' => :'slug',
    :'supports' => :'supports'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cloudsmith-api/models/format.rb', line 59

def self.swagger_types
  {
    :'description' => :'String',
    :'distributions' => :'Array<Distribution>',
    :'extensions' => :'Array<String>',
    :'name' => :'String',
    :'premium' => :'BOOLEAN',
    :'premium_plan_id' => :'String',
    :'premium_plan_name' => :'String',
    :'slug' => :'String',
    :'supports' => :'FormatSupport'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/cloudsmith-api/models/format.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      distributions == o.distributions &&
      extensions == o.extensions &&
      name == o.name &&
      premium == o.premium &&
      premium_plan_id == o.premium_plan_id &&
      premium_plan_name == o.premium_plan_name &&
      slug == o.slug &&
      supports == o.supports
end

#_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



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
250
251
252
253
 
# File 'lib/cloudsmith-api/models/format.rb', line 217

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CloudsmithApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/cloudsmith-api/models/format.rb', line 283

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

#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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/cloudsmith-api/models/format.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/cloudsmith-api/models/format.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/cloudsmith-api/models/format.rb', line 189

def hash
  [description, distributions, extensions, name, premium, premium_plan_id, premium_plan_name, slug, supports].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



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
 
# File 'lib/cloudsmith-api/models/format.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

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

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

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

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

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



263
264
265
 
# File 'lib/cloudsmith-api/models/format.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/cloudsmith-api/models/format.rb', line 269

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



257
258
259
 
# File 'lib/cloudsmith-api/models/format.rb', line 257

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



155
156
157
158
159
160
161
162
163
 
# File 'lib/cloudsmith-api/models/format.rb', line 155

def valid?
  return false if @description.nil?
  return false if @extensions.nil?
  return false if @name.nil?
  return false if @premium.nil?
  return false if @slug.nil?
  return false if @supports.nil?
  true
end