class Fastly::DashboardItemPropertyVisualizationPropertyConfig
[Configuration options](visualization-config) for the given visualization.
Attributes
(Optional) The aggregation function to apply to the dataset.
(Optional) The units to use to format the data.
The type of chart to display.
Public Class Methods
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 58 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 49 def self.attribute_map { :'plot_type' => :'plot_type', :'format' => :'format', :'calculation_method' => :'calculation_method' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 186 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 72 def self.fastly_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 63 def self.fastly_types { :'plot_type' => :'String', :'format' => :'String', :'calculation_method' => :'String' } end
Attribute type mapping.
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 79 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::DashboardItemPropertyVisualizationPropertyConfig` 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::DashboardItemPropertyVisualizationPropertyConfig`. 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?(:'plot_type') self.plot_type = attributes[:'plot_type'] end if attributes.key?(:'format') self.format = attributes[:'format'] else self.format = 'number' end if attributes.key?(:'calculation_method') self.calculation_method = attributes[:'calculation_method'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Public Instance Methods
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 163 def ==(o) return true if self.equal?(o) self.class == o.class && plot_type == o.plot_type && format == o.format && calculation_method == o.calculation_method end
Checks equality by comparing each attribute. @param [Object] Object
to be compared
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 216 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 287 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
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
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 193 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 153 def calculation_method=(calculation_method) validator = EnumAttributeValidator.new('String', ["avg", "sum", "min", "max", "latest", "p95"]) unless validator.valid?(calculation_method) fail ArgumentError, "invalid value for \"calculation_method\", must be one of #{validator.allowable_values}." end @calculation_method = calculation_method end
Custom attribute writer method checking allowed values (enum). @param [Object] calculation_method
Object
to be assigned
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 173 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object
to be compared
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 143 def format=(format) validator = EnumAttributeValidator.new('String', ["number", "bytes", "percent", "requests", "responses", "seconds", "milliseconds", "ratio", "bitrate"]) unless validator.valid?(format) fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}." end @format = format end
Custom attribute writer method checking allowed values (enum). @param [Object] format Object
to be assigned
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 179 def hash [plot_type, format, calculation_method].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 109 def list_invalid_properties invalid_properties = Array.new if @plot_type.nil? invalid_properties.push('invalid value for "plot_type", plot_type cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 133 def plot_type=(plot_type) validator = EnumAttributeValidator.new('String', ["line", "bar", "single-metric", "donut"]) unless validator.valid?(plot_type) fail ArgumentError, "invalid value for \"plot_type\", must be one of #{validator.allowable_values}." end @plot_type = plot_type end
Custom attribute writer method checking allowed values (enum). @param [Object] plot_type
Object
to be assigned
Source
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 269 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 257 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/fastly/models/dashboard_item_property_visualization_property_config.rb, line 120 def valid? return false if @plot_type.nil? plot_type_validator = EnumAttributeValidator.new('String', ["line", "bar", "single-metric", "donut"]) return false unless plot_type_validator.valid?(@plot_type) format_validator = EnumAttributeValidator.new('String', ["number", "bytes", "percent", "requests", "responses", "seconds", "milliseconds", "ratio", "bitrate"]) return false unless format_validator.valid?(@format) calculation_method_validator = EnumAttributeValidator.new('String', ["avg", "sum", "min", "max", "latest", "p95"]) return false unless calculation_method_validator.valid?(@calculation_method) true end
Check to see if the all the properties in the model are valid @return true if the model is valid