Class: PulpcoreClient::PatchedOpenPGPDistribution

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

Overview

The Serializer for the Distribution model. The serializer deliberately omits the ‘publication` and `repository_version` field due to plugins typically requiring one or the other but not both. To include the “publication“ field, it is recommended plugins define the field
publication = DetailRelatedField( required=False, help_text=_("Publication to be served"), view_name_pattern=r"publications(-./.)?-detail", queryset=models.Publication.objects.exclude(complete=False), allow_null=True, ) To include the “repository_version“ field, it is recommended plugins define the field
repository_version = RepositoryVersionRelatedField( required=False, help_text=_("RepositoryVersion to be served"), allow_null=True ) Additionally, the serializer omits the “remote“ field, which is used for pull-through caching feature and only by plugins which use publications. Plugins implementing a pull-through caching should define the field in their derived serializer class like this

remote = DetailRelatedField( required=False, help_text=_(‘Remote that can be used to fetch content when using pull-through caching.’), queryset=models.Remote.objects.all(), allow_null=True )

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PatchedOpenPGPDistribution

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

81
82
83
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 81

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

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

  if attributes.key?(:'hidden')
    self.hidden = attributes[:'hidden']
  else
    self.hidden = false
  end

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

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

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

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

Instance Attribute Details

#base_path ⇒ Object

The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")


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

def base_path
  @base_path
end

#content_guard ⇒ Object

An optional content-guard.


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

def content_guard
  @content_guard
end

#hidden ⇒ Object

Whether this distribution should be shown in the content app.


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

def hidden
  @hidden
end

#name ⇒ Object

A unique name. Ex, ‘rawhide` and `stable`.


31
32
33
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 31

def name
  @name
end

#pulp_labels ⇒ Object

Returns the value of attribute pulp_labels.


28
29
30
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 28

def pulp_labels
  @pulp_labels
end

#repository ⇒ Object

The latest RepositoryVersion for this Repository will be served.


34
35
36
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 34

def repository
  @repository
end

#repository_version ⇒ Object

RepositoryVersion to be served


37
38
39
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 37

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

[View source]

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

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_attributes ⇒ Object

Returns all the JSON keys this model knows about

[View source]

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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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

[View source]

40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 40

def self.attribute_map
  {
    :'base_path' => :'base_path',
    :'content_guard' => :'content_guard',
    :'hidden' => :'hidden',
    :'pulp_labels' => :'pulp_labels',
    :'name' => :'name',
    :'repository' => :'repository',
    :'repository_version' => :'repository_version'
  }
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

[View source]

209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 209

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_nullable ⇒ Object

List of attributes with nullable: true

[View source]

71
72
73
74
75
76
77
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 71

def self.openapi_nullable
  Set.new([
    :'content_guard',
    :'repository',
    :'repository_version'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.

[View source]

58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 58

def self.openapi_types
  {
    :'base_path' => :'String',
    :'content_guard' => :'String',
    :'hidden' => :'Boolean',
    :'pulp_labels' => :'Hash<String, String>',
    :'name' => :'String',
    :'repository' => :'String',
    :'repository_version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base_path == o.base_path &&
      content_guard == o.content_guard &&
      hidden == o.hidden &&
      pulp_labels == o.pulp_labels &&
      name == o.name &&
      repository == o.repository &&
      repository_version == o.repository_version
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

[View source]

304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 304

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
[View source]

196
197
198
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code

[View source]

202
203
204
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 202

def hash
  [base_path, content_guard, hidden, pulp_labels, name, repository, repository_version].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

[View source]

129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@base_path.nil? && @base_path.to_s.length < 1
    invalid_properties.push('invalid value for "base_path", the character length must be great than or equal to 1.')
  end

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

[View source]

280
281
282
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 280

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

[View source]

286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 286

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

[View source]

274
275
276
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 274

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

[View source]

145
146
147
148
149
150
 
# File 'lib/pulpcore_client/models/patched_open_pgp_distribution.rb', line 145

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@base_path.nil? && @base_path.to_s.length < 1
  return false if !@name.nil? && @name.to_s.length < 1
  true
end