public interface TasksService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Void> |
deleteTasksID(String taskID,
String zapTraceSpan)
Delete a task
Deletes a task and all associated records
|
retrofit2.Call<Void> |
deleteTasksIDLabelsID(String taskID,
String labelID,
String zapTraceSpan)
Delete a label from a task
|
retrofit2.Call<Void> |
deleteTasksIDMembersID(String userID,
String taskID,
String zapTraceSpan)
Remove a member from a task
|
retrofit2.Call<Void> |
deleteTasksIDOwnersID(String userID,
String taskID,
String zapTraceSpan)
Remove an owner from a task
|
retrofit2.Call<Void> |
deleteTasksIDRunsID(String taskID,
String runID,
String zapTraceSpan)
Cancel a running task
|
retrofit2.Call<Tasks> |
getTasks(String zapTraceSpan,
String name,
String after,
String user,
String org,
String orgID,
String status,
Integer limit)
List all tasks
|
retrofit2.Call<Task> |
getTasksID(String taskID,
String zapTraceSpan)
Retrieve a task
|
retrofit2.Call<LabelsResponse> |
getTasksIDLabels(String taskID,
String zapTraceSpan)
List all labels for a task
|
retrofit2.Call<Logs> |
getTasksIDLogs(String taskID,
String zapTraceSpan)
Retrieve all logs for a task
|
retrofit2.Call<ResourceMembers> |
getTasksIDMembers(String taskID,
String zapTraceSpan)
List all task members
|
retrofit2.Call<ResourceOwners> |
getTasksIDOwners(String taskID,
String zapTraceSpan)
List all owners of a task
|
retrofit2.Call<Runs> |
getTasksIDRuns(String taskID,
String zapTraceSpan,
String after,
Integer limit,
OffsetDateTime afterTime,
OffsetDateTime beforeTime)
List runs for a task
|
retrofit2.Call<Run> |
getTasksIDRunsID(String taskID,
String runID,
String zapTraceSpan)
Retrieve a single run for a task
|
retrofit2.Call<Logs> |
getTasksIDRunsIDLogs(String taskID,
String runID,
String zapTraceSpan)
Retrieve all logs for a run
|
retrofit2.Call<Task> |
patchTasksID(String taskID,
TaskUpdateRequest taskUpdateRequest,
String zapTraceSpan)
Update a task
Update a task.
|
retrofit2.Call<Task> |
postTasks(TaskCreateRequest taskCreateRequest,
String zapTraceSpan)
Create a new task
|
retrofit2.Call<LabelResponse> |
postTasksIDLabels(String taskID,
LabelMapping labelMapping,
String zapTraceSpan)
Add a label to a task
|
retrofit2.Call<ResourceMember> |
postTasksIDMembers(String taskID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add a member to a task
|
retrofit2.Call<ResourceOwner> |
postTasksIDOwners(String taskID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add an owner to a task
|
retrofit2.Call<Run> |
postTasksIDRuns(String taskID,
String zapTraceSpan,
RunManually runManually)
Manually start a task run, overriding the current schedule
|
retrofit2.Call<Run> |
postTasksIDRunsIDRetry(String taskID,
String runID,
String zapTraceSpan)
Retry a task run
|
@DELETE(value="api/v2/tasks/{taskID}")
retrofit2.Call<Void> deleteTasksID(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The ID of the task to delete. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/tasks/{taskID}/labels/{labelID}")
retrofit2.Call<Void> deleteTasksIDLabelsID(@Path(value="taskID")
String taskID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)labelID - The label ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/tasks/{taskID}/members/{userID}")
retrofit2.Call<Void> deleteTasksIDMembersID(@Path(value="userID")
String userID,
@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the member to remove. (required)taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/tasks/{taskID}/owners/{userID}")
retrofit2.Call<Void> deleteTasksIDOwnersID(@Path(value="userID")
String userID,
@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the owner to remove. (required)taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/tasks/{taskID}/runs/{runID}")
retrofit2.Call<Void> deleteTasksIDRunsID(@Path(value="taskID")
String taskID,
@Path(value="runID")
String runID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)runID - The run ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks") retrofit2.Call<Tasks> getTasks(@Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="name") String name, @Query(value="after") String after, @Query(value="user") String user, @Query(value="org") String org, @Query(value="orgID") String orgID, @Query(value="status") String status, @Query(value="limit") Integer limit)
zapTraceSpan - OpenTracing span context (optional)name - Returns task with a specific name. (optional)after - Return tasks after a specified ID. (optional)user - Filter tasks to a specific user ID. (optional)org - Filter tasks to a specific organization name. (optional)orgID - Filter tasks to a specific organization ID. (optional)status - Filter tasks by a status--\"inactive\" or \"active\". (optional)limit - The number of tasks to return (optional, default to 100)@GET(value="api/v2/tasks/{taskID}")
retrofit2.Call<Task> getTasksID(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks/{taskID}/labels")
retrofit2.Call<LabelsResponse> getTasksIDLabels(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks/{taskID}/logs")
retrofit2.Call<Logs> getTasksIDLogs(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks/{taskID}/members")
retrofit2.Call<ResourceMembers> getTasksIDMembers(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks/{taskID}/owners")
retrofit2.Call<ResourceOwners> getTasksIDOwners(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks/{taskID}/runs")
retrofit2.Call<Runs> getTasksIDRuns(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan,
@Query(value="after")
String after,
@Query(value="limit")
Integer limit,
@Query(value="afterTime")
OffsetDateTime afterTime,
@Query(value="beforeTime")
OffsetDateTime beforeTime)
taskID - The ID of the task to get runs for. (required)zapTraceSpan - OpenTracing span context (optional)after - Returns runs after a specific ID. (optional)limit - The number of runs to return (optional, default to 100)afterTime - Filter runs to those scheduled after this time, RFC3339 (optional)beforeTime - Filter runs to those scheduled before this time, RFC3339 (optional)@GET(value="api/v2/tasks/{taskID}/runs/{runID}")
retrofit2.Call<Run> getTasksIDRunsID(@Path(value="taskID")
String taskID,
@Path(value="runID")
String runID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)runID - The run ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/tasks/{taskID}/runs/{runID}/logs")
retrofit2.Call<Logs> getTasksIDRunsIDLogs(@Path(value="taskID")
String taskID,
@Path(value="runID")
String runID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - ID of task to get logs for. (required)runID - ID of run to get logs for. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/tasks/{taskID}")
retrofit2.Call<Task> patchTasksID(@Path(value="taskID")
String taskID,
@Body
TaskUpdateRequest taskUpdateRequest,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)taskUpdateRequest - Task update to apply (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json") @POST(value="api/v2/tasks") retrofit2.Call<Task> postTasks(@Body TaskCreateRequest taskCreateRequest, @Header(value="Zap-Trace-Span") String zapTraceSpan)
taskCreateRequest - Task to create (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/tasks/{taskID}/labels")
retrofit2.Call<LabelResponse> postTasksIDLabels(@Path(value="taskID")
String taskID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/tasks/{taskID}/members")
retrofit2.Call<ResourceMember> postTasksIDMembers(@Path(value="taskID")
String taskID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)addResourceMemberRequestBody - User to add as member (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/tasks/{taskID}/owners")
retrofit2.Call<ResourceOwner> postTasksIDOwners(@Path(value="taskID")
String taskID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)addResourceMemberRequestBody - User to add as owner (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/tasks/{taskID}/runs")
retrofit2.Call<Run> postTasksIDRuns(@Path(value="taskID")
String taskID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan,
@Body
RunManually runManually)
taskID - (required)zapTraceSpan - OpenTracing span context (optional)runManually - (optional)@POST(value="api/v2/tasks/{taskID}/runs/{runID}/retry")
retrofit2.Call<Run> postTasksIDRunsIDRetry(@Path(value="taskID")
String taskID,
@Path(value="runID")
String runID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
taskID - The task ID. (required)runID - The run ID. (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2021 InfluxData, Inc.. All rights reserved.