Class: Wavefront::CloudIntegration

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

Overview

View and manage Cloud Integrations. These are identified by a UUID.

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

#confirm_aws_external_id(external_id) ⇒ Wavefront::Response

GET /api/v2/cloudintegration/awsExternalId/idGETs (confirms) a valid external id that was created by Wavefront

Parameters:

  • id (String) —

    AWS external ID

Returns:



127
128
129
130
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 127

def confirm_aws_external_id(external_id)
  wf_aws_external_id?(external_id)
  api.get(['awsExternalId', external_id].uri_concat)
end

#create(body) ⇒ Wavefront::Response

POST /api/v2/cloudintegration Create a cloud integration. Refer to the Swagger API docs for valid keys.

Parameters:

  • body (Hash) —

    description of integration

Returns:

Raises:

  • (ArgumentError) 


29
30
31
32
33
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 29

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

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

#create_aws_external_id ⇒ Wavefront::Response

POST /api/v2/cloudintegration/awsExternalIdCreate an external id

Returns:



108
109
110
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 108

def create_aws_external_id
  api.post('awsExternalId', nil, 'application/json')
end

#delete(id) ⇒ Wavefront::Response

DELETE /api/v2/cloudintegration/id Delete a specific cloud integration

Deleting an active integration moves it to ‘trash’, from where it can be restored with an #undelete operation. Deleting an integration in ‘trash’ removes it for ever.

Parameters:

  • id (String) —

    ID of the integration

Returns:



45
46
47
48
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 45

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

#delete_aws_external_id(external_id) ⇒ Wavefront::Response

DELETE /api/v2/cloudintegration/awsExternalId/idDELETEs an external id that was created by Wavefront

Parameters:

  • id (String) —

    AWS external ID

Returns:



117
118
119
120
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 117

def delete_aws_external_id(external_id)
  wf_aws_external_id?(external_id)
  api.delete(['awsExternalId', external_id].uri_concat)
end

#describe(id) ⇒ Wavefront::Response

GET /api/v2/cloudintegration/id Get a specific cloud integration

Parameters:

  • id (String) —

    ID of the integration

Returns:



56
57
58
59
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 56

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

#disable(id) ⇒ Wavefront::Response

POST /api/v2/cloudintegration/id/disable Disable a specific cloud integration

Parameters:

  • id (String) —

    ID of the integration

Returns:



79
80
81
82
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 79

def disable(id)
  wf_cloudintegration_id?(id)
  api.post([id, 'disable'].uri_concat)
end

#enable(id) ⇒ Wavefront::Response

POST /api/v2/cloudintegration/id/enable Enable a specific cloud integration

Parameters:

  • id (String) —

    ID of the integration

Returns:



89
90
91
92
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 89

def enable(id)
  wf_cloudintegration_id?(id)
  api.post([id, 'enable'].uri_concat)
end

#list(offset = 0, limit = 100) ⇒ Wavefront::Response

GET /api/v2/cloudintegration Get all cloud integrations for a customer

Parameters:

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

    integration at which the list begins

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

    the number of integration to return

Returns:



18
19
20
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 18

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

#undelete(id) ⇒ Wavefront::Response

POST /api/v2/cloudintegration/id/undelete Undelete a specific cloud integration

Parameters:

  • id (String) —

    ID of the integration

Returns:



100
101
102
103
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 100

def undelete(id)
  wf_cloudintegration_id?(id)
  api.post([id, 'undelete'].uri_concat)
end

#update(id, body) ⇒ Object

PUT /api/v2/cloudintegration/id Update a specific cloud integration

Parameters:

Raises:

  • (ArgumentError) 


67
68
69
70
71
72
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 67

def update(id, body)
  wf_cloudintegration_id?(id)
  raise ArgumentError unless body.is_a?(Hash)

  api.put(id, body)
end

#update_keys ⇒ Object 



132
133
134
 
# File 'lib/wavefront-sdk/cloudintegration.rb', line 132

def update_keys
  %i[name]
end