Class VariablesAPI

Variables API

Index

Constructors

Methods

deleteVariablesID deleteVariablesIDLabelsID getVariables getVariablesID getVariablesIDLabels patchVariablesID postVariables postVariablesIDLabels putVariablesID

Constructors

constructor

new VariablesAPI(influxDB: InfluxDB): VariablesAPI
Creates VariablesAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns VariablesAPI
- Defined in apis/src/generated/VariablesAPI.ts:68

Methods

deleteVariablesID

deleteVariablesID(
request: DeleteVariablesIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteVariablesID
Parameters
- request: DeleteVariablesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:226

deleteVariablesIDLabelsID

deleteVariablesIDLabelsID(
request: DeleteVariablesIDLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a label from a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteVariablesIDLabelsID
Parameters
- request: DeleteVariablesIDLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:115

getVariables

getVariables(
request?: GetVariablesRequest,
requestOptions?: RequestOptions,
): Promise<Variables>
List all variables. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetVariables
Parameters
- Optionalrequest: GetVariablesRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Variables>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:133

getVariablesID

getVariablesID(
request: GetVariablesIDRequest,
requestOptions?: RequestOptions,
): Promise<Variable>
Retrieve a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetVariablesID
Parameters
- request: GetVariablesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Variable>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:170

getVariablesIDLabels

getVariablesIDLabels(
request: GetVariablesIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelsResponse>
List all labels for a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetVariablesIDLabels
Parameters
- request: GetVariablesIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelsResponse>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:78

patchVariablesID

patchVariablesID(
request: PatchVariablesIDRequest,
requestOptions?: RequestOptions,
): Promise<Variable>
Update a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchVariablesID
Parameters
- request: PatchVariablesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Variable>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:207

postVariables

postVariables(
request: PostVariablesRequest,
requestOptions?: RequestOptions,
): Promise<Variable>
Create a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostVariables
Parameters
- request: PostVariablesRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Variable>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:151

postVariablesIDLabels

postVariablesIDLabels(
request: PostVariablesIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Add a label to a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostVariablesIDLabels
Parameters
- request: PostVariablesIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:96

putVariablesID

putVariablesID(
request: PutVariablesIDRequest,
requestOptions?: RequestOptions,
): Promise<Variable>
Replace a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PutVariablesID
Parameters
- request: PutVariablesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Variable>
promise of response
- Defined in apis/src/generated/VariablesAPI.ts:188

Class VariablesAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns VariablesAPI

Methods

deleteVariablesID

Parameters

Returns Promise<void>

deleteVariablesIDLabelsID

Parameters

Returns Promise<void>

getVariables

Parameters

Returns Promise<Variables>

getVariablesID

Parameters

Returns Promise<Variable>

getVariablesIDLabels

Parameters

Returns Promise<LabelsResponse>

patchVariablesID

Parameters

Returns Promise<Variable>

postVariables

Parameters

Returns Promise<Variable>

postVariablesIDLabels

Parameters

Returns Promise<LabelResponse>

putVariablesID

Parameters

Returns Promise<Variable>

Settings

On This Page