Package com.influxdb.client.service

Interface InvokableScriptsService

public interface InvokableScriptsService

  • Method Details

    • deleteScriptsID

      @DELETE("api/v2/scripts/{scriptID}") retrofit2.Call<Void> deleteScriptsID(@Path("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("api/v2/scripts") retrofit2.Call<Scripts> getScripts(@Query("limit") Integer limit, @Query("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("api/v2/scripts/{scriptID}") retrofit2.Call<Script> getScriptsID(@Path("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("Content-Type:application/json") @PATCH("api/v2/scripts/{scriptID}") retrofit2.Call<Script> patchScriptsID(@Path("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("Content-Type:application/json") @POST("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("Content-Type:application/json") @POST("api/v2/scripts/{scriptID}/invoke") retrofit2.Call<String> postScriptsIDInvoke(@Path("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("api/v2/scripts/{scriptID}/invoke") retrofit2.Call<okhttp3.ResponseBody> postScriptsIDInvokeResponseBody(@Path("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<ResponseBody>