Class: Wavefront::Message

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

Overview

Manage and query Wavefront messages.

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts, #update_keys

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

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

GET /api/v2/message Gets messages applicable to the current user, i.e. within time range and distribution scope

Parameters:

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

    agent at which the list begins

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

    the number of agents to return



17
18
19
 
# File 'lib/wavefront-sdk/message.rb', line 17

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

#read(id) ⇒ Object

POST /api/v2/message/id/read Mark a specific message as read

Parameters:

  • id (String) —

    message ID to mark as read



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

def read(id)
  wf_message_id?(id)
  api.post([id, 'read'].uri_concat)
end