Class: Wavefront::Source
Overview
View and manage source metadata.
Instance Attribute Summary
Attributes inherited from Base
#api_base, #conn, #debug, #logger, #net, #noop, #opts, #verbose
Instance Method Summary collapse
-
#create(body) ⇒ Wavefront::Response
POST /api/v2/source Create metadata (description or tags) for a specific source.
-
#delete(id) ⇒ Wavefront::Response
DELETE /api/v2/source/id Delete metadata (description and tags) for a specific source.
-
#describe(id, version = nil) ⇒ Wavefront::Response
GET /api/v2/source/id Get a specific source for a customer.
-
#list(offset = 0, limit = 100) ⇒ Wavefront::Response
GET /api/v2/source Get all sources for a customer.
-
#tag_add(id, tag) ⇒ Wavefront::Response
PUT /api/v2/source/id/tag/tagValue Add a tag to a specific source.
-
#tag_delete(id, tag) ⇒ Wavefront::Response
DELETE /api/v2/source/id/tag/tagValue Remove a tag from a specific source.
-
#tag_set(id, tags) ⇒ Wavefront::Response
POST /api/v2/source/id/tag Set all tags associated with a specific source.
-
#tags(id) ⇒ Wavefront::Response
GET /api/v2/source/id/tag Get all tags associated with a specific source.
-
#update(id, body, modify = true) ⇒ Wavefront::Response
PUT /api/v2/source/id Update metadata (description or tags) for a specific source.
- #update_keys ⇒ Object
Methods inherited from Base
#api_delete, #api_get, #api_post, #api_put, #hash_for_update, #initialize, #log, #mk_conn, #respond, #time_to_ms
Methods included from Mixins
Methods included from Validators
#wf_alert_id?, #wf_alert_severity?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_ms_ts?, #wf_name?, #wf_point?, #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_value?, #wf_version?, #wf_webhook_id?
Constructor Details
This class inherits a constructor from Wavefront::Base
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.
31 32 33 34 |
# File 'lib/wavefront-sdk/source.rb', line 31 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.
42 43 44 45 |
# File 'lib/wavefront-sdk/source.rb', line 42 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.
53 54 55 56 57 58 59 |
# File 'lib/wavefront-sdk/source.rb', line 53 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 |
#list(offset = 0, limit = 100) ⇒ Wavefront::Response
GET /api/v2/source Get all sources for a customer
19 20 21 |
# File 'lib/wavefront-sdk/source.rb', line 19 def list(offset = 0, limit = 100) api_get('', { offset: offset, limit: limit }) end |
#tag_add(id, tag) ⇒ Wavefront::Response
PUT /api/v2/source/id/tag/tagValue Add a tag to a specific source
127 128 129 130 131 |
# File 'lib/wavefront-sdk/source.rb', line 127 def tag_add(id, tag) wf_source_id?(id) wf_string?(tag) api_put([id, 'tag', tag].uri_concat) end |
#tag_delete(id, tag) ⇒ Wavefront::Response
DELETE /api/v2/source/id/tag/tagValue Remove a tag from a specific source.
114 115 116 117 118 |
# File 'lib/wavefront-sdk/source.rb', line 114 def tag_delete(id, tag) wf_source_id?(id) wf_string?(tag) api_delete([id, 'tag', tag].uri_concat) end |
#tag_set(id, tags) ⇒ Wavefront::Response
POST /api/v2/source/id/tag Set all tags associated with a specific source.
100 101 102 103 104 105 |
# File 'lib/wavefront-sdk/source.rb', line 100 def tag_set(id, ) wf_source_id?(id) = Array() .each { |t| wf_string?(t) } api_post([id, 'tag'].uri_concat, .to_json, 'application/json') end |
#tags(id) ⇒ Wavefront::Response
GET /api/v2/source/id/tag Get all tags associated with a specific source.
88 89 90 91 |
# File 'lib/wavefront-sdk/source.rb', line 88 def (id) wf_source_id?(id) api_get([id, 'tag'].uri_concat) end |
#update(id, body, modify = true) ⇒ Wavefront::Response
PUT /api/v2/source/id Update metadata (description or tags) for a specific source.
72 73 74 75 76 77 78 79 80 |
# File 'lib/wavefront-sdk/source.rb', line 72 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
8 9 10 |
# File 'lib/wavefront-sdk/source.rb', line 8 def update_keys %i(sourceName tags description) end |