Class: PulpAnsibleClient::AnsibleCollectionRemoteResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_ansible_client/models/ansible_collection_remote_response.rb

Overview

A serializer for Collection Remotes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnsibleCollectionRemoteResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 205

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

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

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

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

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

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  else
    self.url = nil
  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?(:'tls_validation')
    self.tls_validation = attributes[:'tls_validation']
  end

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

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

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

  if attributes.key?(:'max_retries')
    self.max_retries = attributes[:'max_retries']
  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?(:'hidden_fields')
    if (value = attributes[:'hidden_fields']).is_a?(Array)
      self.hidden_fields = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#auth_urlObject

The URL to receive a session token from, e.g. used with Automation Hub.



84
85
86
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 84

def auth_url
  @auth_url
end

#ca_certObject

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



37
38
39
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 37

def ca_cert
  @ca_cert
end

#client_certObject

A PEM encoded client certificate used for authentication.



40
41
42
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 40

def client_cert
  @client_cert
end

#connect_timeoutObject

aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.



63
64
65
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 63

def connect_timeout
  @connect_timeout
end

#download_concurrencyObject

Total number of simultaneous connections. If not set then the default value will be used.



51
52
53
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 51

def download_concurrency
  @download_concurrency
end

#headersObject

Headers for aiohttp.Clientsession



72
73
74
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 72

def headers
  @headers
end

#hidden_fieldsObject

List of hidden (write only) fields



78
79
80
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 78

def hidden_fields
  @hidden_fields
end

#last_sync_taskObject

Returns the value of attribute last_sync_task.



92
93
94
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 92

def last_sync_task
  @last_sync_task
end

#max_retriesObject

Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.



54
55
56
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 54

def max_retries
  @max_retries
end

#nameObject

A unique name for this remote.



31
32
33
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 31

def name
  @name
end

#policyObject

