Class: PulpcoreClient::DistributionResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/distribution_response.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 = {}) ⇒ DistributionResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 88

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

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

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



27
28
29
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 27

def base_path
  @base_path
end

#base_url ⇒ Object

The URL for accessing the publication as defined by this distribution.



30
31
32
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 30

def base_url
  @base_url
end

#content_guard ⇒ Object

An optional content-guard.



33
34
35
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 33

def content_guard
  @content_guard
end

#hidden ⇒ Object

Whether this distribution should be shown in the content app.



36
37
38
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 36

def hidden
  @hidden
end

#name ⇒ Object

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



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

def name
  @name
end

#pulp_created ⇒ Object

Timestamp of creation.



21
22
23
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 21

def pulp_created
  @pulp_created
end

#pulp_href ⇒ Object

Returns the value of attribute pulp_href.



18
19
20
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 18

def pulp_href
  @pulp_href
end

#pulp_labels ⇒ Object

Returns the value of attribute pulp_labels.



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

def pulp_labels
  @pulp_labels
end

#pulp_last_updated ⇒ Object

Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.



24
25
26
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 24

def pulp_last_updated
  @pulp_last_updated
end

#repository ⇒ Object

The latest RepositoryVersion for this Repository will be served.



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

def repository
  @repository
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 47

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



201
202
203
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 201

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
83
84
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 63

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'pulp_created' => :'DateTime',
    :'pulp_last_updated' => :'DateTime',
    :'base_path' => :'String',
    :'base_url' => :'String',
    :'content_guard' => :'String',
    :'hidden' => :'Boolean',
    :'pulp_labels' => :'Hash<String, String>',
    :'name' => :'String',
    :'repository' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 171

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



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

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 298

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 208

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


188
189
190
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 194

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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 148

def list_invalid_properties
  invalid_properties = Array.new
  if @base_path.nil?
    invalid_properties.push('invalid value for "base_path", base_path cannot be nil.')
  end

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



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

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 280

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



268
269
270
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 268

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



163
164
165
166
167
 
# File 'lib/pulpcore_client/models/distribution_response.rb', line 163

def valid?
  return false if @base_path.nil?
  return false if @name.nil?
  true
end