com.influxdb.client.service.InvokableScriptsService Maven / Gradle / Ivy

Go to download
package com.influxdb.client.service;

import retrofit2.Call;
import retrofit2.http.*;

import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import okhttp3.MultipartBody;

import com.influxdb.client.domain.Script;
import com.influxdb.client.domain.ScriptCreateRequest;
import com.influxdb.client.domain.ScriptInvocationParams;
import com.influxdb.client.domain.ScriptUpdateRequest;
import com.influxdb.client.domain.Scripts;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public interface InvokableScriptsService {
  /**
   * Delete a script
   * Deletes a script and all associated records.
   * @param scriptID The ID of the script to delete. (required)
   * @return Call<Void>
   */
  @DELETE("api/v2/scripts/{scriptID}")
  Call deleteScriptsID(
    @retrofit2.http.Path("scriptID") String scriptID
  );

  /**
   * List scripts
   * 
   * @param limit The number of scripts to return. (optional)
   * @param offset The offset for pagination. (optional)
   * @return Call<Scripts>
   */
  @GET("api/v2/scripts")
  Call getScripts(
    @retrofit2.http.Query("limit") Integer limit, @retrofit2.http.Query("offset") Integer offset
  );

  /**
   * Retrieve a script
   * Uses script ID to retrieve details of an invokable script.
   * @param scriptID The script ID. (required)
   * @return Call<Script>
   */
  @GET("api/v2/scripts/{scriptID}")
  Call