client

package
v0.0.0-...-40af6fe Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 4, 2016 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Overview

Package client provides clients for using the OpsGenie Web API. Also prepares and sends requests. API user first creates a OpsGenieClient instance.

cli := new(ogcli.OpsGenieClient)

Following that he/she can set APIKey and some configurations for HTTP communication layer by setting a proxy definition and/or transport layer options.

cli.SetAPIKey(constants.APIKey)

Then create the client of the API type that he/she wants to use.

alertCli, cliErr := cli.Alert()

if cliErr != nil { panic(cliErr) }

The most fundamental and general use case is being able to access the OpsGenie Web API by coding a Go program. The program -by mean of a client application- can send OpsGenie Web API the requests using the 'client' package in a higher level. For the programmer of the client application, that reduces the number of LoCs. Besides it will result a less error-prone application and reduce the complexity by hiding the low-level networking, error-handling and byte-processing calls.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HTTPTransportSettings 

type HTTPTransportSettings struct {
	ConnectionTimeout time.Duration
	RequestTimeout    time.Duration
	MaxRetryAttempts  int
}

HTTPTransportSettings is the type that contains the HTTP transport layer configurations of the OpsGenieClient.

type OpsGenieAlertClient 

type OpsGenieAlertClient struct {
	OpsGenieClient
}

OpsGenieAlertClient is the data type to make Alert API requests.

func (*OpsGenieAlertClient) Acknowledge 

func (cli *OpsGenieAlertClient) Acknowledge(req alerts.AcknowledgeAlertRequest) (*alerts.AcknowledgeAlertResponse, error)

Acknowledge method acknowledges an alert at OpsGenie.

func (*OpsGenieAlertClient) AddNote 

func (cli *OpsGenieAlertClient) AddNote(req alerts.AddNoteAlertRequest) (*alerts.AddNoteAlertResponse, error)

AddNote method adds a note to an alert at OpsGenie.

func (*OpsGenieAlertClient) AddRecipient 

func (cli *OpsGenieAlertClient) AddRecipient(req alerts.AddRecipientAlertRequest) (*alerts.AddRecipientAlertResponse, error)

AddRecipient method adds recipient to an alert at OpsGenie.

func (*OpsGenieAlertClient) AddTags 

func (cli *OpsGenieAlertClient) AddTags(req alerts.AddTagsAlertRequest) (*alerts.AddTagsAlertResponse, error)

AddTags method adds tags to an alert at OpsGenie.

func (*OpsGenieAlertClient) AddTeam 

func (cli *OpsGenieAlertClient) AddTeam(req alerts.AddTeamAlertRequest) (*alerts.AddTeamAlertResponse, error)

AddTeam method adds a team to an alert at OpsGenie.

func (*OpsGenieAlertClient) AssignOwner 

func (cli *OpsGenieAlertClient) AssignOwner(req alerts.AssignOwnerAlertRequest) (*alerts.AssignOwnerAlertResponse, error)

AssignOwner method assigns the specified user as the owner of the alert at OpsGenie.

func (*OpsGenieAlertClient) AttachFile 

func (cli *OpsGenieAlertClient) AttachFile(req alerts.AttachFileAlertRequest) (*alerts.AttachFileAlertResponse, error)

AttachFile method attaches a file to an alert at OpsGenie.

func (*OpsGenieAlertClient) Close 

func (cli *OpsGenieAlertClient) Close(req alerts.CloseAlertRequest) (*alerts.CloseAlertResponse, error)

Close method closes an alert at OpsGenie.

func (*OpsGenieAlertClient) Create 

func (cli *OpsGenieAlertClient) Create(req alerts.CreateAlertRequest) (*alerts.CreateAlertResponse, error)

Create method creates an alert at OpsGenie.

func (*OpsGenieAlertClient) Delete 

func (cli *OpsGenieAlertClient) Delete(req alerts.DeleteAlertRequest) (*alerts.DeleteAlertResponse, error)

Delete method deletes an alert at OpsGenie.

func (*OpsGenieAlertClient) ExecuteAction 

