Class: PulpFileClient::FileFileRemoteResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_file_client/models/file_file_remote_response.rb

Overview

Serializer for File Remotes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileFileRemoteResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 113

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

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

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

Instance Attribute Details

#ca_certObject

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



30
31
32
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 30

def ca_cert
  @ca_cert
end

#client_certObject

A PEM encoded client certificate used for authentication.



33
34
35
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 33

def client_cert
  @client_cert
end

#client_keyObject

A PEM encoded private key used for authentication.



36
37
38
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 36

def client_key
  @client_key
end

#download_concurrencyObject

Total number of simultaneous connections.



54
55
56
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 54

def download_concurrency
  @download_concurrency
end

#nameObject

A unique name for this remote.



24
25
26
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 24

def name
  @name
end

#passwordObject

The password to be used for authentication when syncing.



48
49
50
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 48

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_file_client/models/file_file_remote_response.rb', line 57

def policy
  @policy
end

#proxy_urlObject

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



42
43
44
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 42

def proxy_url
  @proxy_url
end

#pulp_createdObject

Timestamp of creation.



21
22
23
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 21

def pulp_created
  @pulp_created
end

#pulp_hrefObject

Returns the value of attribute pulp_href.



18
19
20
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 18

def pulp_href
  @pulp_href
end

#pulp_last_updatedObject

Timestamp of the most recent update of the remote.



51
52
53
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 51

def pulp_last_updated
  @pulp_last_updated
end

#tls_validationObject

If True, TLS peer validation must be performed.



39
40
41
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 39

def tls_validation
  @tls_validation
end

#urlObject

The URL of an external content source.



27
28
29
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 27

def url
  @url
end

#usernameObject

The username to be used for authentication when syncing.



45
46
47
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 45

def username
  @username
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 60

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'pulp_created' => :'pulp_created',
    :'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',
    :'pulp_last_updated' => :'pulp_last_updated',
    :'download_concurrency' => :'download_concurrency',
    :'policy' => :'policy'
  }
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



257
258
259
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 257

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

.openapi_nullableObject

List of attributes with nullable: true



100
101
102
103
104
105
106
107
108
109
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 100

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

.openapi_typesObject

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 80

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'pulp_created' => :'DateTime',
    :'name' => :'String',
    :'url' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'client_key' => :'String',
    :'tls_validation' => :'Boolean',
    :'proxy_url' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'pulp_last_updated' => :'DateTime',
    :'download_concurrency' => :'Integer',
    :'policy' => :'PolicyEnum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      pulp_created == o.pulp_created &&
      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 &&
      pulp_last_updated == o.pulp_last_updated &&
      download_concurrency == o.download_concurrency &&
      policy == o.policy
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



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
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 285

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



354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 354

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 264

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


244
245
246
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 244

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



250
251
252
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 250

def hash
  [pulp_href, pulp_created, name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, username, password, pulp_last_updated, download_concurrency, policy].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

  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



330
331
332
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 336

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



324
325
326
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 324

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



204
205
206
207
208
209
# File 'lib/pulp_file_client/models/file_file_remote_response.rb', line 204

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