Class: CloudsmithApi::RpmUpstreamRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RpmUpstreamRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 143

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?(:'auth_mode')
    self.auth_mode = attributes[:'auth_mode']
  else
    self.auth_mode = 'None'
  end

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'gpg_verification')
    self.gpg_verification = attributes[:'gpg_verification']
  else
    self.gpg_verification = 'Allow All'
  end

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

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

  if attributes.has_key?(:'mode')
    self.mode = attributes[:'mode']
  else
    self.mode = 'Proxy Only'
  end

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

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

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

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

Instance Attribute Details

#auth_mode ⇒ Object

The authentication mode to use when accessing this upstream.



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

def auth_mode
  @auth_mode
end

#auth_secret ⇒ Object

Secret to provide with requests to upstream.



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

def auth_secret
  @auth_secret
end

#auth_username ⇒ Object

Username to provide with requests to upstream.



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

def auth_username
  @auth_username
end

#distro_version ⇒ Object

The distribution version that packages found on this upstream will be associated with.



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

def distro_version
  @distro_version
end

#extra_header_1 ⇒ Object

The key for extra header #1 to send to upstream.



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

def extra_header_1
  @extra_header_1
end

#extra_header_2 ⇒ Object

The key for extra header #2 to send to upstream.



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

def extra_header_2
  @extra_header_2
end

#extra_value_1 ⇒ Object

The value for extra header #1 to send to upstream. This is stored as plaintext, and is NOT encrypted.



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

def extra_value_1
  @extra_value_1
end

#extra_value_2 ⇒ Object

The value for extra header #2 to send to upstream. This is stored as plaintext, and is NOT encrypted.



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

def extra_value_2
  @extra_value_2
end

#gpg_key_inline ⇒ Object

A public GPG key to associate with packages found on this upstream. When using the Cloudsmith setup script, this GPG key will be automatically imported on your deployment machines to allow upstream packages to validate and install.



42
43
44
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 42

def gpg_key_inline
  @gpg_key_inline
end

#gpg_key_url ⇒ Object

When provided, Cloudsmith will fetch, validate, and associate a public GPG key found at the provided URL. When using the Cloudsmith setup script, this GPG key will be automatically imported on your deployment machines to allow upstream packages to validate and install.



45
46
47
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 45

def gpg_key_url
  @gpg_key_url
end

#gpg_verification ⇒ Object

The GPG signature verification mode for this upstream.



48
49
50
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 48

def gpg_verification
  @gpg_verification
end

#include_sources ⇒ Object

When checked, source packages will be available from this upstream.



51
52
53
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 51

def include_sources
  @include_sources
end

#is_active ⇒ Object

Whether or not this upstream is active and ready for requests.



54
55
56
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 54

def is_active
  @is_active
end

#mode ⇒ Object

The mode that this upstream should operate in. Upstream sources can be used to proxy resolved packages, as well as operate in a proxy/cache or cache only mode.



57
58
59
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 57

def mode
  @mode
end

#name ⇒ Object

A descriptive name for this upstream source. A shortened version of this name will be used for tagging cached packages retrieved from this upstream.



60
61
62
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 60

def name
  @name
end

#priority ⇒ Object

Upstream sources are selected for resolving requests by sequential order (1..n), followed by creation date.



63
64
65
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 63

def priority
  @priority
end

#upstream_url ⇒ Object

The URL for this upstream source. This must be a fully qualified URL including any path elements required to reach the root of the repository.



66
67
68
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 66

def upstream_url
  @upstream_url
end

#verify_ssl ⇒ Object

If enabled, SSL certificates are verified when requests are made to this upstream. It’s recommended to leave this enabled for all public sources to help mitigate Man-In-The-Middle (MITM) attacks. Please note this only applies to HTTPS upstreams.



69
70
71
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 69

def verify_ssl
  @verify_ssl
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 94

def self.attribute_map
  {
    :'auth_mode' => :'auth_mode',
    :'auth_secret' => :'auth_secret',
    :'auth_username' => :'auth_username',
    :'distro_version' => :'distro_version',
    :'extra_header_1' => :'extra_header_1',
    :'extra_header_2' => :'extra_header_2',
    :'extra_value_1' => :'extra_value_1',
    :'extra_value_2' => :'extra_value_2',
    :'gpg_key_inline' => :'gpg_key_inline',
    :'gpg_key_url' => :'gpg_key_url',
    :'gpg_verification' => :'gpg_verification',
    :'include_sources' => :'include_sources',
    :'is_active' => :'is_active',
    :'mode' => :'mode',
    :'name' => :'name',
    :'priority' => :'priority',
    :'upstream_url' => :'upstream_url',
    :'verify_ssl' => :'verify_ssl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 118

def self.swagger_types
  {
    :'auth_mode' => :'String',
    :'auth_secret' => :'String',
    :'auth_username' => :'String',
    :'distro_version' => :'String',
    :'extra_header_1' => :'String',
    :'extra_header_2' => :'String',
    :'extra_value_1' => :'String',
    :'extra_value_2' => :'String',
    :'gpg_key_inline' => :'String',
    :'gpg_key_url' => :'String',
    :'gpg_verification' => :'String',
    :'include_sources' => :'BOOLEAN',
    :'is_active' => :'BOOLEAN',
    :'mode' => :'String',
    :'name' => :'String',
    :'priority' => :'Integer',
    :'upstream_url' => :'String',
    :'verify_ssl' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_mode == o.auth_mode &&
      auth_secret == o.auth_secret &&
      auth_username == o.auth_username &&
      distro_version == o.distro_version &&
      extra_header_1 == o.extra_header_1 &&
      extra_header_2 == o.extra_header_2 &&
      extra_value_1 == o.extra_value_1 &&
      extra_value_2 == o.extra_value_2 &&
      gpg_key_inline == o.gpg_key_inline &&
      gpg_key_url == o.gpg_key_url &&
      gpg_verification == o.gpg_verification &&
      include_sources == o.include_sources &&
      is_active == o.is_active &&
      mode == o.mode &&
      name == o.name &&
      priority == o.priority &&
      upstream_url == o.upstream_url &&
      verify_ssl == o.verify_ssl
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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 353

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 419

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 332

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


319
320
321
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



325
326
327
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 325

def hash
  [auth_mode, auth_secret, auth_username, distro_version, extra_header_1, extra_header_2, extra_value_1, extra_value_2, gpg_key_inline, gpg_key_url, gpg_verification, include_sources, is_active, mode, name, priority, upstream_url, verify_ssl].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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 230

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

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

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



399
400
401
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 399

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



405
406
407
408
409
410
411
412
413
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 405

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



393
394
395
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 393

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



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cloudsmith-api/models/rpm_upstream_request.rb', line 249

def valid?
  auth_mode_validator = EnumAttributeValidator.new('String', ['None', 'Username and Password'])
  return false unless auth_mode_validator.valid?(@auth_mode)
  return false if @distro_version.nil?
  gpg_verification_validator = EnumAttributeValidator.new('String', ['Allow All', 'Warn on Invalid', 'Reject Invalid'])
  return false unless gpg_verification_validator.valid?(@gpg_verification)
  mode_validator = EnumAttributeValidator.new('String', ['Proxy Only', 'Cache and Proxy'])
  return false unless mode_validator.valid?(@mode)
  return false if @name.nil?
  return false if @upstream_url.nil?
  true
end