func (cli *OpsGenieAlertClient) ExecuteAction(req alerts.ExecuteActionAlertRequest) (*alerts.ExecuteActionAlertResponse, error)

ExecuteAction method executes a custom action on an alert at OpsGenie.

func (*OpsGenieAlertClient) Get 

func (cli *OpsGenieAlertClient) Get(req alerts.GetAlertRequest) (*alerts.GetAlertResponse, error)

Get method retrieves specified alert details from OpsGenie.

func (*OpsGenieAlertClient) List 

func (cli *OpsGenieAlertClient) List(req alerts.ListAlertsRequest) (*alerts.ListAlertsResponse, error)

List method retrieves alerts from OpsGenie.

func (*OpsGenieAlertClient) ListLogs 

func (cli *OpsGenieAlertClient) ListLogs(req alerts.ListAlertLogsRequest) (*alerts.ListAlertLogsResponse, error)

ListLogs method retrieves activity logs of an alert from OpsGenie.

func (*OpsGenieAlertClient) ListNotes 

func (cli *OpsGenieAlertClient) ListNotes(req alerts.ListAlertNotesRequest) (*alerts.ListAlertNotesResponse, error)

ListNotes method retrieves notes of an alert from OpsGenie.

func (*OpsGenieAlertClient) ListRecipients 

func (cli *OpsGenieAlertClient) ListRecipients(req alerts.ListAlertRecipientsRequest) (*alerts.ListAlertRecipientsResponse, error)

ListRecipients method retrieves recipients of an alert from OpsGenie.

func (*OpsGenieAlertClient) Renotify 

func (cli *OpsGenieAlertClient) Renotify(req alerts.RenotifyAlertRequest) (*alerts.RenotifyAlertResponse, error)

Renotify re-notifies recipients at OpsGenie.

func (*OpsGenieAlertClient) SetOpsGenieClient 

