Class: PulpcoreClient::ProgressReportResponse

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

Overview

Base serializer for use with :class:`pulpcore.app.models.Model` This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the “ref_name“ attribute in the ModelSerializers's “Meta“ class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProgressReportResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
96
97
98
99
100
101
102
103
104
105
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 69

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

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

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

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

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

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

Instance Attribute Details

#codeObject

Identifies the type of progress report'.


22
23
24
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 22

def code
  @code
end

#doneObject

The count of items already processed. Defaults to 0.


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

def done
  @done
end

#messageObject

The message shown to the user for the progress report.


19
20
21
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 19

def message
  @message
end

#stateObject

The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed' and 'canceled'. The default is 'waiting'.


25
26
27
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 25

def state
  @state
end

#suffixObject

The suffix to be shown with the progress report.


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

def suffix
  @suffix
end

#totalObject

The total count of items.


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

def total
  @total
end

Class Method Details

.attribute_mapObject

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


37
38
39
40
41
42
43
44
45
46
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 37

def self.attribute_map
  {
    :'message' => :'message',
    :'code' => :'code',
    :'state' => :'state',
    :'total' => :'total',
    :'done' => :'done',
    :'suffix' => :'suffix'
  }
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


148
149
150
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 148

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

.openapi_nullableObject

List of attributes with nullable: true


61
62
63
64
65
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 61

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

.openapi_typesObject

Attribute type mapping.


49
50
51
52
53
54
55
56
57
58
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 49

def self.openapi_types
  {
    :'message' => :'String',
    :'code' => :'String',
    :'state' => :'String',
    :'total' => :'Integer',
    :'done' => :'Integer',
    :'suffix' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


122
123
124
125
126
127
128
129
130
131
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 122

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message == o.message &&
      code == o.code &&
      state == o.state &&
      total == o.total &&
      done == o.done &&
      suffix == o.suffix
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


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
206
207
208
209
210
211
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 176

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


245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 245

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


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 155

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

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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


141
142
143
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 141

def hash
  [message, code, state, total, done, suffix].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


109
110
111
112
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 109

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


221
222
223
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 221

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


227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 227

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


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

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


116
117
118
# File 'lib/pulpcore_client/models/progress_report_response.rb', line 116

def valid?
  true
end