Class: PulpAnsibleClient::AnsibleRoleRemoteResponse

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

Overview

A serializer for Ansible Remotes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnsibleRoleRemoteResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/pulp_ansible_client/models/ansible_role_remote_response.rb', line 151

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

Instance Attribute Details

#ca_cert ⇒ Object

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



36
37
38
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 36

def ca_cert
  @ca_cert
end

#client_cert ⇒ Object

A PEM encoded client certificate used for authentication.



39
40
41
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 39

def client_cert
  @client_cert
end

#connect_timeout ⇒ Object

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



62
63
64
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 62

def connect_timeout
  @connect_timeout
end

#download_concurrency ⇒ Object

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



50
51
52
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 50

def download_concurrency
  @download_concurrency
end

#headers ⇒ Object

Headers for aiohttp.Clientsession



71
72
73
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 71

def headers
  @headers
end

#hidden_fields ⇒ Object

List of hidden (write only) fields



77
78
79
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 77

def hidden_fields
  @hidden_fields
end

#max_retries ⇒ Object

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



53
54
55
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 53

def max_retries
  @max_retries
end

#name ⇒ Object

A unique name for this remote.



30
31
32
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 30

def name
  @name
end

#policy ⇒ Object

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



56
57
58
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 56

def policy
  @policy
end

#prn ⇒ Object

The Pulp Resource Name (PRN).



21
22
23
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 21

def prn
  @prn
end

#proxy_url ⇒ Object

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



45
46
47
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 45

def proxy_url
  @proxy_url
end

#pulp_created ⇒ Object

Timestamp of creation.



24
25
26
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 24

def pulp_created
  @pulp_created
end

#pulp_href ⇒ Object

Returns the value of attribute pulp_href.



18
19
20
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 18

def pulp_href
  @pulp_href
end

#pulp_labels ⇒ Object

Returns the value of attribute pulp_labels.



47
48
49
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 47

def pulp_labels
  @pulp_labels
end

#pulp_last_updated ⇒ Object

Timestamp of the most recent update of the remote.



27
28
29
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 27

def pulp_last_updated
  @pulp_last_updated
end

#rate_limit ⇒ Object

Limits requests per second for each concurrent downloader



74
75
76
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 74

def rate_limit
  @rate_limit
end

#sock_connect_timeout ⇒ Object

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.



65
66
67
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 65

def sock_connect_timeout
  @sock_connect_timeout
end

#sock_read_timeout ⇒ Object

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.



68
69
70
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 68

def sock_read_timeout
  @sock_read_timeout
end

#tls_validation ⇒ Object

If True, TLS peer validation must be performed.



42
43
44
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 42

def tls_validation
  @tls_validation
end

#total_timeout ⇒ Object

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



59
60
61
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 59

def total_timeout
  @total_timeout
end

#url ⇒ Object

The URL of an external content source.



33
34
35
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 33

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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

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'
  }
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



396
397
398
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 396

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 134

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',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'prn' => :'String',
    :'pulp_created' => :'DateTime',
    :'pulp_last_updated' => :'DateTime',
    :'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<AnsibleCollectionRemoteResponseHiddenFields>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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_ansible_client/models/ansible_role_remote_response.rb', line 355

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



424
425
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
458
459
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 424

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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 493

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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 403

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


383
384
385
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 383

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



389
390
391
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 389

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



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

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
    invalid_properties.push('invalid value for "total_timeout", must be greater than or equal to 0.')
  end

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

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

  if !@sock_read_timeout.nil? && @sock_read_timeout < 0
    invalid_properties.push('invalid value for "sock_read_timeout", must be greater than or equal to 0.')
  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



469
470
471
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 469

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 475

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

Returns:

  • (String) —

    String presentation of the object



463
464
465
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 463

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



292
293
294
295
296
297
298
299
300
301
 
# File 'lib/pulp_ansible_client/models/ansible_role_remote_response.rb', line 292

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
  return false if !@connect_timeout.nil? && @connect_timeout < 0
  return false if !@sock_connect_timeout.nil? && @sock_connect_timeout < 0
  return false if !@sock_read_timeout.nil? && @sock_read_timeout < 0
  true
end