class SwaggerClient::ClientIndex
A client index.
Attributes
The action performed on this object.
The unique ID of the client index.
The name of the client index.
When `true`, indicates that the index is required when creating profiles in business mode.
When `true`, indicates that the index is required when creating profiles in consumer mode.
Contains information about the index's possible values.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/swagger_client/models/client_index.rb, line 59 def self.attribute_map { :'id' => :'Id', :'name' => :'Name', :'required_business_mode' => :'RequiredBusinessMode', :'required_consumer_mode' => :'RequiredConsumerMode', :'values' => :'Values', :'action' => :'Action' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/swagger_client/models/client_index.rb, line 84 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?(:'Id') self.id = attributes[:'Id'] end if attributes.has_key?(:'Name') self.name = attributes[:'Name'] end if attributes.has_key?(:'RequiredBusinessMode') self.required_business_mode = attributes[:'RequiredBusinessMode'] end if attributes.has_key?(:'RequiredConsumerMode') self.required_consumer_mode = attributes[:'RequiredConsumerMode'] end if attributes.has_key?(:'Values') if (value = attributes[:'Values']).is_a?(Array) self.values = value end end if attributes.has_key?(:'Action') self.action = attributes[:'Action'] end end
Attribute type mapping.
# File lib/swagger_client/models/client_index.rb, line 71 def self.swagger_types { :'id' => :'Integer', :'name' => :'String', :'required_business_mode' => :'BOOLEAN', :'required_consumer_mode' => :'BOOLEAN', :'values' => :'Array<ClientIndexValue>', :'action' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/swagger_client/models/client_index.rb, line 144 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && required_business_mode == o.required_business_mode && required_consumer_mode == o.required_consumer_mode && values == o.values && action == o.action 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/swagger_client/models/client_index.rb, line 191 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 = SwaggerClient.const_get(type).new temp_model.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/swagger_client/models/client_index.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
Custom attribute writer method checking allowed values (enum). @param [Object] action Object to be assigned
# File lib/swagger_client/models/client_index.rb, line 134 def action=(action) validator = EnumAttributeValidator.new('String', ['None', 'Added', 'Updated', 'Failed', 'Removed']) unless validator.valid?(action) fail ArgumentError, 'invalid value for "action", must be one of #{validator.allowable_values}.' end @action = action end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/swagger_client/models/client_index.rb, line 170 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
@see the `==` method @param [Object] Object to be compared
# File lib/swagger_client/models/client_index.rb, line 157 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/swagger_client/models/client_index.rb, line 163 def hash [id, name, required_business_mode, required_consumer_mode, values, action].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/swagger_client/models/client_index.rb, line 119 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/swagger_client/models/client_index.rb, line 243 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/swagger_client/models/client_index.rb, line 231 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/swagger_client/models/client_index.rb, line 126 def valid? action_validator = EnumAttributeValidator.new('String', ['None', 'Added', 'Updated', 'Failed', 'Removed']) return false unless action_validator.valid?(@action) true end