Class: PulpcoreClient::DistributionResponse
- Inherits:
-
Object
- Object
- PulpcoreClient::DistributionResponse
- 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
-
#base_path ⇒ Object
The base (relative) path component of the published url.
-
#base_url ⇒ Object
The URL for accessing the publication as defined by this distribution.
-
#content_guard ⇒ Object
An optional content-guard.
-
#hidden ⇒ Object
Whether this distribution should be shown in the content app.
-
#name ⇒ Object
A unique name.
-
#pulp_created ⇒ Object
Timestamp of creation.
-
#pulp_href ⇒ Object
Returns the value of attribute pulp_href.
-
#pulp_labels ⇒ Object
Returns the value of attribute pulp_labels.
-
#repository ⇒ Object
The latest RepositoryVersion for this Repository will be served.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DistributionResponse
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ DistributionResponse
Initializes the object
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 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 83 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?(:'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")
24 25 26 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 24 def base_path @base_path end |
#base_url ⇒ Object
The URL for accessing the publication as defined by this distribution.
27 28 29 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 27 def base_url @base_url end |
#content_guard ⇒ Object
An optional content-guard.
30 31 32 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 30 def content_guard @content_guard end |
#hidden ⇒ Object
Whether this distribution should be shown in the content app.
33 34 35 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 33 def hidden @hidden end |
#name ⇒ Object
A unique name. Ex, ‘rawhide` and `stable`.
38 39 40 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 38 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.
35 36 37 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 35 def pulp_labels @pulp_labels end |
#repository ⇒ Object
The latest RepositoryVersion for this Repository will be served.
41 42 43 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 41 def repository @repository end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 44 def self.attribute_map { :'pulp_href' => :'pulp_href', :'pulp_created' => :'pulp_created', :'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
191 192 193 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 191 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
74 75 76 77 78 79 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 74 def self.openapi_nullable Set.new([ :'content_guard', :'repository' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 59 def self.openapi_types { :'pulp_href' => :'String', :'pulp_created' => :'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.
162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 162 def ==(o) return true if self.equal?(o) self.class == o.class && pulp_href == o.pulp_href && pulp_created == o.pulp_created && 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
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 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 219 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
288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 288 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
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 198 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
178 179 180 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 178 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
184 185 186 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 184 def hash [pulp_href, pulp_created, 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?
139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 139 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)
264 265 266 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 264 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 270 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
258 259 260 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 258 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
154 155 156 157 158 |
# File 'lib/pulpcore_client/models/distribution_response.rb', line 154 def valid? return false if @base_path.nil? return false if @name.nil? true end |