Interface ITasksService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface ITasksService : IApiAccessorMethods
DeleteTasksID(String, String)
Delete a task
Declaration
void DeleteTasksID(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Remarks
Deletes a task and all associated records
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDAsync(String, String, CancellationToken)
Delete a task
Declaration
System.Threading.Tasks.Task DeleteTasksIDAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Remarks
Deletes a task and all associated records
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete a task
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Remarks
Deletes a task and all associated records
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDLabelsID(String, String, String)
Delete a label from a task
Declaration
void DeleteTasksIDLabelsID(string taskID, string labelID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | labelID | The label ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDLabelsIDAsync(String, String, String, CancellationToken)
Delete a label from a task
Declaration
System.Threading.Tasks.Task DeleteTasksIDLabelsIDAsync(string taskID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | labelID | The label ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Delete a label from a task
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDLabelsIDAsyncWithHttpInfo(string taskID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | labelID | The label ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDLabelsIDWithHttpInfo(String, String, String)
Delete a label from a task
Declaration
ApiResponse<object> DeleteTasksIDLabelsIDWithHttpInfo(string taskID, string labelID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | labelID | The label ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDMembersID(String, String, String)
Remove a member from a task
Declaration
void DeleteTasksIDMembersID(string userID, string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDMembersIDAsync(String, String, String, CancellationToken)
Remove a member from a task
Declaration
System.Threading.Tasks.Task DeleteTasksIDMembersIDAsync(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove a member from a task
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDMembersIDAsyncWithHttpInfo(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDMembersIDWithHttpInfo(String, String, String)
Remove a member from a task
Declaration
ApiResponse<object> DeleteTasksIDMembersIDWithHttpInfo(string userID, string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDOwnersID(String, String, String)
Remove an owner from a task
Declaration
void DeleteTasksIDOwnersID(string userID, string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDOwnersIDAsync(String, String, String, CancellationToken)
Remove an owner from a task
Declaration
System.Threading.Tasks.Task DeleteTasksIDOwnersIDAsync(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove an owner from a task
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDOwnersIDAsyncWithHttpInfo(string userID, string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDOwnersIDWithHttpInfo(String, String, String)
Remove an owner from a task
Declaration
ApiResponse<object> DeleteTasksIDOwnersIDWithHttpInfo(string userID, string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDRunsID(String, String, String)
Cancel a running task
Declaration
void DeleteTasksIDRunsID(string taskID, string runID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDRunsIDAsync(String, String, String, CancellationToken)
Cancel a running task
Declaration
System.Threading.Tasks.Task DeleteTasksIDRunsIDAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDRunsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Cancel a running task
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteTasksIDRunsIDAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDRunsIDWithHttpInfo(String, String, String)
Cancel a running task
Declaration
ApiResponse<object> DeleteTasksIDRunsIDWithHttpInfo(string taskID, string runID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteTasksIDWithHttpInfo(String, String)
Delete a task
Declaration
ApiResponse<object> DeleteTasksIDWithHttpInfo(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Remarks
Deletes a task and all associated records
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasks(String, String, String, String, String, String, String, Nullable<Int32>, String)
List all tasks
Declaration
Tasks GetTasks(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | name | Returns task with a specific name. (optional) |
| System.String | after | Return tasks after a specified ID. (optional) |
| System.String | user | Filter tasks to a specific user ID. (optional) |
| System.String | org | Filter tasks to a specific organization name. (optional) |
| System.String | orgID | Filter tasks to a specific organization ID. (optional) |
| System.String | status | Filter tasks by a status- -"inactive" or "active". (optional) |
| System.Nullable<System.Int32> | limit | The number of tasks to return (optional, default to 100) |
| System.String | type | Type of task, unset by default. (optional) |
Returns
| Type | Description |
|---|---|
| Tasks | Tasks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksAsync(String, String, String, String, String, String, String, Nullable<Int32>, String, CancellationToken)
List all tasks
Declaration
System.Threading.Tasks.Task<Tasks> GetTasksAsync(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | name | Returns task with a specific name. (optional) |
| System.String | after | Return tasks after a specified ID. (optional) |
| System.String | user | Filter tasks to a specific user ID. (optional) |
| System.String | org | Filter tasks to a specific organization name. (optional) |
| System.String | orgID | Filter tasks to a specific organization ID. (optional) |
| System.String | status | Filter tasks by a status- -"inactive" or "active". (optional) |
| System.Nullable<System.Int32> | limit | The number of tasks to return (optional, default to 100) |
| System.String | type | Type of task, unset by default. (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Tasks> | Task of Tasks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksAsyncWithHttpInfo(String, String, String, String, String, String, String, Nullable<Int32>, String, CancellationToken)
List all tasks
Declaration
System.Threading.Tasks.Task<ApiResponse<Tasks>> GetTasksAsyncWithHttpInfo(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | name | Returns task with a specific name. (optional) |
| System.String | after | Return tasks after a specified ID. (optional) |
| System.String | user | Filter tasks to a specific user ID. (optional) |
| System.String | org | Filter tasks to a specific organization name. (optional) |
| System.String | orgID | Filter tasks to a specific organization ID. (optional) |
| System.String | status | Filter tasks by a status- -"inactive" or "active". (optional) |
| System.Nullable<System.Int32> | limit | The number of tasks to return (optional, default to 100) |
| System.String | type | Type of task, unset by default. (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Tasks>> | Task of ApiResponse (Tasks) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksID(String, String)
Retrieve a task
Declaration
TaskType GetTasksID(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| TaskType | TaskType |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDAsync(String, String, CancellationToken)
Retrieve a task
Declaration
System.Threading.Tasks.Task<TaskType> GetTasksIDAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TaskType> | Task of TaskType |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a task
Declaration
System.Threading.Tasks.Task<ApiResponse<TaskType>> GetTasksIDAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TaskType>> | Task of ApiResponse (TaskType) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLabels(String, String)
List all labels for a task
Declaration
LabelsResponse GetTasksIDLabels(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| LabelsResponse | LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLabelsAsync(String, String, CancellationToken)
List all labels for a task
Declaration
System.Threading.Tasks.Task<LabelsResponse> GetTasksIDLabelsAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<LabelsResponse> | Task of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)
List all labels for a task
Declaration
System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetTasksIDLabelsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>> | Task of ApiResponse (LabelsResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLabelsWithHttpInfo(String, String)
List all labels for a task
Declaration
ApiResponse<LabelsResponse> GetTasksIDLabelsWithHttpInfo(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse> | ApiResponse of LabelsResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLogs(String, String)
Retrieve all logs for a task
Declaration
Logs GetTasksIDLogs(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Logs | Logs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLogsAsync(String, String, CancellationToken)
Retrieve all logs for a task
Declaration
System.Threading.Tasks.Task<Logs> GetTasksIDLogsAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Logs> | Task of Logs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLogsAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve all logs for a task
Declaration
System.Threading.Tasks.Task<ApiResponse<Logs>> GetTasksIDLogsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Logs>> | Task of ApiResponse (Logs) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDLogsWithHttpInfo(String, String)
Retrieve all logs for a task
Declaration
ApiResponse<Logs> GetTasksIDLogsWithHttpInfo(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Logs> | ApiResponse of Logs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDMembers(String, String)
List all task members
Declaration
ResourceMembers GetTasksIDMembers(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| ResourceMembers | ResourceMembers |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDMembersAsync(String, String, CancellationToken)
List all task members
Declaration
System.Threading.Tasks.Task<ResourceMembers> GetTasksIDMembersAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ResourceMembers> | Task of ResourceMembers |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDMembersAsyncWithHttpInfo(String, String, CancellationToken)
List all task members
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetTasksIDMembersAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>> | Task of ApiResponse (ResourceMembers) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDMembersWithHttpInfo(String, String)
List all task members
Declaration
ApiResponse<ResourceMembers> GetTasksIDMembersWithHttpInfo(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers> | ApiResponse of ResourceMembers |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDOwners(String, String)
List all owners of a task
Declaration
ResourceOwners GetTasksIDOwners(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| ResourceOwners | ResourceOwners |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDOwnersAsync(String, String, CancellationToken)
List all owners of a task
Declaration
System.Threading.Tasks.Task<ResourceOwners> GetTasksIDOwnersAsync(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ResourceOwners> | Task of ResourceOwners |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)
List all owners of a task
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetTasksIDOwnersAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>> | Task of ApiResponse (ResourceOwners) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDOwnersWithHttpInfo(String, String)
List all owners of a task
Declaration
ApiResponse<ResourceOwners> GetTasksIDOwnersWithHttpInfo(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners> | ApiResponse of ResourceOwners |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRuns(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>)
List runs for a task
Declaration
Runs GetTasksIDRuns(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to get runs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | after | Returns runs after a specific ID. (optional) |
| System.Nullable<System.Int32> | limit | The number of runs to return (optional, default to 100) |
| System.Nullable<DateTime> | afterTime | Filter runs to those scheduled after this time, RFC3339 (optional) |
| System.Nullable<DateTime> | beforeTime | Filter runs to those scheduled before this time, RFC3339 (optional) |
Returns
| Type | Description |
|---|---|
| Runs | Runs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsAsync(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>, CancellationToken)
List runs for a task
Declaration
System.Threading.Tasks.Task<Runs> GetTasksIDRunsAsync(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to get runs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | after | Returns runs after a specific ID. (optional) |
| System.Nullable<System.Int32> | limit | The number of runs to return (optional, default to 100) |
| System.Nullable<DateTime> | afterTime | Filter runs to those scheduled after this time, RFC3339 (optional) |
| System.Nullable<DateTime> | beforeTime | Filter runs to those scheduled before this time, RFC3339 (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Runs> | Task of Runs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsAsyncWithHttpInfo(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>, CancellationToken)
List runs for a task
Declaration
System.Threading.Tasks.Task<ApiResponse<Runs>> GetTasksIDRunsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to get runs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | after | Returns runs after a specific ID. (optional) |
| System.Nullable<System.Int32> | limit | The number of runs to return (optional, default to 100) |
| System.Nullable<DateTime> | afterTime | Filter runs to those scheduled after this time, RFC3339 (optional) |
| System.Nullable<DateTime> | beforeTime | Filter runs to those scheduled before this time, RFC3339 (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Runs>> | Task of ApiResponse (Runs) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsID(String, String, String)
Retrieve a single run for a task
Declaration
Run GetTasksIDRunsID(string taskID, string runID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Run | Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDAsync(String, String, String, CancellationToken)
Retrieve a single run for a task
Declaration
System.Threading.Tasks.Task<Run> GetTasksIDRunsIDAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Run> | Task of Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Retrieve a single run for a task
Declaration
System.Threading.Tasks.Task<ApiResponse<Run>> GetTasksIDRunsIDAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Run>> | Task of ApiResponse (Run) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDLogs(String, String, String)
Retrieve all logs for a run
Declaration
Logs GetTasksIDRunsIDLogs(string taskID, string runID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | ID of task to get logs for. |
| System.String | runID | ID of run to get logs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Logs | Logs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDLogsAsync(String, String, String, CancellationToken)
Retrieve all logs for a run
Declaration
System.Threading.Tasks.Task<Logs> GetTasksIDRunsIDLogsAsync(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | ID of task to get logs for. |
| System.String | runID | ID of run to get logs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Logs> | Task of Logs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDLogsAsyncWithHttpInfo(String, String, String, CancellationToken)
Retrieve all logs for a run
Declaration
System.Threading.Tasks.Task<ApiResponse<Logs>> GetTasksIDRunsIDLogsAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | ID of task to get logs for. |
| System.String | runID | ID of run to get logs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Logs>> | Task of ApiResponse (Logs) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDLogsWithHttpInfo(String, String, String)
Retrieve all logs for a run
Declaration
ApiResponse<Logs> GetTasksIDRunsIDLogsWithHttpInfo(string taskID, string runID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | ID of task to get logs for. |
| System.String | runID | ID of run to get logs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Logs> | ApiResponse of Logs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsIDWithHttpInfo(String, String, String)
Retrieve a single run for a task
Declaration
ApiResponse<Run> GetTasksIDRunsIDWithHttpInfo(string taskID, string runID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Run> | ApiResponse of Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDRunsWithHttpInfo(String, String, String, Nullable<Int32>, Nullable<DateTime>, Nullable<DateTime>)
List runs for a task
Declaration
ApiResponse<Runs> GetTasksIDRunsWithHttpInfo(string taskID, string zapTraceSpan = null, string after = null, int? limit = null, DateTime? afterTime = null, DateTime? beforeTime = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The ID of the task to get runs for. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | after | Returns runs after a specific ID. (optional) |
| System.Nullable<System.Int32> | limit | The number of runs to return (optional, default to 100) |
| System.Nullable<DateTime> | afterTime | Filter runs to those scheduled after this time, RFC3339 (optional) |
| System.Nullable<DateTime> | beforeTime | Filter runs to those scheduled before this time, RFC3339 (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Runs> | ApiResponse of Runs |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksIDWithHttpInfo(String, String)
Retrieve a task
Declaration
ApiResponse<TaskType> GetTasksIDWithHttpInfo(string taskID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<TaskType> | ApiResponse of TaskType |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetTasksWithHttpInfo(String, String, String, String, String, String, String, Nullable<Int32>, String)
List all tasks
Declaration
ApiResponse<Tasks> GetTasksWithHttpInfo(string zapTraceSpan = null, string name = null, string after = null, string user = null, string org = null, string orgID = null, string status = null, int? limit = null, string type = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | name | Returns task with a specific name. (optional) |
| System.String | after | Return tasks after a specified ID. (optional) |
| System.String | user | Filter tasks to a specific user ID. (optional) |
| System.String | org | Filter tasks to a specific organization name. (optional) |
| System.String | orgID | Filter tasks to a specific organization ID. (optional) |
| System.String | status | Filter tasks by a status- -"inactive" or "active". (optional) |
| System.Nullable<System.Int32> | limit | The number of tasks to return (optional, default to 100) |
| System.String | type | Type of task, unset by default. (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Tasks> | ApiResponse of Tasks |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchTasksID(String, TaskUpdateRequest, String)
Update a task
Declaration
TaskType PatchTasksID(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| TaskUpdateRequest | taskUpdateRequest | Task update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| TaskType | TaskType |
Remarks
Update a task. This will cancel all queued runs.
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchTasksIDAsync(String, TaskUpdateRequest, String, CancellationToken)
Update a task
Declaration
System.Threading.Tasks.Task<TaskType> PatchTasksIDAsync(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| TaskUpdateRequest | taskUpdateRequest | Task update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TaskType> | Task of TaskType |
Remarks
Update a task. This will cancel all queued runs.
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchTasksIDAsyncWithHttpInfo(String, TaskUpdateRequest, String, CancellationToken)
Update a task
Declaration
System.Threading.Tasks.Task<ApiResponse<TaskType>> PatchTasksIDAsyncWithHttpInfo(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| TaskUpdateRequest | taskUpdateRequest | Task update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TaskType>> | Task of ApiResponse (TaskType) |
Remarks
Update a task. This will cancel all queued runs.
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchTasksIDWithHttpInfo(String, TaskUpdateRequest, String)
Update a task
Declaration
ApiResponse<TaskType> PatchTasksIDWithHttpInfo(string taskID, TaskUpdateRequest taskUpdateRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| TaskUpdateRequest | taskUpdateRequest | Task update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<TaskType> | ApiResponse of TaskType |
Remarks
Update a task. This will cancel all queued runs.
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasks(TaskCreateRequest, String)
Create a new task
Declaration
TaskType PostTasks(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| TaskCreateRequest | taskCreateRequest | Task to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| TaskType | TaskType |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksAsync(TaskCreateRequest, String, CancellationToken)
Create a new task
Declaration
System.Threading.Tasks.Task<TaskType> PostTasksAsync(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| TaskCreateRequest | taskCreateRequest | Task to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TaskType> | Task of TaskType |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksAsyncWithHttpInfo(TaskCreateRequest, String, CancellationToken)
Create a new task
Declaration
System.Threading.Tasks.Task<ApiResponse<TaskType>> PostTasksAsyncWithHttpInfo(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| TaskCreateRequest | taskCreateRequest | Task to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TaskType>> | Task of ApiResponse (TaskType) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDLabels(String, LabelMapping, String)
Add a label to a task
Declaration
LabelResponse PostTasksIDLabels(string taskID, LabelMapping labelMapping, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| LabelResponse | LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDLabelsAsync(String, LabelMapping, String, CancellationToken)
Add a label to a task
Declaration
System.Threading.Tasks.Task<LabelResponse> PostTasksIDLabelsAsync(string taskID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<LabelResponse> | Task of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)
Add a label to a task
Declaration
System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostTasksIDLabelsAsyncWithHttpInfo(string taskID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>> | Task of ApiResponse (LabelResponse) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDLabelsWithHttpInfo(String, LabelMapping, String)
Add a label to a task
Declaration
ApiResponse<LabelResponse> PostTasksIDLabelsWithHttpInfo(string taskID, LabelMapping labelMapping, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| LabelMapping | labelMapping | Label to add |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<LabelResponse> | ApiResponse of LabelResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDMembers(String, AddResourceMemberRequestBody, String)
Add a member to a task
Declaration
ResourceMember PostTasksIDMembers(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| ResourceMember | ResourceMember |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to a task
Declaration
System.Threading.Tasks.Task<ResourceMember> PostTasksIDMembersAsync(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ResourceMember> | Task of ResourceMember |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to a task
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostTasksIDMembersAsyncWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>> | Task of ApiResponse (ResourceMember) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add a member to a task
Declaration
ApiResponse<ResourceMember> PostTasksIDMembersWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<ResourceMember> | ApiResponse of ResourceMember |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDOwners(String, AddResourceMemberRequestBody, String)
Add an owner to a task
Declaration
ResourceOwner PostTasksIDOwners(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| ResourceOwner | ResourceOwner |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to a task
Declaration
System.Threading.Tasks.Task<ResourceOwner> PostTasksIDOwnersAsync(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ResourceOwner> | Task of ResourceOwner |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to a task
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostTasksIDOwnersAsyncWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>> | Task of ApiResponse (ResourceOwner) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add an owner to a task
Declaration
ApiResponse<ResourceOwner> PostTasksIDOwnersWithHttpInfo(string taskID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner> | ApiResponse of ResourceOwner |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRuns(String, String, RunManually)
Manually start a task run, overriding the current schedule
Declaration
Run PostTasksIDRuns(string taskID, string zapTraceSpan = null, RunManually runManually = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| RunManually | runManually | (optional) |
Returns
| Type | Description |
|---|---|
| Run | Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsAsync(String, String, RunManually, CancellationToken)
Manually start a task run, overriding the current schedule
Declaration
System.Threading.Tasks.Task<Run> PostTasksIDRunsAsync(string taskID, string zapTraceSpan = null, RunManually runManually = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| RunManually | runManually | (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Run> | Task of Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsAsyncWithHttpInfo(String, String, RunManually, CancellationToken)
Manually start a task run, overriding the current schedule
Declaration
System.Threading.Tasks.Task<ApiResponse<Run>> PostTasksIDRunsAsyncWithHttpInfo(string taskID, string zapTraceSpan = null, RunManually runManually = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| RunManually | runManually | (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Run>> | Task of ApiResponse (Run) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsIDRetry(String, String, String, String)
Retry a task run
Declaration
Run PostTasksIDRunsIDRetry(string taskID, string runID, string zapTraceSpan = null, string body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | body | (optional) |
Returns
| Type | Description |
|---|---|
| Run | Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsIDRetryAsync(String, String, String, String, CancellationToken)
Retry a task run
Declaration
System.Threading.Tasks.Task<Run> PostTasksIDRunsIDRetryAsync(string taskID, string runID, string zapTraceSpan = null, string body = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | body | (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Run> | Task of Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsIDRetryAsyncWithHttpInfo(String, String, String, String, CancellationToken)
Retry a task run
Declaration
System.Threading.Tasks.Task<ApiResponse<Run>> PostTasksIDRunsIDRetryAsyncWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, string body = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | body | (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Run>> | Task of ApiResponse (Run) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsIDRetryWithHttpInfo(String, String, String, String)
Retry a task run
Declaration
ApiResponse<Run> PostTasksIDRunsIDRetryWithHttpInfo(string taskID, string runID, string zapTraceSpan = null, string body = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | The task ID. |
| System.String | runID | The run ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| System.String | body | (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Run> | ApiResponse of Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksIDRunsWithHttpInfo(String, String, RunManually)
Manually start a task run, overriding the current schedule
Declaration
ApiResponse<Run> PostTasksIDRunsWithHttpInfo(string taskID, string zapTraceSpan = null, RunManually runManually = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | taskID | |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| RunManually | runManually | (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Run> | ApiResponse of Run |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostTasksWithHttpInfo(TaskCreateRequest, String)
Create a new task
Declaration
ApiResponse<TaskType> PostTasksWithHttpInfo(TaskCreateRequest taskCreateRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| TaskCreateRequest | taskCreateRequest | Task to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<TaskType> | ApiResponse of TaskType |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |