Class: PulpAnsibleClient::AnsibleGitRemote

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

Overview

A serializer for Git Collection Remotes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnsibleGitRemote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 162

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ca_cert ⇒ Object

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



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

def ca_cert
  @ca_cert
end

#client_cert ⇒ Object

A PEM encoded client certificate used for authentication.



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

def client_cert
  @client_cert
end

#client_key ⇒ Object

A PEM encoded private key used for authentication.



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

def client_key
  @client_key
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.



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

def connect_timeout
  @connect_timeout
end

#download_concurrency ⇒ Object

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



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

def download_concurrency
  @download_concurrency
end

#git_ref ⇒ Object

A git ref. e.g.: branch, tag, or commit sha.



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

def git_ref
  @git_ref
end

#headers ⇒ Object

Headers for aiohttp.Clientsession



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

def headers
  @headers
end

#max_retries ⇒ Object

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



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

def max_retries
  @max_retries
end

#metadata_only ⇒ Object

If True, only metadata about the content will be stored in Pulp. Clients will retrieve content from the remote URL.



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

def metadata_only
  @metadata_only
end

#name ⇒ Object

A unique name for this remote.



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

def name
  @name
end

#password ⇒ Object

The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed.



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

def password
  @password
end

#proxy_password ⇒ Object

The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed.



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

def proxy_password
  @proxy_password
end

#proxy_url ⇒ Object

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



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

def proxy_url
  @proxy_url
end

#proxy_username ⇒ Object

The username to authenticte to the proxy.



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

def proxy_username
  @proxy_username
end

#pulp_labels ⇒ Object

Returns the value of attribute pulp_labels.



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

def pulp_labels
  @pulp_labels
end

#rate_limit ⇒ Object

Limits requests per second for each concurrent downloader



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

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.



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

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.



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

def sock_read_timeout
  @sock_read_timeout
end

#tls_validation ⇒ Object

If True, TLS peer validation must be performed.



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

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.



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

def total_timeout
  @total_timeout
end

#url ⇒ Object

The URL of an external content source.



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

def url
  @url
end

#username ⇒ Object

The username to be used for authentication when syncing.



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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 84

def self.attribute_map
  {
    :'sock_read_timeout' => :'sock_read_timeout',
    :'client_key' => :'client_key',
    :'total_timeout' => :'total_timeout',
    :'username' => :'username',
    :'url' => :'url',
    :'proxy_username' => :'proxy_username',
    :'sock_connect_timeout' => :'sock_connect_timeout',
    :'name' => :'name',
    :'pulp_labels' => :'pulp_labels',
    :'rate_limit' => :'rate_limit',
    :'proxy_password' => :'proxy_password',
    :'headers' => :'headers',
    :'password' => :'password',
    :'download_concurrency' => :'download_concurrency',
    :'connect_timeout' => :'connect_timeout',
    :'proxy_url' => :'proxy_url',
    :'ca_cert' => :'ca_cert',
    :'tls_validation' => :'tls_validation',
    :'max_retries' => :'max_retries',
    :'client_cert' => :'client_cert',
    :'metadata_only' => :'metadata_only',
    :'git_ref' => :'git_ref'
  }
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



583
584
585
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 583

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 140

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 112

