InvokableScriptsService (The Java InfluxDB 2.x Client 6.12.0 API)

public interface InvokableScriptsService

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`retrofit2.Call<Void>`	`deleteScriptsID(String scriptID)` Delete a script Deletes a script and all associated records.
`retrofit2.Call<Scripts>`	`getScripts(Integer limit, Integer offset)` List scripts
`retrofit2.Call<Script>`	`getScriptsID(String scriptID)` Retrieve a script Uses script ID to retrieve details of an invokable script.
`retrofit2.Call<Script>`	`patchScriptsID(String scriptID, ScriptUpdateRequest scriptUpdateRequest)` Update a script Updates properties (`name`, `description`, and `script`) of an invokable script.
`retrofit2.Call<Script>`	`postScripts(ScriptCreateRequest scriptCreateRequest)` Create a script
`retrofit2.Call<String>`	`postScriptsIDInvoke(String scriptID, ScriptInvocationParams scriptInvocationParams)` Invoke a script Invokes a script and substitutes `params` keys referenced in the script with `params` key-values sent in the request body.
`retrofit2.Call<okhttp3.ResponseBody>`	`postScriptsIDInvokeResponseBody(String scriptID, ScriptInvocationParams scriptInvocationParams)` Invoke a script Invokes a script and substitutes `params` keys referenced in the script with `params` key-values sent in the request body.

Method Detail

deleteScriptsID

@DELETE(value="api/v2/scripts/{scriptID}")
retrofit2.Call<Void> deleteScriptsID(@Path(value="scriptID")
                                                                                String scriptID)

Delete a script Deletes a script and all associated records.

Parameters:: scriptID - The ID of the script to delete. (required)
Returns:: Call<Void>

getScripts

@GET(value="api/v2/scripts")
retrofit2.Call<Scripts> getScripts(@Query(value="limit")
                                                                Integer limit,
                                                                @Query(value="offset")
                                                                Integer offset)

List scripts

Parameters:: limit - The number of scripts to return. (optional); offset - The offset for pagination. (optional)
Returns:: Call<Scripts>

getScriptsID

@GET(value="api/v2/scripts/{scriptID}")
retrofit2.Call<Script> getScriptsID(@Path(value="scriptID")
                                                                            String scriptID)

Retrieve a script Uses script ID to retrieve details of an invokable script.

Parameters:: scriptID - The script ID. (required)
Returns:: Call<Script>

patchScriptsID

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/v2/scripts/{scriptID}")
retrofit2.Call<Script> patchScriptsID(@Path(value="scriptID")
                                                                                                                                 String scriptID,
                                                                                                                                 @Body
                                                                                                                                 ScriptUpdateRequest scriptUpdateRequest)

Update a script Updates properties (`name`, `description`, and `script`) of an invokable script.

Parameters:: scriptID - The script ID. (required); scriptUpdateRequest - Script update to apply (required)
Returns:: Call<Script>

postScripts

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/scripts")
retrofit2.Call<Script> postScripts(@Body
                                                                                                                  ScriptCreateRequest scriptCreateRequest)

Create a script

Parameters:: scriptCreateRequest - The script to create. (required)
Returns:: Call<Script>

postScriptsIDInvoke

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/scripts/{scriptID}/invoke")
retrofit2.Call<String> postScriptsIDInvoke(@Path(value="scriptID")
                                                                                                                                            String scriptID,
                                                                                                                                            @Body
                                                                                                                                            ScriptInvocationParams scriptInvocationParams)

Invoke a script Invokes a script and substitutes `params` keys referenced in the script with `params` key-values sent in the request body.

Parameters:: scriptID - (required); scriptInvocationParams - (optional)
Returns:: Call<String>

postScriptsIDInvokeResponseBody

@POST(value="api/v2/scripts/{scriptID}/invoke")
retrofit2.Call<okhttp3.ResponseBody> postScriptsIDInvokeResponseBody(@Path(value="scriptID")
                                                                                                                     String scriptID,
                                                                                                                     @Body
                                                                                                                     ScriptInvocationParams scriptInvocationParams)