Class: PulpcoreClient::PulpExportResponse

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

Overview

Serializer for PulpExports.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PulpExportResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

Instance Attribute Details

#exported_resourcesObject

Resources that were exported.



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

def exported_resources
  @exported_resources
end

#output_file_infoObject

Dictionary of filename: sha256hash entries for export-output-file(s)



39
40
41
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 39

def output_file_info
  @output_file_info
end

#paramsObject

Any additional parameters that were used to create the export.



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

def params
  @params
end

#prnObject

The Pulp Resource Name (PRN).



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

def prn
  @prn
end

#pulp_createdObject

Timestamp of creation.



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

def pulp_created
  @pulp_created
end

#pulp_hrefObject

Returns the value of attribute pulp_href.



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

def pulp_href
  @pulp_href
end

#pulp_last_updatedObject

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.



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

def pulp_last_updated
  @pulp_last_updated
end

#taskObject

A URI of the task that ran the Export.



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

def task
  @task
end

#toc_infoObject

Filename and sha256-checksum of table-of-contents for this export



42
43
44
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 42

def toc_info
  @toc_info
end

Class Method Details

.attribute_mapObject

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



45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 45

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'prn' => :'prn',
    :'pulp_created' => :'pulp_created',
    :'pulp_last_updated' => :'pulp_last_updated',
    :'task' => :'task',
    :'exported_resources' => :'exported_resources',
    :'params' => :'params',
    :'output_file_info' => :'output_file_info',
    :'toc_info' => :'toc_info'
  }
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



179
180
181
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 179

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

.openapi_nullableObject

List of attributes with nullable: true



75
76
77
78
79
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 75

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

.openapi_typesObject

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 60

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'prn' => :'String',
    :'pulp_created' => :'DateTime',
    :'pulp_last_updated' => :'DateTime',
    :'task' => :'String',
    :'exported_resources' => :'Array<String>',
    :'params' => :'Object',
    :'output_file_info' => :'Object',
    :'toc_info' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      prn == o.prn &&
      pulp_created == o.pulp_created &&
      pulp_last_updated == o.pulp_last_updated &&
      task == o.task &&
      exported_resources == o.exported_resources &&
      params == o.params &&
      output_file_info == o.output_file_info &&
      toc_info == o.toc_info
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



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

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



276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 276

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



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

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


166
167
168
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 166

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



172
173
174
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 172

def hash
  [pulp_href, prn, pulp_created, pulp_last_updated, task, exported_resources, params, output_file_info, toc_info].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



137
138
139
140
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  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



252
253
254
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 252

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



258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 258

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



246
247
248
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 246

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



144
145
146
# File 'lib/pulpcore_client/models/pulp_export_response.rb', line 144

def valid?
  true
end