class OpsgenieSdk::HeartbeatApi
Attributes
Public Class Methods
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create Heartbeat
Create a new heartbeat @param body Request payload of created heartbeat @param [Hash] opts the optional parameters @return [CreateHeartbeatResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 27 def create_heartbeat(body, opts = {}) data, _status_code, _headers = create_heartbeat_with_http_info(body, opts) data end
Create Heartbeat
Create a new heartbeat @param body Request payload of created heartbeat @param [Hash] opts the optional parameters @return [Array<(CreateHeartbeatResponse
, Fixnum, Hash)>] CreateHeartbeatResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 37 def create_heartbeat_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.create_heartbeat ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling HeartbeatApi.create_heartbeat" end # resource path local_var_path = '/v2/heartbeats' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateHeartbeatResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#create_heartbeat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Heartbeat
Delete heartbeat with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [SuccessResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 79 def delete_heartbeat(name, opts = {}) data, _status_code, _headers = delete_heartbeat_with_http_info(name, opts) data end
Delete Heartbeat
Delete heartbeat with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [Array<(SuccessResponse
, Fixnum, Hash)>] SuccessResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 89 def delete_heartbeat_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.delete_heartbeat ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling HeartbeatApi.delete_heartbeat" end # resource path local_var_path = '/v2/heartbeats/{name}'.sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#delete_heartbeat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Disable Heartbeat
Disable heartbeat request with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [DisableHeartbeatResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 131 def disable_heartbeat(name, opts = {}) data, _status_code, _headers = disable_heartbeat_with_http_info(name, opts) data end
Disable Heartbeat
Disable heartbeat request with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [Array<(DisableHeartbeatResponse
, Fixnum, Hash)>] DisableHeartbeatResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 141 def disable_heartbeat_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.disable_heartbeat ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling HeartbeatApi.disable_heartbeat" end # resource path local_var_path = '/v2/heartbeats/{name}/disable'.sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DisableHeartbeatResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#disable_heartbeat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Enable Heartbeat
Enable heartbeat request with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [EnableHeartbeatResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 183 def enable_heartbeat(name, opts = {}) data, _status_code, _headers = enable_heartbeat_with_http_info(name, opts) data end
Enable Heartbeat
Enable heartbeat request with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [Array<(EnableHeartbeatResponse
, Fixnum, Hash)>] EnableHeartbeatResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 193 def enable_heartbeat_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.enable_heartbeat ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling HeartbeatApi.enable_heartbeat" end # resource path local_var_path = '/v2/heartbeats/{name}/enable'.sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'EnableHeartbeatResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#enable_heartbeat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Heartbeat
Returns heartbeat with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [GetHeartbeatResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 235 def get_heartbeat(name, opts = {}) data, _status_code, _headers = get_heartbeat_with_http_info(name, opts) data end
Get Heartbeat
Returns heartbeat with given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [Array<(GetHeartbeatResponse
, Fixnum, Hash)>] GetHeartbeatResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 245 def get_heartbeat_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.get_heartbeat ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling HeartbeatApi.get_heartbeat" end # resource path local_var_path = '/v2/heartbeats/{name}'.sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetHeartbeatResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#get_heartbeat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Heartbeats Returns list of Heartbeats @param [Hash] opts the optional parameters @return [ListHeartbeatResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 286 def list_heart_beats(opts = {}) data, _status_code, _headers = list_heart_beats_with_http_info(opts) data end
List Heartbeats Returns list of Heartbeats @param [Hash] opts the optional parameters @return [Array<(ListHeartbeatResponse
, Fixnum, Hash)>] ListHeartbeatResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 295 def list_heart_beats_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.list_heart_beats ...' end # resource path local_var_path = '/v2/heartbeats' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ListHeartbeatResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#list_heart_beats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Ping Heartbeat
Ping Heartbeat
for given heartbeat name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [SuccessResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 333 def ping(name, opts = {}) data, _status_code, _headers = ping_with_http_info(name, opts) data end
Ping Heartbeat
Ping Heartbeat
for given heartbeat name @param name Name of the heartbeat @param [Hash] opts the optional parameters @return [Array<(SuccessResponse
, Fixnum, Hash)>] SuccessResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 343 def ping_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.ping ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling HeartbeatApi.ping" end # resource path local_var_path = '/v2/heartbeats/{name}/ping'.sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update Heartbeat
(Partial) Update Heartbeatwith given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @option opts [UpdateHeartbeatPayload] :body Request payload of update heartbeat action @return [UpdateHeartbeatResponse]
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 386 def update_heartbeat(name, opts = {}) data, _status_code, _headers = update_heartbeat_with_http_info(name, opts) data end
Update Heartbeat
(Partial) Update Heartbeatwith given name @param name Name of the heartbeat @param [Hash] opts the optional parameters @option opts [UpdateHeartbeatPayload] :body Request payload of update heartbeat action @return [Array<(UpdateHeartbeatResponse
, Fixnum, Hash)>] UpdateHeartbeatResponse
data, response status code and response headers
# File lib/opsgenie_sdk/api/heartbeat_api.rb, line 397 def update_heartbeat_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: HeartbeatApi.update_heartbeat ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling HeartbeatApi.update_heartbeat" end # resource path local_var_path = '/v2/heartbeats/{name}'.sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['GenieKey'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UpdateHeartbeatResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: HeartbeatApi#update_heartbeat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end