class Wavefront::Dashboard

View and manage dashboards.

Public Instance Methods

create(body) click to toggle source

POST /api/v2/dashboard Create a specific dashboard. Refer to the Swagger API docs for valid keys.

@param body [Hash] description of dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 37
def create(body)
  raise ArgumentError unless body.is_a?(Hash)

  api.post('', body, 'application/json')
end
delete(id) click to toggle source

DELETE /api/v2/dashboard/id Delete a specific dashboard. Deleting an active dashboard moves it to 'trash', from where it can be restored with an undelete operation. Deleting a dashboard in 'trash' removes it for ever.

@param id [String] ID of the dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 52
def delete(id)
  wf_dashboard_id?(id)
  api.delete(id)
end
describe(id, version = nil) click to toggle source

GET /api/v2/dashboard/id Get a specific dashboard / Get a specific historical version of a specific dashboard.

@param id [String] ID of the dashboard @param version [Integer] version of dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 65
def describe(id, version = nil)
  wf_dashboard_id?(id)
  wf_version?(version) if version
  fragments = [id]
  fragments += ['history', version] if version
  api.get(fragments.uri_concat)
end
favorite(id) click to toggle source

POST /api/v2/dashboard/{id}/favorite Mark a dashboard as favorite

@param id [String] ID of the dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 100
def favorite(id)
  wf_dashboard_id?(id)
  api.post([id, 'favorite'].uri_concat)
end
Also aliased as: favourite
favourite(id)
Alias for: favorite
history(id) click to toggle source

GET /api/v2/dashboard/id/history Get the version history of a dashboard.

@param id [String] ID of the dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 112
def history(id)
  wf_dashboard_id?(id)
  api.get([id, 'history'].uri_concat)
end
list(offset = 0, limit = 100) click to toggle source

GET /api/v2/dashboard Get all dashboards for a customer.

@param offset [Int] dashboard at which the list begins @param limit [Int] the number of dashboards to return @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 26
def list(offset = 0, limit = 100)
  api.get('', offset: offset, limit: limit)
end
undelete(id) click to toggle source

POST /api/v2/dashboard/id/undelete Move a dashboard from 'trash' back into active service.

@param id [String] ID of the dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 123
def undelete(id)
  wf_dashboard_id?(id)
  api.post([id, 'undelete'].uri_concat)
end
unfavorite(id) click to toggle source

POST /api/v2/dashboard/{id}/unfavorite Unmark a dashboard as favorite

@param id [String] ID of the dashboard @return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 134
def unfavorite(id)
  wf_dashboard_id?(id)
  api.post([id, 'unfavorite'].uri_concat)
end
Also aliased as: unfavourite
unfavourite(id)
Alias for: unfavorite
update(id, body, modify = true) click to toggle source

PUT /api/v2/dashboard/id Update a specific dashboard.

@param id [String] a Wavefront alert ID @param body [Hash] key-value hash of the parameters you wish

to change

@param modify [true, false] if true, use {#describe()} to get

a hash describing the existing object, and modify that with
the new body. If false, pass the new body straight through.

@return [Wavefront::Response]

# File lib/wavefront-sdk/dashboard.rb, line 84
def update(id, body, modify = true)
  wf_dashboard_id?(id)
  raise ArgumentError unless body.is_a?(Hash)

  return api.put(id, body, 'application/json') unless modify

  api.put(id, hash_for_update(describe(id).response, body),
          'application/json')
end
update_keys() click to toggle source
# File lib/wavefront-sdk/dashboard.rb, line 15
def update_keys
  %i[id name url description sections]
end
valid_id?(id) click to toggle source
# File lib/wavefront-sdk/dashboard.rb, line 140
def valid_id?(id)
  wf_dashboard_id?(id)
end