OpsGenie REST API v0.1.0 OpsGenieRESTAPI.Api.Heartbeat
API calls for all endpoints tagged Heartbeat
.
Link to this section Summary
Functions
Create Heartbeat Create a new heartbeat
Delete Heartbeat Delete heartbeat with given name
Disable Heartbeat Disable heartbeat request with given name
Enable Heartbeat Enable heartbeat request with given name
Get Heartbeat Returns heartbeat with given name
Ping Heartbeat Ping Heartbeat for given heartbeat name
Update Heartbeat (Partial) Update Heartbeatwith given name
Link to this section Functions
create_heartbeat( Tesla.Env.client(), OpsGenieRESTAPI.Model.CreateHeartbeatPayload.t(), keyword() ) :: {:ok, OpsGenieRESTAPI.Model.CreateHeartbeatResponse.t()} | {:error, Tesla.Env.t()}
Create Heartbeat Create a new heartbeat
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- body (CreateHeartbeatPayload): Request payload of created heartbeat
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.CreateHeartbeatResponse{}} on success {:error, info} on failure
delete_heartbeat(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Delete Heartbeat Delete heartbeat with given name
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- name (String.t): Name of the heartbeat
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure
disable_heartbeat(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.DisableHeartbeatResponse.t()} | {:error, Tesla.Env.t()}
Disable Heartbeat Disable heartbeat request with given name
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- name (String.t): Name of the heartbeat
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.DisableHeartbeatResponse{}} on success {:error, info} on failure
enable_heartbeat(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.EnableHeartbeatResponse.t()} | {:error, Tesla.Env.t()}
Enable Heartbeat Enable heartbeat request with given name
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- name (String.t): Name of the heartbeat
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.EnableHeartbeatResponse{}} on success {:error, info} on failure
get_heartbeat(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.GetHeartbeatResponse.t()} | {:error, Tesla.Env.t()}
Get Heartbeat Returns heartbeat with given name
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- name (String.t): Name of the heartbeat
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.GetHeartbeatResponse{}} on success {:error, info} on failure
ping(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.SuccessResponse.t()} | {:error, Tesla.Env.t()}
Ping Heartbeat Ping Heartbeat for given heartbeat name
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- name (String.t): Name of the heartbeat
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %OpsGenieRESTAPI.Model.SuccessResponse{}} on success {:error, info} on failure
update_heartbeat(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpsGenieRESTAPI.Model.UpdateHeartbeatResponse.t()} | {:error, Tesla.Env.t()}
Update Heartbeat (Partial) Update Heartbeatwith given name
Parameters
- connection (OpsGenieRESTAPI.Connection): Connection to server
- name (String.t): Name of the heartbeat
opts (KeywordList): [optional] Optional parameters
- :body (UpdateHeartbeatPayload): Request payload of update heartbeat action
Returns
{:ok, %OpsGenieRESTAPI.Model.UpdateHeartbeatResponse{}} on success {:error, info} on failure