class Fastly::DashboardItem
A dashboard item. Typically a data visualization like a chart.
Attributes
Dashboard
item identifier (UUID)
The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
A human-readable subtitle for the dashboard item. Often a description of the visualization.
A human-readable title for the dashboard item
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/fastly/models/dashboard_item.rb, line 46 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/fastly/models/dashboard_item.rb, line 34 def self.attribute_map { :'title' => :'title', :'subtitle' => :'subtitle', :'data_source' => :'data_source', :'visualization' => :'visualization', :'id' => :'id', :'span' => :'span' } 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/dashboard_item.rb, line 251 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
List of attributes with nullable: true
# File lib/fastly/models/dashboard_item.rb, line 63 def self.fastly_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/fastly/models/dashboard_item.rb, line 51 def self.fastly_types { :'title' => :'String', :'subtitle' => :'String', :'data_source' => :'DashboardItemPropertyDataSource', :'visualization' => :'DashboardItemPropertyVisualization', :'id' => :'String', :'span' => :'Integer' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/fastly/models/dashboard_item.rb, line 70 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::DashboardItem` 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::DashboardItem`. 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?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'subtitle') self.subtitle = attributes[:'subtitle'] end if attributes.key?(:'data_source') self.data_source = attributes[:'data_source'] end if attributes.key?(:'visualization') self.visualization = attributes[:'visualization'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'span') self.span = attributes[:'span'] else self.span = 4 end end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/fastly/models/dashboard_item.rb, line 225 def ==(o) return true if self.equal?(o) self.class == o.class && title == o.title && subtitle == o.subtitle && data_source == o.data_source && visualization == o.visualization && id == o.id && span == o.span 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/dashboard_item.rb, line 281 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/dashboard_item.rb, line 352 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/dashboard_item.rb, line 258 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/dashboard_item.rb, line 238 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/fastly/models/dashboard_item.rb, line 244 def hash [title, subtitle, data_source, visualization, id, span].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/dashboard_item.rb, line 112 def list_invalid_properties invalid_properties = Array.new if @title.nil? invalid_properties.push('invalid value for "title", title cannot be nil.') end if @title.to_s.length > 255 invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') end if @title.to_s.length < 1 invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.') end if @subtitle.nil? invalid_properties.push('invalid value for "subtitle", subtitle cannot be nil.') end if @subtitle.to_s.length > 255 invalid_properties.push('invalid value for "subtitle", the character length must be smaller than or equal to 255.') end if @subtitle.to_s.length < 1 invalid_properties.push('invalid value for "subtitle", the character length must be great than or equal to 1.') end if @data_source.nil? invalid_properties.push('invalid value for "data_source", data_source cannot be nil.') end if @visualization.nil? invalid_properties.push('invalid value for "visualization", visualization cannot be nil.') end if !@span.nil? && @span > 12 invalid_properties.push('invalid value for "span", must be smaller than or equal to 12.') end if !@span.nil? && @span < 1 invalid_properties.push('invalid value for "span", must be greater than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] span Value to be assigned
# File lib/fastly/models/dashboard_item.rb, line 211 def span=(span) if !span.nil? && span > 12 fail ArgumentError, 'invalid value for "span", must be smaller than or equal to 12.' end if !span.nil? && span < 1 fail ArgumentError, 'invalid value for "span", must be greater than or equal to 1.' end @span = span end
Custom attribute writer method with validation @param [Object] subtitle Value to be assigned
# File lib/fastly/models/dashboard_item.rb, line 193 def subtitle=(subtitle) if subtitle.nil? fail ArgumentError, 'subtitle cannot be nil' end if subtitle.to_s.length > 255 fail ArgumentError, 'invalid value for "subtitle", the character length must be smaller than or equal to 255.' end if subtitle.to_s.length < 1 fail ArgumentError, 'invalid value for "subtitle", the character length must be great than or equal to 1.' end @subtitle = subtitle end
Custom attribute writer method with validation @param [Object] title Value to be assigned
# File lib/fastly/models/dashboard_item.rb, line 175 def title=(title) if title.nil? fail ArgumentError, 'title cannot be nil' end if title.to_s.length > 255 fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' end if title.to_s.length < 1 fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.' end @title = title end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/fastly/models/dashboard_item.rb, line 334 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/dashboard_item.rb, line 322 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/dashboard_item.rb, line 159 def valid? return false if @title.nil? return false if @title.to_s.length > 255 return false if @title.to_s.length < 1 return false if @subtitle.nil? return false if @subtitle.to_s.length > 255 return false if @subtitle.to_s.length < 1 return false if @data_source.nil? return false if @visualization.nil? return false if !@span.nil? && @span > 12 return false if !@span.nil? && @span < 1 true end