Method: Grafana::Grafana#dashboard

Defined in:
lib/grafana/grafana.rb

#dashboard(dashboard_uid) ⇒ Dashboard

Returns dashboard object, if it has been found.

Parameters:

  • dashboard_uid (String) —

    UID of the searched Dashboard

Returns:

  • (Dashboard) —

    dashboard object, if it has been found

Raises:



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/grafana/grafana.rb', line 153

def dashboard(dashboard_uid)
  return @dashboards[dashboard_uid] if @dashboards[dashboard_uid]

  response = prepare_request({ relative_url: "/api/dashboards/uid/#{dashboard_uid}" }).execute
  raise DashboardDoesNotExistError, dashboard_uid unless response.is_a?(Net::HTTPOK)

  # cache dashboard for reuse
  model = JSON.parse(response.body)['dashboard']
  @dashboards[dashboard_uid] = Dashboard.new(model, self)

  @dashboards[dashboard_uid]
end