func (cli *OpsGenieAlertClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieAlertClient.

func (*OpsGenieAlertClient) TakeOwnership 

func (cli *OpsGenieAlertClient) TakeOwnership(req alerts.TakeOwnershipAlertRequest) (*alerts.TakeOwnershipAlertResponse, error)

TakeOwnership method takes the ownership of an alert at OpsGenie.

type OpsGenieClient 

type OpsGenieClient struct {
	// contains filtered or unexported fields
}

OpsGenieClient is a general data type used for: - authenticating callers through their API keys and - instantiating "alert", "heartbeat", "integration" and "policy" clients - setting HTTP transport layer configurations - setting Proxy configurations

func (*OpsGenieClient) APIKey 

func (cli *OpsGenieClient) APIKey() string

APIKey returns the API Key value that OpsGenieClient uses to authenticate at OpsGenie.

func (*OpsGenieClient) Alert 

func (cli *OpsGenieClient) Alert() (*OpsGenieAlertClient, error)

Alert instantiates a new OpsGenieAlertClient.

func (*OpsGenieClient) Escalation 

func (cli *OpsGenieClient) Escalation() (*OpsGenieEscalationClient, error)

Escalation instantiates a new OpsGenieEscalationClient.

func (*OpsGenieClient) Heartbeat 

func (cli *OpsGenieClient) Heartbeat() (*OpsGenieHeartbeatClient, error)

Heartbeat instantiates a new OpsGenieHeartbeatClient.

func (*OpsGenieClient) Integration 

func (cli *OpsGenieClient) Integration() (*OpsGenieIntegrationClient, error)

Integration instantiates a new OpsGenieIntegrationClient.

func (*OpsGenieClient) OpsGenieAPIUrl 

func (cli *OpsGenieClient) OpsGenieAPIUrl() string

OpsGenieAPIUrl returns the current endpoint(base URL) that requests will send.

func (*OpsGenieClient) Policy 

func (cli *OpsGenieClient) Policy() (*OpsGeniePolicyClient, error)

Policy instantiates a new OpsGeniePolicyClient.

func (*OpsGenieClient) Schedule 

func (cli *OpsGenieClient) Schedule() (*OpsGenieScheduleClient, error)

Schedule instantiates a new OpsGenieScheduleClient.

func (*OpsGenieClient) SetAPIKey 

func (cli *OpsGenieClient) SetAPIKey(key string)

SetAPIKey sets API Key of the OpsGenieClient and authenticates callers through the API Key at OpsGenie.

func (*OpsGenieClient) SetHTTPTransportSettings 

func (cli *OpsGenieClient) SetHTTPTransportSettings(settings *HTTPTransportSettings)

SetHTTPTransportSettings sets HTTP transport layer configurations of the OpsGenieClient.

func (*OpsGenieClient) SetOpsGenieAPIUrl 

func (cli *OpsGenieClient) SetOpsGenieAPIUrl(url string)

SetOpsGenieAPIUrl sets the endpoint(base URL) that requests will send. It can be used for testing purpose.

func (*OpsGenieClient) SetProxyConfiguration 

func (cli *OpsGenieClient) SetProxyConfiguration(conf *ProxyConfiguration)

SetProxyConfiguration sets proxy configurations of the OpsGenieClient.

func (*OpsGenieClient) Team 

func (cli *OpsGenieClient) Team() (*OpsGenieTeamClient, error)

Team instantiates a new OpsGenieTeamClient.

func (*OpsGenieClient) User 

func (cli *OpsGenieClient) User() (*OpsGenieUserClient, error)

User instantiates a new OpsGenieUserClient.

type OpsGenieEscalationClient 

type OpsGenieEscalationClient struct {
	OpsGenieClient
}

OpsGenieEscalationClient is the data type to make Escalation API requests.

func (*OpsGenieEscalationClient) Create 

func (cli *OpsGenieEscalationClient) Create(req escalation.CreateEscalationRequest) (*escalation.CreateEscalationResponse, error)

Create method creates a escalation at OpsGenie.

func (*OpsGenieEscalationClient) Delete 

func (cli *OpsGenieEscalationClient) Delete(req escalation.DeleteEscalationRequest) (*escalation.DeleteEscalationResponse, error)

Delete method deletes a escalation at OpsGenie.

func (*OpsGenieEscalationClient) Get 

func (cli *OpsGenieEscalationClient) Get(req escalation.GetEscalationRequest) (*escalation.GetEscalationResponse, error)

Get method retrieves specified escalation details from OpsGenie.

func (*OpsGenieEscalationClient) List 

func (cli *OpsGenieEscalationClient) List(req escalation.ListEscalationsRequest) (*escalation.ListEscalationsResponse, error)

List method retrieves escalations from OpsGenie.

func (*OpsGenieEscalationClient) SetOpsGenieClient 

func (cli *OpsGenieEscalationClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieEscalationClient.

func (*OpsGenieEscalationClient) Update 

func (cli *OpsGenieEscalationClient) Update(req escalation.UpdateEscalationRequest) (*escalation.UpdateEscalationResponse, error)

Update method updates a escalation at OpsGenie.

type OpsGenieHeartbeatClient 

type OpsGenieHeartbeatClient struct {
	OpsGenieClient
}

OpsGenieHeartbeatClient is the data type to make Heartbeat API requests.

func (*OpsGenieHeartbeatClient) Add 

func (cli *OpsGenieHeartbeatClient) Add(req heartbeat.AddHeartbeatRequest) (*heartbeat.AddHeartbeatResponse, error)

Add method creates a heartbeat at OpsGenie.

func (*OpsGenieHeartbeatClient) Delete 

func (cli *OpsGenieHeartbeatClient) Delete(req heartbeat.DeleteHeartbeatRequest) (*heartbeat.DeleteHeartbeatResponse, error)

Delete method deletes an heartbeat from OpsGenie.

func (*OpsGenieHeartbeatClient) Disable 

func (cli *OpsGenieHeartbeatClient) Disable(req heartbeat.DisableHeartbeatRequest) (*heartbeat.DisableHeartbeatResponse, error)

Disable method disables an heartbeat at OpsGenie.

func (*OpsGenieHeartbeatClient) Enable 

func (cli *OpsGenieHeartbeatClient) Enable(req heartbeat.EnableHeartbeatRequest) (*heartbeat.EnableHeartbeatResponse, error)

Enable method enables an heartbeat at OpsGenie.

func (*OpsGenieHeartbeatClient) Get 

func (cli *OpsGenieHeartbeatClient) Get(req heartbeat.GetHeartbeatRequest) (*heartbeat.GetHeartbeatResponse, error)

Get method retrieves an heartbeat with details from OpsGenie.

func (*OpsGenieHeartbeatClient) List 

func (cli *OpsGenieHeartbeatClient) List(req heartbeat.ListHeartbeatsRequest) (*heartbeat.ListHeartbeatsResponse, error)

List method retrieves heartbeats from OpsGenie.

func (*OpsGenieHeartbeatClient) Send 

func (cli *OpsGenieHeartbeatClient) Send(req heartbeat.SendHeartbeatRequest) (*heartbeat.SendHeartbeatResponse, error)

Send method sends an Heartbeat Signal to OpsGenie.

func (*OpsGenieHeartbeatClient) SetOpsGenieClient 

func (cli *OpsGenieHeartbeatClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieHeartbeatClient.

func (*OpsGenieHeartbeatClient) Update 

func (cli *OpsGenieHeartbeatClient) Update(req heartbeat.UpdateHeartbeatRequest) (*heartbeat.UpdateHeartbeatResponse, error)

Update method changes configuration of an existing heartbeat at OpsGenie.

type OpsGenieIntegrationClient 

type OpsGenieIntegrationClient struct {
	OpsGenieClient
}

OpsGenieIntegrationClient is the data type to make Integration API requests.

func (*OpsGenieIntegrationClient) Disable 

func (cli *OpsGenieIntegrationClient) Disable(req integration.DisableIntegrationRequest) (*integration.DisableIntegrationResponse, error)

Disable method disables an Integration at OpsGenie.

func (*OpsGenieIntegrationClient) Enable 

func (cli *OpsGenieIntegrationClient) Enable(req integration.EnableIntegrationRequest) (*integration.EnableIntegrationResponse, error)

Enable method enables an Integration at OpsGenie.

func (*OpsGenieIntegrationClient) SetOpsGenieClient 

func (cli *OpsGenieIntegrationClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieIntegrationClient.

type OpsGeniePolicyClient 

type OpsGeniePolicyClient struct {
	OpsGenieClient
}

OpsGeniePolicyClient is the data type to make Policy API requests.

func (*OpsGeniePolicyClient) Disable 

func (cli *OpsGeniePolicyClient) Disable(req policy.DisablePolicyRequest) (*policy.DisablePolicyResponse, error)

Disable method disables an Policy at OpsGenie.

func (*OpsGeniePolicyClient) Enable 

func (cli *OpsGeniePolicyClient) Enable(req policy.EnablePolicyRequest) (*policy.EnablePolicyResponse, error)

Enable method enables an Policy at OpsGenie.

func (*OpsGeniePolicyClient) SetOpsGenieClient 

func (cli *OpsGeniePolicyClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGeniePolicyClient.

type OpsGenieScheduleClient 

type OpsGenieScheduleClient struct {
	OpsGenieClient
}

OpsGenieScheduleClient is the data type to make Schedule API requests.

func (*OpsGenieScheduleClient) Create 

func (cli *OpsGenieScheduleClient) Create(req schedule.CreateScheduleRequest) (*schedule.CreateScheduleResponse, error)

Create method creates a schedule at OpsGenie.

func (*OpsGenieScheduleClient) Delete 

func (cli *OpsGenieScheduleClient) Delete(req schedule.DeleteScheduleRequest) (*schedule.DeleteScheduleResponse, error)

Delete method deletes a schedule at OpsGenie.

func (*OpsGenieScheduleClient) Get 

func (cli *OpsGenieScheduleClient) Get(req schedule.GetScheduleRequest) (*schedule.GetScheduleResponse, error)

Get method retrieves specified schedule details from OpsGenie.

func (*OpsGenieScheduleClient) List 

func (cli *OpsGenieScheduleClient) List(req schedule.ListSchedulesRequest) (*schedule.ListSchedulesResponse, error)

List method retrieves schedules from OpsGenie.

func (*OpsGenieScheduleClient) SetOpsGenieClient 

func (cli *OpsGenieScheduleClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieScheduleClient.

func (*OpsGenieScheduleClient) Update 

func (cli *OpsGenieScheduleClient) Update(req schedule.UpdateScheduleRequest) (*schedule.UpdateScheduleResponse, error)

Update method updates a schedule at OpsGenie.

type OpsGenieTeamClient 

type OpsGenieTeamClient struct {
	OpsGenieClient
}

OpsGenieTeamClient is the data type to make Team API requests.

func (*OpsGenieTeamClient) Create 

func (cli *OpsGenieTeamClient) Create(req team.CreateTeamRequest) (*team.CreateTeamResponse, error)

Create method creates a team at OpsGenie.

func (*OpsGenieTeamClient) Delete 

func (cli *OpsGenieTeamClient) Delete(req team.DeleteTeamRequest) (*team.DeleteTeamResponse, error)

Delete method deletes a team at OpsGenie.

func (*OpsGenieTeamClient) Get 

func (cli *OpsGenieTeamClient) Get(req team.GetTeamRequest) (*team.GetTeamResponse, error)

Get method retrieves specified team details from OpsGenie.

func (*OpsGenieTeamClient) List 

func (cli *OpsGenieTeamClient) List(req team.ListTeamsRequest) (*team.ListTeamsResponse, error)

List method retrieves teams from OpsGenie.

func (*OpsGenieTeamClient) ListLogs 

func (cli *OpsGenieTeamClient) ListLogs(req team.ListTeamLogsRequest) (*team.ListTeamLogsResponse, error)

ListLogs method retrieves team logs from OpsGenie.

func (*OpsGenieTeamClient) SetOpsGenieClient 

func (cli *OpsGenieTeamClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieTeamClient.

func (*OpsGenieTeamClient) Update 

func (cli *OpsGenieTeamClient) Update(req team.UpdateTeamRequest) (*team.UpdateTeamResponse, error)

Update method updates a team at OpsGenie.

type OpsGenieUserClient 

type OpsGenieUserClient struct {
	OpsGenieClient
}

OpsGenieUserClient is the data type to make User API requests.

func (*OpsGenieUserClient) Create 

func (cli *OpsGenieUserClient) Create(req user.CreateUserRequest) (*user.CreateUserResponse, error)

Create method creates a user at OpsGenie.

func (*OpsGenieUserClient) Delete 

func (cli *OpsGenieUserClient) Delete(req user.DeleteUserRequest) (*user.DeleteUserResponse, error)

Delete method deletes a user at OpsGenie.

func (*OpsGenieUserClient) Get 

func (cli *OpsGenieUserClient) Get(req user.GetUserRequest) (*user.GetUserResponse, error)

Get method retrieves specified user details from OpsGenie.

func (*OpsGenieUserClient) List 

func (cli *OpsGenieUserClient) List(req user.ListUsersRequest) (*user.ListUsersResponse, error)

List method retrieves users from OpsGenie.

func (*OpsGenieUserClient) SetOpsGenieClient 

func (cli *OpsGenieUserClient) SetOpsGenieClient(ogCli OpsGenieClient)

SetOpsGenieClient sets the embedded OpsGenieClient type of the OpsGenieUserClient.

func (*OpsGenieUserClient) Update 

func (cli *OpsGenieUserClient) Update(req user.UpdateUserRequest) (*user.UpdateUserResponse, error)

Update method updates a user at OpsGenie.

type ProxyConfiguration 

type ProxyConfiguration struct {
	Host     string
	Port     int
	Username string
	Password string
	ProxyURI string
	Protocol string
}

ProxyConfiguration is the type that contains the proxy configurations of the OpsGenieClient.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.