Class LabelsAPI

Labels API

Index

Constructors

Methods

deleteLabelsID getLabels getLabelsID patchLabelsID postLabels

Constructors

constructor

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

Methods

deleteLabelsID

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

getLabels

getLabels(
request?: GetLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelsResponse>
List all labels. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetLabels
Parameters
- Optionalrequest: GetLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelsResponse>
promise of response
- Defined in apis/src/generated/LabelsAPI.ts:53

getLabelsID

getLabelsID(
request: GetLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Retrieve a label. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetLabelsID
Parameters
- request: GetLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/LabelsAPI.ts:90

patchLabelsID

patchLabelsID(
request: PatchLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Update a label. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchLabelsID
Parameters
- request: PatchLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/LabelsAPI.ts:108

postLabels

postLabels(
request: PostLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Create a label. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostLabels
Parameters
- request: PostLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/LabelsAPI.ts:71