Class: OpenapiClient::Pagination

Inherits:
Object
  • Object
show all
Defined in:
lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Pagination

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
96
97
98
99
100
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 68

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

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

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

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

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

Instance Attribute Details

#item_count ⇒ Object

The total number of items



25
26
27
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 25

def item_count
  @item_count
end

#page_count ⇒ Object

The total number of pages



22
23
24
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 22

def page_count
  @page_count
end

#page_index ⇒ Object

The current page



31
32
33
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 31

def page_index
  @page_index
end

#page_size ⇒ Object

The number of items per page



28
29
30
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 28

def page_size
  @page_size
end

#version ⇒ Object

The version of this object. The version will be incremented each time the object is modified



19
20
21
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 19

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 34

def self.attribute_map
  {
    :'version' => :'version',
    :'page_count' => :'pageCount',
    :'item_count' => :'itemCount',
    :'page_size' => :'pageSize',
    :'page_index' => :'pageIndex'
  }
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



162
163
164
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 50

def self.openapi_types
  {
    :'version' => :'Integer',
    :'page_count' => :'Integer',
    :'item_count' => :'Integer',
    :'page_size' => :'Integer',
    :'page_index' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      version == o.version &&
      page_count == o.page_count &&
      item_count == o.item_count &&
      page_size == o.page_size &&
      page_index == o.page_index
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 192

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = OpenapiClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 263

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 169

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 155

def hash
  [version, page_count, item_count, page_size, page_index].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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 104

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

  if @item_count.nil?
    invalid_properties.push('invalid value for "item_count", item_count cannot be nil.')
  end

  if @page_size.nil?
    invalid_properties.push('invalid value for "page_size", page_size cannot be nil.')
  end

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



239
240
241
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 239

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



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 245

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



233
234
235
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 233

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



127
128
129
130
131
132
133
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/models/pagination.rb', line 127

def valid?
  return false if @page_count.nil?
  return false if @item_count.nil?
  return false if @page_size.nil?
  return false if @page_index.nil?
  true
end