Class: Fastly::DashboardItem

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

Overview

A dashboard item. Typically a data visualization like a chart.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DashboardItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
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
106
107
108
 
# 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

Instance Attribute Details

#data_source ⇒ Object

Returns the value of attribute data_source.



23
24
25
 
# File 'lib/fastly/models/dashboard_item.rb', line 23

def data_source
  @data_source
end

#id ⇒ Object

Dashboard item identifier (UUID)



28
29
30
 
# File 'lib/fastly/models/dashboard_item.rb', line 28

def id
  @id
end

#span ⇒ Object

The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.



31
32
33
 
# File 'lib/fastly/models/dashboard_item.rb', line 31

def span
  @span
end

#subtitle ⇒ Object

A human-readable subtitle for the dashboard item. Often a description of the visualization.



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

def subtitle
  @subtitle
end

#title ⇒ Object

A human-readable title for the dashboard item



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

def title
  @title
end

#visualization ⇒ Object

Returns the value of attribute visualization.



25
26
27
 
# File 'lib/fastly/models/dashboard_item.rb', line 25

def visualization
  @visualization
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/fastly/models/dashboard_item.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# 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

.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



251
252
253
 
# File 'lib/fastly/models/dashboard_item.rb', line 251

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



63
64
65
66
 
# File 'lib/fastly/models/dashboard_item.rb', line 63

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

.fastly_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
 
# 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

#_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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# 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

#_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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# 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

#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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/fastly/models/dashboard_item.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/fastly/models/dashboard_item.rb', line 244

def hash
  [title, subtitle, data_source, visualization, id, span].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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
 
# File 'lib/fastly/models/dashboard_item.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/fastly/models/dashboard_item.rb', line 322

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



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# 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