Class GrafanaHTTP

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:20
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

Private backendSrv

backendSrv: any

the Grafana backend object we'll use for making ReST calls

options

options: OnmsHTTPOptions

the authorization config associated with this ReST client

timeout

timeout: number = 10000

how long to wait before giving up on a given request

Accessors

server

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

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

Returns OnmsServer
Inherited from AbstractHTTP.server
- Defined in rest/AbstractHTTP.ts:38
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:35
make an HTTP GET call using the Grafana backendSrv

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

Private getConfig

getConfig(options?: OnmsHTTPOptions): any

- Defined in rest/GrafanaHTTP.ts:74
internal method to turn OnmsHTTPOptions into a Grafana BackendSrv request object.

Parameters
- Optional options: OnmsHTTPOptions
Returns any

Protected getOptions

getOptions(options?: OnmsHTTPOptions): any

Inherited from AbstractHTTP.getOptions
- Defined in rest/AbstractHTTP.ts:90
combine all options from the given options, the current server, and the default options

Parameters
- Optional options: OnmsHTTPOptions
Returns any

Protected getServer

getServer(options?: OnmsHTTPOptions): OnmsServer

Inherited from AbstractHTTP.getServer
- Defined in rest/AbstractHTTP.ts:85
get the server in the options object, or fall back to the one assigned to the HTTP impl

Parameters
- Optional options: OnmsHTTPOptions
Returns OnmsServer

Protected onSetServer

onSetServer(): void

Inherited from AbstractHTTP.onSetServer
- Defined in rest/AbstractHTTP.ts:104
useful for performing an action (like clearing caches) when the server is set

Returns void

put

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

Implementation of IOnmsHTTP.put

Overrides AbstractHTTP.put
- Defined in rest/GrafanaHTTP.ts:54
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:61
a convenience method for implementers to use to turn JSON into a javascript object

Parameters
- data: any
Returns any

Protected transformXML

transformXML(data: any): any

Inherited from AbstractHTTP.transformXML
- Defined in rest/AbstractHTTP.ts:75
a convenience method for implementers to use to turn XML into a javascript object

Parameters
- data: any
Returns any

Generated using TypeDoc