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



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

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

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

#architectures ⇒ Object

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.



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

def architectures
  @architectures
end

#ca_cert ⇒ Object

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_cert ⇒ Object

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_key ⇒ Object

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

#components ⇒ Object

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".



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

def components
  @components
end

#distributions ⇒ Object

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.



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

def distributions
  @distributions
end

#download_concurrency ⇒ Object

Total number of simultaneous connections.



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

def download_concurrency
  @download_concurrency
end

#gpgkey ⇒ Object

Gpg public key to verify origin releases against



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

def gpgkey
  @gpgkey
end

#ignore_missing_package_indices ⇒ Object

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.



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

def ignore_missing_package_indices
  @ignore_missing_package_indices
end

#name ⇒ Object

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

#password ⇒ Object

The password to be used for authentication when syncing.



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

def password
  @password
end

#policy ⇒ Object

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



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

def policy
  @policy
end

#proxy_url ⇒ Object

The proxy URL. Format: scheme://user:password@host:port



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

def proxy_url
  @proxy_url
end

#sync_installer ⇒ Object

Sync installer files



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

def sync_installer
  @sync_installer
end

#sync_sources ⇒ Object

Sync source packages



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

def sync_sources
  @sync_sources
end

#sync_udebs ⇒ Object

Sync installer packages



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

def sync_udebs
  @sync_udebs
end

#tls_validation ⇒ Object

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

#url ⇒ Object

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

#username ⇒ Object

The username to be used for authentication when syncing.



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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 76

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',
    :'username' => :'username',
    :'password' => :'password',
    :'download_concurrency' => :'download_concurrency',
    :'policy' => :'policy',
    :'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



316
317
318
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 316

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 126

def self.openapi_nullable
  Set.new([
    :'ca_cert',
    :'client_cert',
    :'client_key',
    :'proxy_url',
    :'username',
    :'password',
    :'components',
    :'architectures',
    :'gpgkey',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 101

def self.openapi_types
  {
    :'name' => :'String',
    :'url' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'client_key' => :'String',
    :'tls_validation' => :'Boolean',
    :'proxy_url' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'download_concurrency' => :'Integer',
    :'policy' => :'PolicyEnum',
    :'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.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 277

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 &&
      username == o.username &&
      password == o.password &&
      download_concurrency == o.download_concurrency &&
      policy == o.policy &&
      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



344
345
346
347
348
349
350
351
352
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
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 344

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 413

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 323

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

See Also:

  • `==` method


303
304
305
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



309
310
311
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 309

def hash
  [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, username, password, download_concurrency, policy, distributions, components, architectures, sync_sources, sync_udebs, sync_installer, gpgkey, ignore_missing_package_indices].hash
end

#list_invalid_properties ⇒ Object

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



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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



389
390
391
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 389

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 395

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



383
384
385
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 383

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



257
258
259
260
261
262
263
 
# File 'lib/pulp_deb_client/models/deb_apt_remote.rb', line 257

def valid?
  return false if @name.nil?
  return false if @url.nil?
  return false if !@download_concurrency.nil? && @download_concurrency < 1
  return false if @distributions.nil?
  true
end