Class: PulpcoreClient::UpstreamPulp

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/upstream_pulp.rb

Overview

Serializer for a Server.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpstreamPulp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 133

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

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

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

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

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

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

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

Instance Attribute Details

#api_rootObject

The API root. Defaults to ‘/pulp/’.



26
27
28
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 26

def api_root
  @api_root
end

#base_urlObject

The transport, hostname, and an optional port of the Pulp server. e.g. example.com



23
24
25
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 23

def base_url
  @base_url
end

#ca_certObject

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



32
33
34
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 32

def ca_cert
  @ca_cert
end

#client_certObject

A PEM encoded client certificate used for authentication.



35
36
37
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 35

def client_cert
  @client_cert
end

#client_keyObject

A PEM encoded private key used for authentication.



38
39
40
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 38

def client_key
  @client_key
end

#domainObject

The domain of the Pulp server if enabled.



29
30
31
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 29

def domain
  @domain
end

#nameObject

A unique name for this Pulp server.



20
21
22
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 20

def name
  @name
end

#passwordObject

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



47
48
49
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 47

def password
  @password
end

#policyObject

Policy for how replicate will manage the local objects within the domain. * ‘all` - Replicate manages ALL local objects within the domain. * `labeled` - Replicate will only manage the objects created from a previous replication, unlabled local objects will be untouched. * `nodelete` - Replicate will not delete any local object whether they were created by replication or not.



53
54
55
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 53

def policy
  @policy
end

#q_selectObject

Filter distributions on the upstream Pulp using complex filtering. E.g. pulp_label_select="foo" OR pulp_label_select="key=val"



50
51
52
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 50

def q_select
  @q_select
end

#tls_validationObject

If True, TLS peer validation must be performed.



41
42
43
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 41

def tls_validation
  @tls_validation
end

#usernameObject

The username to be used for authentication when syncing.



44
45
46
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 44

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 436

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 = PulpcoreClient.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



96
97
98
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 78

def self.attribute_map
  {
    :'name' => :'name',
    :'base_url' => :'base_url',
    :'api_root' => :'api_root',
    :'domain' => :'domain',
    :'ca_cert' => :'ca_cert',
    :'client_cert' => :'client_cert',
    :'client_key' => :'client_key',
    :'tls_validation' => :'tls_validation',
    :'username' => :'username',
    :'password' => :'password',
    :'q_select' => :'q_select',
    :'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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 412

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



119
120
121
122
123
124
125
126
127
128
129
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 119

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

.openapi_typesObject

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 101

def self.openapi_types
  {
    :'name' => :'String',
    :'base_url' => :'String',
    :'api_root' => :'String',
    :'domain' => :'String',
    :'ca_cert' => :'String',
    :'client_cert' => :'String',
    :'client_key' => :'String',
    :'tls_validation' => :'Boolean',
    :'username' => :'String',
    :'password' => :'String',
    :'q_select' => :'String',
    :'policy' => :'Policy357Enum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 380

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      base_url == o.base_url &&
      api_root == o.api_root &&
      domain == o.domain &&
      ca_cert == o.ca_cert &&
      client_cert == o.client_cert &&
      client_key == o.client_key &&
      tls_validation == o.tls_validation &&
      username == o.username &&
      password == o.password &&
      q_select == o.q_select &&
      policy == o.policy
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



507
508
509
510
511
512
513
514
515
516
517
518
519
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 507

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


399
400
401
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 399

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



405
406
407
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 405

def hash
  [name, base_url, api_root, domain, ca_cert, client_cert, client_key, tls_validation, username, password, q_select, 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



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
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 203

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

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

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

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

  if !@domain.nil? && @domain.to_s.length < 1
    invalid_properties.push('invalid value for "domain", 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 !@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 !@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 !@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

  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



483
484
485
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 483

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



489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 489

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



477
478
479
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 477

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/pulpcore_client/models/upstream_pulp.rb', line 259

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @base_url.nil?
  return false if @base_url.to_s.length < 1
  return false if @api_root.nil?
  return false if @api_root.to_s.length < 1
  return false if !@domain.nil? && @domain.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 !@client_key.nil? && @client_key.to_s.length < 1
  return false if !@username.nil? && @username.to_s.length < 1
  return false if !@password.nil? && @password.to_s.length < 1
  true
end