module DatadogAPIClient::V1::WidgetDefinition

[Definition of the widget](docs.datadoghq.com/dashboards/widgets/).

Constants

SchemaMismatchError

Public Class Methods

build(data) click to toggle source

Builds the object @param [Mixed] Data to be matched against the list of oneOf items @return [Object] Returns the model or the data itself

# File lib/datadog_api_client/v1/models/widget_definition.rb, line 58
def build(data)
  # Go through the list of oneOf items and attempt to identify the appropriate one.
  # Note:
  # - We do not attempt to check whether exactly one item matches.
  # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
  #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
  # - TODO: scalar values are defacto behaving as if they were nullable.
  # - TODO: logging when debugging is set.
  openapi_one_of.each do |klass|
    begin
      next if klass == :AnyType # "nullable: true"
      typed_data = find_and_cast_into_type(klass, data)
      return typed_data if typed_data
    rescue # rescue all errors so we keep iterating even if the current item lookup raises
    end
  end

  openapi_one_of.include?(:AnyType) ? data : nil
end
openapi_one_of() click to toggle source

List of class defined in oneOf (OpenAPI v3)

# File lib/datadog_api_client/v1/models/widget_definition.rb, line 24
def openapi_one_of
  [
    :'AlertGraphWidgetDefinition',
    :'AlertValueWidgetDefinition',
    :'ChangeWidgetDefinition',
    :'CheckStatusWidgetDefinition',
    :'DistributionWidgetDefinition',
    :'EventStreamWidgetDefinition',
    :'EventTimelineWidgetDefinition',
    :'FreeTextWidgetDefinition',
    :'GeomapWidgetDefinition',
    :'GroupWidgetDefinition',
    :'HeatMapWidgetDefinition',
    :'HostMapWidgetDefinition',
    :'IFrameWidgetDefinition',
    :'ImageWidgetDefinition',
    :'LogStreamWidgetDefinition',
    :'MonitorSummaryWidgetDefinition',
    :'NoteWidgetDefinition',
    :'QueryValueWidgetDefinition',
    :'SLOWidgetDefinition',
    :'ScatterPlotWidgetDefinition',
    :'ServiceMapWidgetDefinition',
    :'ServiceSummaryWidgetDefinition',
    :'TableWidgetDefinition',
    :'TimeseriesWidgetDefinition',
    :'ToplistWidgetDefinition',
    :'TreeMapWidgetDefinition'
  ]
end

Private Class Methods

find_and_cast_into_type(klass, data) click to toggle source

Note: 'File' is missing here because in the regular case we get the data after a call to JSON.parse.

# File lib/datadog_api_client/v1/models/widget_definition.rb, line 83
def find_and_cast_into_type(klass, data)
  return if data.nil?

  case klass.to_s
  when 'Boolean'
    return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
  when 'Float'
    return data if data.instance_of?(Float)
  when 'Integer'
    return data if data.instance_of?(Integer)
  when 'Time'
    return Time.parse(data)
  when 'Date'
    return Date.parse(data)
  when 'String'
    return data if data.instance_of?(String)
  when 'Object' # "type: object"
    return data if data.instance_of?(Hash)
  when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
    if data.instance_of?(Array)
      sub_type = Regexp.last_match[:sub_type]
      return data.map { |item| find_and_cast_into_type(sub_type, item) }
    end
  when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
    if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
      sub_type = Regexp.last_match[:sub_type]
      return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
    end
  else # model
    const = DatadogAPIClient::V1.const_get(klass)
    if const
      if const.respond_to?(:openapi_one_of) # nested oneOf model
        model = const.build(data)
        return model if model
      else
        # raise if data contains keys that are not known to the model
        raise unless (data.keys - const.acceptable_attributes).empty?
        model = const.build_from_hash(data)
        return model if model && model.valid?
      end
    end
  end

  raise # if no match by now, raise
rescue
  raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
end