Class DbrpsAPI

Dbrps API

Index

Constructors

Methods

deleteDBRPID getDBRPs getDBRPsID patchDBRPID postDBRP

Constructors

constructor

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

Methods

deleteDBRPID

deleteDBRPID(
request: DeleteDBRPIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a database retention policy. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteDBRPID
Parameters
- request: DeleteDBRPIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/DbrpsAPI.ts:160

getDBRPs

getDBRPs(
request?: GetDBRPsRequest,
requestOptions?: RequestOptions,
): Promise<DBRPs>
List database retention policy mappings. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDBRPs
Parameters
- Optionalrequest: GetDBRPsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<DBRPs>
promise of response
- Defined in apis/src/generated/DbrpsAPI.ts:72

getDBRPsID

getDBRPsID(
request: GetDBRPsIDRequest,
requestOptions?: RequestOptions,
): Promise<DBRPGet>
Retrieve a database retention policy mapping. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetDBRPsID
Parameters
- request: GetDBRPsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<DBRPGet>
promise of response
- Defined in apis/src/generated/DbrpsAPI.ts:117

patchDBRPID

patchDBRPID(
request: PatchDBRPIDRequest,
requestOptions?: RequestOptions,
): Promise<DBRPGet>
Update a database retention policy mapping. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchDBRPID
Parameters
- request: PatchDBRPIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<DBRPGet>
promise of response
- Defined in apis/src/generated/DbrpsAPI.ts:138

postDBRP

postDBRP(
request: PostDBRPRequest,
requestOptions?: RequestOptions,
): Promise<DBRP>
Add a database retention policy mapping. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostDBRP
Parameters
- request: PostDBRPRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<DBRP>
promise of response
- Defined in apis/src/generated/DbrpsAPI.ts:98