def self.openapi_types
  {
    :'sock_read_timeout' => :'Float',
    :'client_key' => :'String',
    :'total_timeout' => :'Float',
    :'username' => :'String',
    :'url' => :'String',
    :'proxy_username' => :'String',
    :'sock_connect_timeout' => :'Float',
    :'name' => :'String',
    :'pulp_labels' => :'Hash<String, String>',
    :'rate_limit' => :'Integer',
    :'proxy_password' => :'String',
    :'headers' => :'Array<Object>',
    :'password' => :'String',
    :'download_concurrency' => :'Integer',
    :'connect_timeout' => :'Float',
    :'proxy_url' => :'String',
    :'ca_cert' => :'String',
    :'tls_validation' => :'Boolean',
    :'max_retries' => :'Integer',
    :'client_cert' => :'String',
    :'metadata_only' => :'Boolean',
    :'git_ref' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 541

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sock_read_timeout == o.sock_read_timeout &&
      client_key == o.client_key &&
      total_timeout == o.total_timeout &&
      username == o.username &&
      url == o.url &&
      proxy_username == o.proxy_username &&
      sock_connect_timeout == o.sock_connect_timeout &&
      name == o.name &&
      pulp_labels == o.pulp_labels &&
      rate_limit == o.rate_limit &&
      proxy_password == o.proxy_password &&
      headers == o.headers &&
      password == o.password &&
      download_concurrency == o.download_concurrency &&
      connect_timeout == o.connect_timeout &&
      proxy_url == o.proxy_url &&
      ca_cert == o.ca_cert &&
      tls_validation == o.tls_validation &&
      max_retries == o.max_retries &&
      client_cert == o.client_cert &&
      metadata_only == o.metadata_only &&
      git_ref == o.git_ref
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



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 611

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



680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 680

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



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

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


570
571
572
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 570

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



576
577
578
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 576

def hash
  [sock_read_timeout, client_key, total_timeout, username, url, proxy_username, sock_connect_timeout, name, pulp_labels, rate_limit, proxy_password, headers, password, download_concurrency, connect_timeout, proxy_url, ca_cert, tls_validation, max_retries, client_cert, metadata_only, git_ref].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



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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 270

def list_invalid_properties
  invalid_properties = Array.new
  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

  if !@client_key.nil? && @client_key.to_s.length < 1
    invalid_properties.push('invalid value for "client_key", the character length must be great 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 !@username.nil? && @username.to_s.length < 1
    invalid_properties.push('invalid value for "username", the character length must be great than or equal to 1.')
  end

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

  if @url.to_s.length < 1
    invalid_properties.push('invalid value for "url", the character length must be great than or equal to 1.')
  end

  if !@proxy_username.nil? && @proxy_username.to_s.length < 1
    invalid_properties.push('invalid value for "proxy_username", the character length must be great than or equal to 1.')
  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 @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@proxy_password.nil? && @proxy_password.to_s.length < 1
    invalid_properties.push('invalid value for "proxy_password", the character length must be great than or equal to 1.')
  end

  if !@password.nil? && @password.to_s.length < 1
    invalid_properties.push('invalid value for "password", the character length must be great than or equal to 1.')
  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 !@connect_timeout.nil? && @connect_timeout < 0
    invalid_properties.push('invalid value for "connect_timeout", must be greater than or equal to 0.')
  end

  if !@proxy_url.nil? && @proxy_url.to_s.length < 1
    invalid_properties.push('invalid value for "proxy_url", the character length must be great than or equal to 1.')
  end

  if !@ca_cert.nil? && @ca_cert.to_s.length < 1
    invalid_properties.push('invalid value for "ca_cert", the character length must be great than or equal to 1.')
  end

  if !@client_cert.nil? && @client_cert.to_s.length < 1
    invalid_properties.push('invalid value for "client_cert", the character length must be great than or equal to 1.')
  end

  if !@git_ref.nil? && @git_ref.to_s.length < 1
    invalid_properties.push('invalid value for "git_ref", the character length must be great than or equal to 1.')
  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



656
657
658
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 656

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



662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 662

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



650
651
652
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 650

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/pulp_ansible_client/models/ansible_git_remote.rb', line 349

def valid?
  return false if !@sock_read_timeout.nil? && @sock_read_timeout < 0
  return false if !@client_key.nil? && @client_key.to_s.length < 1
  return false if !@total_timeout.nil? && @total_timeout < 0
  return false if !@username.nil? && @username.to_s.length < 1
  return false if @url.nil?
  return false if @url.to_s.length < 1
  return false if !@proxy_username.nil? && @proxy_username.to_s.length < 1
  return false if !@sock_connect_timeout.nil? && @sock_connect_timeout < 0
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if !@proxy_password.nil? && @proxy_password.to_s.length < 1
  return false if !@password.nil? && @password.to_s.length < 1
  return false if !@download_concurrency.nil? && @download_concurrency < 1
  return false if !@connect_timeout.nil? && @connect_timeout < 0
  return false if !@proxy_url.nil? && @proxy_url.to_s.length < 1
  return false if !@ca_cert.nil? && @ca_cert.to_s.length < 1
  return false if !@client_cert.nil? && @client_cert.to_s.length < 1
  return false if !@git_ref.nil? && @git_ref.to_s.length < 1
  true
end