Class: Fastly::DashboardItemPropertyVisualizationPropertyConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/dashboard_item_property_visualization_property_config.rb

Overview

[Configuration options](#visualization-config) for the given visualization.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DashboardItemPropertyVisualizationPropertyConfig

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# 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

Instance Attribute Details

#calculation_method ⇒ Object

(Optional) The aggregation function to apply to the dataset.



24
25
26
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 24

def calculation_method
  @calculation_method
end

#format ⇒ Object

(Optional) The units to use to format the data.



21
22
23
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 21

def format
  @format
end

#plot_type ⇒ Object

The type of chart to display.



18
19
20
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 18

def plot_type
  @plot_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
 
# 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

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



186
187
188
 
# 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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 72

def self.fastly_nullable
  Set.new([
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
 
# 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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# 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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 179

def hash
  [plot_type, format, calculation_method].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



109
110
111
112
113
114
115
116
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



263
264
265
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 263

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



257
258
259
 
# File 'lib/fastly/models/dashboard_item_property_visualization_property_config.rb', line 257

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



120
121
122
123
124
125
126
127
128
129
 
# 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