Class: Bfwd::FixedTermPagedMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/fixed_term_paged_metadata.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FixedTermPagedMetadata

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
101
102
103
104
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 68

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'nextPage')
    self.next_page = attributes[:'nextPage']
  end

  if attributes.has_key?(:'currentPage')
    self.current_page = attributes[:'currentPage']
  end

  if attributes.has_key?(:'currentOffset')
    self.current_offset = attributes[:'currentOffset']
  end

  if attributes.has_key?(:'recordsRequested')
    self.records_requested = attributes[:'recordsRequested']
  end

  if attributes.has_key?(:'recordsReturned')
    self.records_returned = attributes[:'recordsReturned']
  end

  if attributes.has_key?(:'executionTime')
    self.execution_time = attributes[:'executionTime']
  end

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

end

Instance Attribute Details

#current_offset ⇒ Object

parameter. 0-indexed. Describes your current location within a pageable list of query results.“,”verbs“:



25
26
27
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 25

def current_offset
  @current_offset
end

#current_page ⇒ Object

parameter. 0-indexed. Describes which page (given a page size of ‘recordsRequested`) of the result set you are viewing.“,”verbs“:



22
23
24
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 22

def current_page
  @current_page
end

#execution_time ⇒ Object

of milliseconds taken by API to calculate response.“,”verbs“:



34
35
36
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 34

def execution_time
  @execution_time
end

#next_page ⇒ Object

parameter. URL fragment that can be used to fetch next page of results.“,”verbs“:



19
20
21
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 19

def next_page
  @next_page
end

#records_requested ⇒ Object

parameter. Describes how many records you requested.“,”verbs“:



28
29
30
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 28

def records_requested
  @records_requested
end

#records_returned ⇒ Object

how many records were returned by your query.“,”verbs“:



31
32
33
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 31

def records_returned
  @records_returned
end

#results ⇒ Object

results returned by your query.“,”verbs“:



37
38
39
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 37

def results
  @results
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 41

def self.attribute_map
  {
    :'next_page' => :'nextPage',
    :'current_page' => :'currentPage',
    :'current_offset' => :'currentOffset',
    :'records_requested' => :'recordsRequested',
    :'records_returned' => :'recordsReturned',
    :'execution_time' => :'executionTime',
    :'results' => :'results'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 54

def self.swagger_types
  {
    :'next_page' => :'String',
    :'current_page' => :'Integer',
    :'current_offset' => :'Integer',
    :'records_requested' => :'Integer',
    :'records_returned' => :'Integer',
    :'execution_time' => :'Integer',
    :'results' => :'Array<FixedTerm>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      next_page == o.next_page &&
      current_page == o.current_page &&
      current_offset == o.current_offset &&
      records_requested == o.records_requested &&
      records_returned == o.records_returned &&
      execution_time == o.execution_time &&
      results == o.results
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



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
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 204

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
    temp_model = Bfwd.const_get(type).new
    temp_model.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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 270

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 183

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


170
171
172
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 176

def hash
  [next_page, current_page, current_offset, records_requested, records_returned, execution_time, results].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
136
137
138
139
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 108

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

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

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

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

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

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

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

  return 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



250
251
252
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 250

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



256
257
258
259
260
261
262
263
264
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 256

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



244
245
246
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 244

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



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bf_ruby2/models/fixed_term_paged_metadata.rb', line 143

def valid?
  return false if @next_page.nil?
  return false if @current_page.nil?
  return false if @current_offset.nil?
  return false if @records_requested.nil?
  return false if @records_returned.nil?
  return false if @execution_time.nil?
  return false if @results.nil?
  return true
end