Class: Wavefront::Notificant

Inherits:
CoreApi
  • Object
show all
Defined in:
lib/wavefront-sdk/notificant.rb

Overview

Manage and query Wavefront notification targets.

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts

Instance Method Summary collapse

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_account_id?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_aws_external_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_ingestionpolicy_id?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_metricspolicy_id?, #wf_monitoredcluster_id?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_role_id?, #wf_sampling_value?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_trace?, #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/notificant Create a notification target.

Parameters:

  • body (Hash) —

    description of notification target

Returns:

Raises:

  • (ArgumentError) 


26
27
28
29
30
 
# File 'lib/wavefront-sdk/notificant.rb', line 26

def create(body)
  raise ArgumentError unless body.is_a?(Hash)

  api.post('', body, 'application/json')
end

#delete(id) ⇒ Wavefront::Response

DELETE /api/v2/notificant/id Delete a specific notificant

Parameters:

  • id (String) —

    ID of the notification target

Returns:



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

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

#describe(id) ⇒ Wavefront::Response

GET /api/v2/notificant/id Get a specific notification target

Parameters:

  • id (String) —

    ID of the notification target

Returns:



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

def describe(id)
  wf_notificant_id?(id)
  api.get(id)
end

#list(offset = 0, limit = 100) ⇒ Object

GET /api/v2/notificant Get all notification targets for a customer

Parameters:

  • offset (Int) (defaults to: 0) —

    notificant at which the list begins

  • limit (Int) (defaults to: 100) —

    the number of notification targets to return



16
17
18
 
# File 'lib/wavefront-sdk/notificant.rb', line 16

def list(offset = 0, limit = 100)
  api.get('', offset: offset, limit: limit)
end

#test(id) ⇒ Wavefront::Response

POST /api/v2/notificant/test/id Create a notification target.

Parameters:

  • body (Hash) —

    description of notification target

Returns:



81
82
83
84
 
# File 'lib/wavefront-sdk/notificant.rb', line 81

def test(id)
  wf_notificant_id?(id)
  api.post(['test', id].uri_concat, nil)
end

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

PUT /api/v2/notificant/id Update a specific notification target

Parameters:

  • id (String) —

    a Wavefront notification target 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) 


65
66
67
68
69
70
71
72
73
 
# File 'lib/wavefront-sdk/notificant.rb', line 65

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



86
87
88
89
 
# File 'lib/wavefront-sdk/notificant.rb', line 86

def update_keys
  %i[id contentType method description title template triggers
     recipient customHttpHeaders emailSubject isHtmlContent]
end