class FtcEventsClient::ApiIndexModel
Attributes
api version
current season in the eyes of FTC
max season that can be retrieved from the API/webpages
api name
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/ftc_events_client/models/api_index_model.rb, line 56 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ftc_events_client/models/api_index_model.rb, line 41 def self.attribute_map { :'name' => :'name', :'api_version' => :'apiVersion', :'service_mainifest_name' => :'serviceMainifestName', :'service_mainifest_version' => :'serviceMainifestVersion', :'code_package_name' => :'codePackageName', :'code_package_version' => :'codePackageVersion', :'status' => :'status', :'current_season' => :'currentSeason', :'max_season' => :'maxSeason' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ftc_events_client/models/api_index_model.rb, line 184 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ftc_events_client/models/api_index_model.rb, line 90 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::ApiIndexModel` 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 `FtcEventsClient::ApiIndexModel`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'api_version') self.api_version = attributes[:'api_version'] end if attributes.key?(:'service_mainifest_name') self.service_mainifest_name = attributes[:'service_mainifest_name'] end if attributes.key?(:'service_mainifest_version') self.service_mainifest_version = attributes[:'service_mainifest_version'] end if attributes.key?(:'code_package_name') self.code_package_name = attributes[:'code_package_name'] end if attributes.key?(:'code_package_version') self.code_package_version = attributes[:'code_package_version'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'current_season') self.current_season = attributes[:'current_season'] end if attributes.key?(:'max_season') self.max_season = attributes[:'max_season'] end end
List of attributes with nullable: true
# File lib/ftc_events_client/models/api_index_model.rb, line 76 def self.openapi_nullable Set.new([ :'name', :'api_version', :'service_mainifest_name', :'service_mainifest_version', :'code_package_name', :'code_package_version', :'status', ]) end
Attribute type mapping.
# File lib/ftc_events_client/models/api_index_model.rb, line 61 def self.openapi_types { :'name' => :'String', :'api_version' => :'String', :'service_mainifest_name' => :'String', :'service_mainifest_version' => :'String', :'code_package_name' => :'String', :'code_package_version' => :'String', :'status' => :'String', :'current_season' => :'Integer', :'max_season' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ftc_events_client/models/api_index_model.rb, line 155 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && api_version == o.api_version && service_mainifest_name == o.service_mainifest_name && service_mainifest_version == o.service_mainifest_version && code_package_name == o.code_package_name && code_package_version == o.code_package_version && status == o.status && current_season == o.current_season && max_season == o.max_season 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/ftc_events_client/models/api_index_model.rb, line 214 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 = FtcEventsClient.const_get(type) klass.respond_to?(:openapi_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/ftc_events_client/models/api_index_model.rb, line 285 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/ftc_events_client/models/api_index_model.rb, line 191 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
@see the `==` method @param [Object] Object to be compared
# File lib/ftc_events_client/models/api_index_model.rb, line 171 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ftc_events_client/models/api_index_model.rb, line 177 def hash [name, api_version, service_mainifest_name, service_mainifest_version, code_package_name, code_package_version, status, current_season, max_season].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ftc_events_client/models/api_index_model.rb, line 142 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ftc_events_client/models/api_index_model.rb, line 267 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ftc_events_client/models/api_index_model.rb, line 255 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/ftc_events_client/models/api_index_model.rb, line 149 def valid? true end