Class: DatadogAPIClient::V1::FunnelWidgetDefinition

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/funnel_widget_definition.rb

Overview

The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 42

def additional_properties
  @additional_properties
end

#requests ⇒ Object

Request payload used to query items.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 26

def requests
  @requests
end

#time ⇒ Object

Time setting for the widget.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 28

def time
  @time
end

#title ⇒ Object

The title of the widget.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 31

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 34

def title_align
  @title_align
end

#title_size ⇒ Object

The size of the title.



36
37
38
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 36

def title_size
  @title_size
end

#type ⇒ Object

Type of funnel widget.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 40

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 53

def self.acceptable_attributes
  attribute_map.values
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



198
199
200
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 198

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 70

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

Instance Method Details

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



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 228

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 :Array
    # generic array, 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 = DatadogAPIClient::V1.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 306

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 205

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_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


185
186
187
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 185

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 121

def list_invalid_properties
  invalid_properties = Array.new
  if @requests.nil?
    invalid_properties.push('invalid value for "requests", requests cannot be nil.')
  end

  if @requests.length > 1
    invalid_properties.push('invalid value for "requests", number of items must be less than or equal to 1.')
  end

  if @requests.length < 1
    invalid_properties.push('invalid value for "requests", number of items must be greater than or equal to 1.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", 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



282
283
284
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 282

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



276
277
278
 
# File 'lib/datadog_api_client/v1/models/funnel_widget_definition.rb', line 276

def to_s
  to_hash.to_s
end