Class: PulpDebClient::DebAptRemote

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_deb_client/models/deb_apt_remote.rb

Overview

A Serializer for AptRemote.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DebAptRemote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
254
255
256
257
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 193

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#architecturesObject

Whitespace separated list of architectures to sync If none are supplied, all that are available will be synchronized. A list of valid architecture specification strings can be found by running "dpkg-architecture -L". A sync will download the intersection of the list of architectures provided via this field and those provided by the relevant "Release" file. Architecture="all" is always synchronized and does not need to be provided here.



84
85
86
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 84

def architectures
  @architectures
end

#ca_certObject

A PEM encoded CA certificate used to validate the server certificate presented by the remote server.



25
26
27
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 25

def ca_cert
  @ca_cert
end

#client_certObject

A PEM encoded client certificate used for authentication.



28
29
30
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 28

def client_cert
  @client_cert
end

#client_keyObject

A PEM encoded private key used for authentication.



31
32
33
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 31

def client_key
  @client_key
end

#componentsObject

Whitespace separatet list of components to sync. If none are supplied, all that are available will be synchronized. Leave blank for repositores using "flat repository format".



81
82
83
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 81

def components
  @components
end

#connect_timeoutObject

aiohttp.ClientTimeout.connect (q.v.) for download-connections.



63
64
65
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 63

def connect_timeout
  @connect_timeout
end

#distributionsObject

Whitespace separated list of distributions to sync. The distribution is the path from the repository root to the "Release" file you want to access. This is often, but not always, equal to either the codename or the suite of the release you want to sync. If the repository you are trying to sync uses "flat repository format", the distribution must end with a "/". Based on "/etc/apt/sources.list" syntax.



78
79
80
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 78

def distributions
  @distributions
end

#download_concurrencyObject

Total number of simultaneous connections.



54
55
56
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 54

def download_concurrency
  @download_concurrency
end

#gpgkeyObject

Gpg public key to verify origin releases against



96
97
98
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 96

def gpgkey
  @gpgkey
end

#headersObject

Headers for aiohttp.Clientsession



72
73
74
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 72

def headers
  @headers
end

#ignore_missing_package_indicesObject

By default, upstream repositories that declare architectures and corresponding package indices in their Release files without actually publishing them, will fail to synchronize. Set this flag to True to allow the synchronization of such "partial mirrors" instead. Alternatively, you could make your remote filter by architectures for which the upstream repository does have indices.



99
100
101
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 99

def ignore_missing_package_indices
  @ignore_missing_package_indices
end

#nameObject

A unique name for this remote.



19
20
21
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 19

def name
  @name
end

#passwordObject

The password to be used for authentication when syncing.



49
50
51
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 49

def password
  @password
end

#policyObject

The policy to use when downloading content. The possible values include: ‘immediate’, ‘on_demand’, and ‘streamed’. ‘immediate’ is the default.



57
58
59
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 57

def policy
  @policy
end

#proxy_passwordObject

The password to authenticte to the proxy.



43
44
45
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 43

def proxy_password
  @proxy_password
end

#proxy_urlObject

The proxy URL. Format: scheme://host:port



37
38
39
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 37

def proxy_url
  @proxy_url
end

#proxy_usernameObject

The username to authenticte to the proxy.



40
41
42
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 40

def proxy_username
  @proxy_username
end

#pulp_labelsObject

Returns the value of attribute pulp_labels.



51
52
53
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 51

def pulp_labels
  @pulp_labels
end

#rate_limitObject

Limits total download rate in requests per second



75
76
77
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 75

def rate_limit
  @rate_limit
end

#sock_connect_timeoutObject

aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections.



66
67
68
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 66

def sock_connect_timeout
  @sock_connect_timeout
end

#sock_read_timeoutObject

aiohttp.ClientTimeout.sock_read (q.v.) for download-connections.



69
70
71
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 69

def sock_read_timeout
  @sock_read_timeout
end

#sync_installerObject

Sync installer files



93
94
95
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 93

def sync_installer
  @sync_installer
end

#sync_sourcesObject

Sync source packages



87
88
89
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 87

def sync_sources
  @sync_sources
end

#sync_udebsObject

Sync installer packages



90
91
92
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 90

def sync_udebs
  @sync_udebs
end

#tls_validationObject

If True, TLS peer validation must be performed.



34
35
36
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 34

def tls_validation
  @tls_validation
end

#total_timeoutObject

aiohttp.ClientTimeout.total (q.v.) for download-connections.



60
61
62
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 60

def total_timeout
  @total_timeout
end

#urlObject

The URL of an external content source.



22
23
24
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 22

def url
  @url
end

#usernameObject

The username to be used for authentication when syncing.



46
47
48
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 46

def username
  @username
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 102

