class Fastly::PaginationMeta
Attributes
Current page.
Number of records per page.
Total records in result set.
Total pages in result set.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/fastly/models/pagination_meta.rb, line 39 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/fastly/models/pagination_meta.rb, line 29 def self.attribute_map { :'current_page' => :'current_page', :'per_page' => :'per_page', :'record_count' => :'record_count', :'total_pages' => :'total_pages' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/fastly/models/pagination_meta.rb, line 156 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
List of attributes with nullable: true
# File lib/fastly/models/pagination_meta.rb, line 54 def self.fastly_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/fastly/models/pagination_meta.rb, line 44 def self.fastly_types { :'current_page' => :'Integer', :'per_page' => :'Integer', :'record_count' => :'Integer', :'total_pages' => :'Integer' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/fastly/models/pagination_meta.rb, line 61 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::PaginationMeta` 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 `Fastly::PaginationMeta`. 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?(:'current_page') self.current_page = attributes[:'current_page'] end if attributes.key?(:'per_page') self.per_page = attributes[:'per_page'] else self.per_page = 20 end if attributes.key?(:'record_count') self.record_count = attributes[:'record_count'] end if attributes.key?(:'total_pages') self.total_pages = attributes[:'total_pages'] end end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/fastly/models/pagination_meta.rb, line 132 def ==(o) return true if self.equal?(o) self.class == o.class && current_page == o.current_page && per_page == o.per_page && record_count == o.record_count && total_pages == o.total_pages end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/fastly/models/pagination_meta.rb, line 186 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 = Fastly.const_get(type) klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/fastly/models/pagination_meta.rb, line 257 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/fastly/models/pagination_meta.rb, line 163 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.fastly_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_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
@see the ‘==` method @param [Object] Object
to be compared
# File lib/fastly/models/pagination_meta.rb, line 143 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/fastly/models/pagination_meta.rb, line 149 def hash [current_page, per_page, record_count, total_pages].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/fastly/models/pagination_meta.rb, line 95 def list_invalid_properties invalid_properties = Array.new if !@per_page.nil? && @per_page > 100 invalid_properties.push('invalid value for "per_page", must be smaller than or equal to 100.') end if !@per_page.nil? && @per_page < 1 invalid_properties.push('invalid value for "per_page", must be greater than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] per_page
Value to be assigned
# File lib/fastly/models/pagination_meta.rb, line 118 def per_page=(per_page) if !per_page.nil? && per_page > 100 fail ArgumentError, 'invalid value for "per_page", must be smaller than or equal to 100.' end if !per_page.nil? && per_page < 1 fail ArgumentError, 'invalid value for "per_page", must be greater than or equal to 1.' end @per_page = per_page end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/fastly/models/pagination_meta.rb, line 239 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.fastly_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/fastly/models/pagination_meta.rb, line 227 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/fastly/models/pagination_meta.rb, line 110 def valid? return false if !@per_page.nil? && @per_page > 100 return false if !@per_page.nil? && @per_page < 1 true end