The policy to use when downloading content. * ‘immediate` - When syncing, download all metadata and content now.



57
58
59
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 57

def policy
  @policy
end

#prnObject

The Pulp Resource Name (PRN).



22
23
24
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 22

def prn
  @prn
end

#proxy_urlObject

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



46
47
48
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 46

def proxy_url
  @proxy_url
end

#pulp_createdObject

Timestamp of creation.



25
26
27
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 25

def pulp_created
  @pulp_created
end

#pulp_hrefObject

Returns the value of attribute pulp_href.



19
20
21
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 19

def pulp_href
  @pulp_href
end

#pulp_labelsObject

Returns the value of attribute pulp_labels.



48
49
50
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 48

def pulp_labels
  @pulp_labels
end

#pulp_last_updatedObject

Timestamp of the most recent update of the remote.



28
29
30
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 28

def pulp_last_updated
  @pulp_last_updated
end

#rate_limitObject

Limits requests per second for each concurrent downloader



75
76
77
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 75

def rate_limit
  @rate_limit
end

#requirements_fileObject

The string version of Collection requirements yaml.



81
82
83
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 81

def requirements_file
  @requirements_file
end

#signed_onlyObject

Sync only collections that have a signature



90
91
92
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 90

def signed_only
  @signed_only
end

#sock_connect_timeoutObject

aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.



66
67
68
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 66

def sock_connect_timeout
  @sock_connect_timeout
end

#sock_read_timeoutObject

aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.



69
70
71
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 69

def sock_read_timeout
  @sock_read_timeout
end

#sync_dependenciesObject

Sync dependencies for collections specified via requirements file



87
88
89
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 87

def sync_dependencies
  @sync_dependencies
end

#tls_validationObject

If True, TLS peer validation must be performed.



43
44
45
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 43

def tls_validation
  @tls_validation
end

#total_timeoutObject

aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.



60
61
62
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 60

def total_timeout
  @total_timeout
end

#urlObject

The URL of an external content source.



34
35
36
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 34

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



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 520

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 = PulpAnsibleClient.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_attributesObject

Returns all the JSON keys this model knows about



149
150
151
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 149

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



117
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
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 117

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'prn' => :'prn',
    :'pulp_created' => :'pulp_created',
    :'pulp_last_updated' => :'pulp_last_updated',
    :'name' => :'name',
    :'url' => :'url',
    :'ca_cert' => :'ca_cert',
    :'client_cert' => :'client_cert',
    :'tls_validation' => :'tls_validation',
    :'proxy_url' => :'proxy_url',
    :'pulp_labels' => :'pulp_labels',
    :'download_concurrency' => :'download_concurrency',
    :'max_retries' => :'max_retries',
    :'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',
    :'hidden_fields' => :'hidden_fields',
    :'requirements_file' => :'requirements_file',
    :'auth_url' => :'auth_url',
    :'sync_dependencies' => :'sync_dependencies',
    :'signed_only' => :'signed_only',
    :'last_sync_task' => :'last_sync_task'
  }
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



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 496

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_nullableObject

List of attributes with nullable: true



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 186

def self.openapi_nullable
  Set.new([
    :'ca_cert',
    :'client_cert',
    :'proxy_url',
    :'download_concurrency',
    :'max_retries',
    :'total_timeout',
    :'connect_timeout',
    :'sock_connect_timeout',
    :'sock_read_timeout',
    :'rate_limit',
    :'requirements_file',
    :'auth_url',
  ])
end

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 154

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'prn' => :'String',
    :'pulp_created' => :'Time',
    :'pulp_last_updated' => :'Time',
    :'name' => :'String',
    :'url' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'tls_validation' => :'Boolean',
    :'proxy_url' => :'String',
    :'pulp_labels' => :'Hash<String, String>',
    :'download_concurrency' => :'Integer',
    :'max_retries' => :'Integer',
    :'policy' => :'PolicyEnum',
    :'total_timeout' => :'Float',
    :'connect_timeout' => :'Float',
    :'sock_connect_timeout' => :'Float',
    :'sock_read_timeout' => :'Float',
    :'headers' => :'Array<Object>',
    :'rate_limit' => :'Integer',
    :'hidden_fields' => :'Array<AnsibleCollectionRemoteResponseHiddenFieldsInner>',
    :'requirements_file' => :'String',
    :'auth_url' => :'String',
    :'sync_dependencies' => :'Boolean',
    :'signed_only' => :'Boolean',
    :'last_sync_task' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 450

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      prn == o.prn &&
      pulp_created == o.pulp_created &&
      pulp_last_updated == o.pulp_last_updated &&
      name == o.name &&
      url == o.url &&
      ca_cert == o.ca_cert &&
      client_cert == o.client_cert &&
      tls_validation == o.tls_validation &&
      proxy_url == o.proxy_url &&
      pulp_labels == o.pulp_labels &&
      download_concurrency == o.download_concurrency &&
      max_retries == o.max_retries &&
      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 &&
      hidden_fields == o.hidden_fields &&
      requirements_file == o.requirements_file &&
      auth_url == o.auth_url &&
      sync_dependencies == o.sync_dependencies &&
      signed_only == o.signed_only &&
      last_sync_task == o.last_sync_task
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



591
592
593
594
595
596
597
598
599
600
601
602
603
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 591

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


483
484
485
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 483

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



489
490
491
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 489

def hash
  [pulp_href, prn, pulp_created, pulp_last_updated, name, url, ca_cert, client_cert, tls_validation, proxy_url, pulp_labels, download_concurrency, max_retries, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, rate_limit, hidden_fields, requirements_file, auth_url, sync_dependencies, signed_only, last_sync_task].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



335
336
337
338
339
340
341
342
343
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
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 335

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 !@auth_url.nil? && @auth_url.to_s.length > 255
    invalid_properties.push('invalid value for "auth_url", the character length must be smaller than or equal to 255.')
  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



567
568
569
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 567

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



573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 573

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



561
562
563
# File 'lib/pulp_ansible_client/models/ansible_collection_remote_response.rb', line 561

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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 !@auth_url.nil? && @auth_url.to_s.length > 255
  true
end