Class: Wavefront::Source

Inherits:
CoreApi show all
Includes:
Mixin::Tag
Defined in:
lib/wavefront-sdk/source.rb

Overview

View and manage source metadata.

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts

Instance Method Summary collapse

Methods included from Mixin::Tag

#tag_add, #tag_delete, #tag_set, #tags

Methods inherited from CoreApi

#api_base, #api_path, #hash_for_update, #initialize, #setup_api, #time_to_ms

Methods included from Mixins

#log, #parse_relative_time, #parse_time, #relative_time, #time_multiplier, #valid_relative_time?

Methods included from Validators

#uuid?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?

Constructor Details

This class inherits a constructor from Wavefront::CoreApi

Instance Method Details

#create(body) ⇒ Wavefront::Response

POST /api/v2/source Create metadata (description or tags) for a specific source.

Refer to the Swagger API docs for valid keys.

Parameters:

  • body (Hash) —

    description of source

Returns:

Raises:

  • (ArgumentError) 


38
39
40
41
 
# File 'lib/wavefront-sdk/source.rb', line 38

def create(body)
  raise ArgumentError unless body.is_a?(Hash)
  api.post('', body, 'application/json')
end

#delete(id) ⇒ Wavefront::Response

DELETE /api/v2/source/id Delete metadata (description and tags) for a specific source.

Parameters:

  • id (String) —

    ID of the source

Returns:



49
50
51
52
 
# File 'lib/wavefront-sdk/source.rb', line 49

def delete(id)
  wf_source_id?(id)
  api.delete(id)
end

#describe(id, version = nil) ⇒ Wavefront::Response

GET /api/v2/source/id Get a specific source for a customer.

Parameters:

  • id (String) —

    ID of the source

Returns:



77
78
79
80
81
82
83
 
# File 'lib/wavefront-sdk/source.rb', line 77

def describe(id, version = nil)
  wf_source_id?(id)
  wf_version?(version) if version
  fragments = [id]
  fragments += ['history', version] if version
  api.get(fragments.uri_concat)
end

#description_delete(id) ⇒ Object

DELETE /api/v2/source/id/description Remove description from a specific source



66
67
68
69
 
# File 'lib/wavefront-sdk/source.rb', line 66

def description_delete(id)
  wf_source_id?(id)
  api.delete([id, 'description'].uri_concat)
end

#description_set(id, description) ⇒ Object

POST /api/v2/source/id/description Set description associated with a specific source



57
58
59
60
61
 
# File 'lib/wavefront-sdk/source.rb', line 57

def description_set(id, description)
  wf_source_id?(id)
  api.post([id, 'description'].uri_concat, description,
           'application/json')
end

#list(limit = nil, cursor = nil) ⇒ Wavefront::Response

GET /api/v2/source Get all sources for a customer

Parameters:

  • limit (Integer) (defaults to: nil) —

    the number of sources to return

  • cursor (String) (defaults to: nil) —

    source at which the list begins

Returns:



22
23
24
25
26
27
28
 
# File 'lib/wavefront-sdk/source.rb', line 22

def list(limit = nil, cursor = nil)
  qs = {}
  qs[:limit] = limit if limit
  qs[:cursor] = cursor if cursor

  api.get('', qs)
end

#update(id, body, modify = true) ⇒ Wavefront::Response

PUT /api/v2/source/id Update metadata (description or tags) for a specific source.

Parameters:

  • id (String) —

    a Wavefront alert ID

  • body (Hash) —

    key-value hash of the parameters you wish to change

  • modify (true, false) (defaults to: true) —

    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.

Returns:

Raises:

  • (ArgumentError) 


96
97
98
99
100
101
102
103
104
 
# File 'lib/wavefront-sdk/source.rb', line 96

def update(id, body, modify = true)
  wf_source_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 ⇒ Object 



11
12
13
 
# File 'lib/wavefront-sdk/source.rb', line 11

def update_keys
  %i[sourceName tags description]
end

#valid_id?(id) ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/wavefront-sdk/source.rb', line 106

def valid_id?(id)
  wf_source_id?(id)
end