Class GrafanaHTTP

Implementation of the IOnmsHTTP interface for Grafana.

implements: IOnmsHTTP

Hierarchy

AbstractHTTP
- GrafanaHTTP

Implements

IOnmsHTTP

Index

Constructors

constructor

Properties

Accessors

server

Methods

Constructors

constructor

new GrafanaHTTP(backendSrv: any, server?: OnmsServer): GrafanaHTTP

Overrides AbstractHTTP.constructor
- Defined in rest/GrafanaHTTP.ts:25
Construct a new GrafanaHTTP implementation.

constructor

Parameters
- backendSrv: any
  
  The Grafana BackendSrv object to use for requests.
- Optional server: OnmsServer
  
  The OpenNMS server to make requests to.
Returns GrafanaHTTP

Properties

options

options: OnmsHTTPOptions

The default set of HTTP options associated with this ReST client.

timeout

timeout: number = 10000

The default amount of time to wait before giving up on a request.

Accessors

server

get server(): OnmsServer
set server(server: OnmsServer): void

Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:49
The server associated with this HTTP implementation.

Returns OnmsServer
Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:53
The server associated with this HTTP implementation.

Parameters
- server: OnmsServer
Returns void

Methods

get

get(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.get

Overrides AbstractHTTP.get
- Defined in rest/GrafanaHTTP.ts:39
Make an HTTP GET call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

Protected getOptions

getOptions(options?: OnmsHTTPOptions): OnmsHTTPOptions

Inherited from AbstractHTTP.getOptions
- Defined in rest/AbstractHTTP.ts:119
Get the union of OnmsHTTPOptions based on the passed options, defaults, and options in the OnmsServer associated with this request. Order of precedence is passed options -> server options -> default options.

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsHTTPOptions

Protected getServer

getServer(options?: OnmsHTTPOptions): OnmsServer

Inherited from AbstractHTTP.getServer
- Defined in rest/AbstractHTTP.ts:110
Get the OnmsServer object that should be used for making requests. Favors the one passed in the OnmsHTTPOptions, otherwise it falls back to the default server associated with the HTTP implementation.

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsServer

Protected onSetServer

onSetServer(): void

Inherited from AbstractHTTP.onSetServer
- Defined in rest/AbstractHTTP.ts:136
Implementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.

Returns void

put

put(url: string, options?: OnmsHTTPOptions): any

Implementation of IOnmsHTTP.put

Overrides AbstractHTTP.put
- Defined in rest/GrafanaHTTP.ts:58
Make an HTTP PUT call using the Grafana BackendSrv.

Parameters
- url: string
- Optional options: OnmsHTTPOptions
Returns any

Protected transformJSON

transformJSON(data: any): any

Inherited from AbstractHTTP.transformJSON
- Defined in rest/AbstractHTTP.ts:79
A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an OnmsResult object.

Parameters
- data: any
Returns any

Protected transformXML

transformXML(data: any): any

Inherited from AbstractHTTP.transformXML
- Defined in rest/AbstractHTTP.ts:96
A convenience method for implementers to use to turn XML into a javascript object. Use this to process an XML response before returning it in an OnmsResult object.

Parameters
- data: any
Returns any

Generated using TypeDoc