Class: PulpcoreClient::UploadDetailResponse

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

Overview

Serializer for chunked uploads.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UploadDetailResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 61

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

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

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

Instance Attribute Details

#chunksObject

Returns the value of attribute chunks


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

def chunks
  @chunks
end

#completedObject

Timestamp when upload is committed.


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

def completed
  @completed
end

#pulp_createdObject

Timestamp of creation.


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

def pulp_created
  @pulp_created
end

#pulp_hrefObject

Returns the value of attribute pulp_href


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

def pulp_href
  @pulp_href
end

#sizeObject

The size of the upload in bytes.


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

def size
  @size
end

Class Method Details

.attribute_mapObject

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


32
33
34
35
36
37
38
39
40
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 32

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'pulp_created' => :'pulp_created',
    :'size' => :'size',
    :'completed' => :'completed',
    :'chunks' => :'chunks'
  }
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


142
143
144
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 142

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

.openapi_nullableObject

List of attributes with nullable: true


54
55
56
57
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 54

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.


43
44
45
46
47
48
49
50
51
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 43

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'pulp_created' => :'DateTime',
    :'size' => :'Integer',
    :'completed' => :'DateTime',
    :'chunks' => :'Array<UploadChunkResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


117
118
119
120
121
122
123
124
125
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      pulp_created == o.pulp_created &&
      size == o.size &&
      completed == o.completed &&
      chunks == o.chunks
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


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
200
201
202
203
204
205
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 170

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


239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 239

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


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

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

129
130
131
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 129

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


135
136
137
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 135

def hash
  [pulp_href, pulp_created, size, completed, chunks].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


99
100
101
102
103
104
105
106
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 99

def list_invalid_properties
  invalid_properties = Array.new
  if @size.nil?
    invalid_properties.push('invalid value for "size", size cannot be nil.')
  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


215
216
217
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 215

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


221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 221

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


209
210
211
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 209

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


110
111
112
113
# File 'lib/pulpcore_client/models/upload_detail_response.rb', line 110

def valid?
  return false if @size.nil?
  true
end