def self.attribute_map
  {
    :'name' => :'name',
    :'url' => :'url',
    :'ca_cert' => :'ca_cert',
    :'client_cert' => :'client_cert',
    :'client_key' => :'client_key',
    :'tls_validation' => :'tls_validation',
    :'proxy_url' => :'proxy_url',
    :'proxy_username' => :'proxy_username',
    :'proxy_password' => :'proxy_password',
    :'username' => :'username',
    :'password' => :'password',
    :'pulp_labels' => :'pulp_labels',
    :'download_concurrency' => :'download_concurrency',
    :'policy' => :'policy',
    :'total_timeout' => :'total_timeout',
    :'connect_timeout' => :'connect_timeout',
    :'sock_connect_timeout' => :'sock_connect_timeout',
    :'sock_read_timeout' => :'sock_read_timeout',
    :'headers' => :'headers',
    :'rate_limit' => :'rate_limit',
    :'distributions' => :'distributions',
    :'components' => :'components',
    :'architectures' => :'architectures',
    :'sync_sources' => :'sync_sources',
    :'sync_udebs' => :'sync_udebs',
    :'sync_installer' => :'sync_installer',
    :'gpgkey' => :'gpgkey',
    :'ignore_missing_package_indices' => :'ignore_missing_package_indices'
  }
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



474
475
476
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 474

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 170

def self.openapi_nullable
  Set.new([
    :'ca_cert',
    :'client_cert',
    :'client_key',
    :'proxy_url',
    :'proxy_username',
    :'proxy_password',
    :'username',
    :'password',
    :'total_timeout',
    :'connect_timeout',
    :'sock_connect_timeout',
    :'sock_read_timeout',
    :'rate_limit',
    :'components',
    :'architectures',
    :'gpgkey',
  ])
end

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 136

def self.openapi_types
  {
    :'name' => :'String',
    :'url' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'client_key' => :'String',
    :'tls_validation' => :'Boolean',
    :'proxy_url' => :'String',
    :'proxy_username' => :'String',
    :'proxy_password' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'pulp_labels' => :'Object',
    :'download_concurrency' => :'Integer',
    :'policy' => :'PolicyEnum',
    :'total_timeout' => :'Float',
    :'connect_timeout' => :'Float',
    :'sock_connect_timeout' => :'Float',
    :'sock_read_timeout' => :'Float',
    :'headers' => :'Array<Object>',
    :'rate_limit' => :'Integer',
    :'distributions' => :'String',
    :'components' => :'String',
    :'architectures' => :'String',
    :'sync_sources' => :'Boolean',
    :'sync_udebs' => :'Boolean',
    :'sync_installer' => :'Boolean',
    :'gpgkey' => :'String',
    :'ignore_missing_package_indices' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 426

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      url == o.url &&
      ca_cert == o.ca_cert &&
      client_cert == o.client_cert &&
      client_key == o.client_key &&
      tls_validation == o.tls_validation &&
      proxy_url == o.proxy_url &&
      proxy_username == o.proxy_username &&
      proxy_password == o.proxy_password &&
      username == o.username &&
      password == o.password &&
      pulp_labels == o.pulp_labels &&
      download_concurrency == o.download_concurrency &&
      policy == o.policy &&
      total_timeout == o.total_timeout &&
      connect_timeout == o.connect_timeout &&
      sock_connect_timeout == o.sock_connect_timeout &&
      sock_read_timeout == o.sock_read_timeout &&
      headers == o.headers &&
      rate_limit == o.rate_limit &&
      distributions == o.distributions &&
      components == o.components &&
      architectures == o.architectures &&
      sync_sources == o.sync_sources &&
      sync_udebs == o.sync_udebs &&
      sync_installer == o.sync_installer &&
      gpgkey == o.gpgkey &&
      ignore_missing_package_indices == o.ignore_missing_package_indices
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



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 502

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
    PulpDebClient.const_get(type).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



571
572
573
574
575
576
577
578
579
580
581
582
583
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 571

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



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 481

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


461
462
463
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 461

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



467
468
469
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 467

def hash
  [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, proxy_username, proxy_password, username, password, pulp_labels, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, rate_limit, distributions, components, architectures, sync_sources, sync_udebs, sync_installer, gpgkey, ignore_missing_package_indices].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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/pulp_deb_client/models/deb_apt_remote.rb', line 323

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

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

  if !@download_concurrency.nil? && @download_concurrency < 1
    invalid_properties.push('invalid value for "download_concurrency", must be greater than or equal to 1.')
  end

  if !@total_timeout.nil? && @total_timeout < 0.0
    invalid_properties.push('invalid value for "total_timeout", must be greater than or equal to 0.0.')
  end

  if !@connect_timeout.nil? && @connect_timeout < 0.0
    invalid_properties.push('invalid value for "connect_timeout", must be greater than or equal to 0.0.')
  end

  if !@sock_connect_timeout.nil? && @sock_connect_timeout < 0.0
    invalid_properties.push('invalid value for "sock_connect_timeout", must be greater than or equal to 0.0.')
  end

  if !@sock_read_timeout.nil? && @sock_read_timeout < 0.0
    invalid_properties.push('invalid value for "sock_read_timeout", must be greater than or equal to 0.0.')
  end

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



547
548
549
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 547

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



553
554
555
556
557
558
559
560
561
562
563
564
565
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 553

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



541
542
543
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 541

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



362
363
364
365
366
367
368
369
370
371
372
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 362

def valid?
  return false if @name.nil?
  return false if @url.nil?
  return false if !@download_concurrency.nil? && @download_concurrency < 1
  return false if !@total_timeout.nil? && @total_timeout < 0.0
  return false if !@connect_timeout.nil? && @connect_timeout < 0.0
  return false if !@sock_connect_timeout.nil? && @sock_connect_timeout < 0.0
  return false if !@sock_read_timeout.nil? && @sock_read_timeout < 0.0
  return false if @distributions.nil?
  true
end