InvokableScriptsService class
Use API invokable scripts to create custom InfluxDB API endpoints that query, process, and shape data.
API invokable scripts let you assign scripts to API endpoints and then execute them as standard REST operations in InfluxDB Cloud.
- Inheritance
-
- Object
- DefaultService
- InvokableScriptsService
Constructors
- InvokableScriptsService(InfluxDBClient client)
-
Creates InvokableScriptsService with optional custom
writeOptions
Properties
- apiClient ↔ ApiClient
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- influxDB → InfluxDBClient
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- service ↔ InvokableScriptsApi
-
getter/setter pair
Methods
-
createScript(
ScriptCreateRequest createRequest) → Future< Script> - Create a script.
-
deleteScript(
String scriptId) → Future< void> - Delete a script.
-
findScripts(
{int? limit, int? offset}) → Future< List< Script> > - List scripts
-
getApiClient(
String basePath) → ApiClient? -
inherited
-
getClient(
) → Client? -
inherited
-
invokeScript(
String scriptId, {Map< String, Object> ? params}) → Future<Stream< FluxRecord> > - Invoke a script and return result as a stream of FluxRecord.
-
invokeScriptLines(
String scriptId, {Map< String, Object> ? params}) → Future<Stream< List> > - Invoke a script and return result as a row of CSV response.
-
invokeScriptRaw(
String scriptId, {Map< String, Object> ? params}) → Future<String> - Invoke a script and return result as a raw string.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateScript(
String scriptId, ScriptUpdateRequest updateRequest) → Future< Script> - Update a script.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited