TasksAPI

public class TasksAPI
  • Declaration

    Swift

    public init(influxDB2API: InfluxDB2API)
  • Delete a task

    Declaration

    Swift

    public func deleteTasksID(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The ID of the task to delete.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Delete a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func deleteTasksID(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    taskID

    (path) The ID of the task to delete.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Delete a label from a task

    Declaration

    Swift

    public func deleteTasksIDLabelsID(taskID: String, labelID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    labelID

    (path) The label ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Delete a label from a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func deleteTasksIDLabelsID(taskID: String, labelID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    taskID

    (path) The task ID.

    labelID

    (path) The label ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Remove a member from a task

    Declaration

    Swift

    public func deleteTasksIDMembersID(userID: String, taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    userID

    (path) The ID of the member to remove.

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Remove a member from a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func deleteTasksIDMembersID(userID: String, taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    userID

    (path) The ID of the member to remove.

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Remove an owner from a task

    Declaration

    Swift

    public func deleteTasksIDOwnersID(userID: String, taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    userID

    (path) The ID of the owner to remove.

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Remove an owner from a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func deleteTasksIDOwnersID(userID: String, taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    userID

    (path) The ID of the owner to remove.

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Cancel a running task

    Declaration

    Swift

    public func deleteTasksIDRunsID(taskID: String, runID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Void?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    runID

    (path) The run ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Cancel a running task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func deleteTasksIDRunsID(taskID: String, runID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Void?

    Parameters

    taskID

    (path) The task ID.

    runID

    (path) The run ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • enum for parameter status

    See more

    Declaration

    Swift

    public enum Status_getTasks : String, CaseIterable
  • enum for parameter type

    See more

    Declaration

    Swift

    public enum ModelType_getTasks : String, CaseIterable
  • List all tasks

    Declaration

    Swift

    public func getTasks(zapTraceSpan: String? = nil, name: String? = nil, after: String? = nil, user: String? = nil, org: String? = nil, orgID: String? = nil, status: Status_getTasks? = nil, limit: Int? = nil, type: ModelType_getTasks? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Tasks?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    zapTraceSpan

    (header) OpenTracing span context (optional)

    name

    (query) Returns task with a specific name. (optional)

    after

    (query) Return tasks after a specified ID. (optional)

    user

    (query) Filter tasks to a specific user ID. (optional)

    org

    (query) Filter tasks to a specific organization name. (optional)

    orgID

    (query) Filter tasks to a specific organization ID. (optional)

    status

    (query) Filter tasks by a status–"inactive" or "active". (optional)

    limit

    (query) The number of tasks to return (optional, default to 100)

    type

    (query) Type of task, unset by default. (optional, default to .empty)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all tasks

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasks(zapTraceSpan: String? = nil, name: String? = nil, after: String? = nil, user: String? = nil, org: String? = nil, orgID: String? = nil, status: Status_getTasks? = nil, limit: Int? = nil, type: ModelType_getTasks? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Tasks?

    Parameters

    zapTraceSpan

    (header) OpenTracing span context (optional)

    name

    (query) Returns task with a specific name. (optional)

    after

    (query) Return tasks after a specified ID. (optional)

    user

    (query) Filter tasks to a specific user ID. (optional)

    org

    (query) Filter tasks to a specific organization name. (optional)

    orgID

    (query) Filter tasks to a specific organization ID. (optional)

    status

    (query) Filter tasks by a status–"inactive" or "active". (optional)

    limit

    (query) The number of tasks to return (optional, default to 100)

    type

    (query) Type of task, unset by default. (optional, default to .empty)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve a task

    Declaration

    Swift

    public func getTasksID(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Task?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksID(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Task?

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all labels for a task

    Declaration

    Swift

    public func getTasksIDLabels(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: LabelsResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all labels for a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDLabels(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> LabelsResponse?

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve all logs for a task

    Declaration

    Swift

    public func getTasksIDLogs(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Logs?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve all logs for a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDLogs(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Logs?

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all task members

    Declaration

    Swift

    public func getTasksIDMembers(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceMembers?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all task members

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDMembers(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceMembers?

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all owners of a task

    Declaration

    Swift

    public func getTasksIDOwners(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceOwners?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List all owners of a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDOwners(taskID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceOwners?

    Parameters

    taskID

    (path) The task ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List runs for a task

    Declaration

    Swift

    public func getTasksIDRuns(taskID: String, zapTraceSpan: String? = nil, after: String? = nil, limit: Int? = nil, afterTime: Date? = nil, beforeTime: Date? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Runs?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The ID of the task to get runs for.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    after

    (query) Returns runs after a specific ID. (optional)

    limit

    (query) The number of runs to return (optional, default to 100)

    afterTime

    (query) Filter runs to those scheduled after this time, RFC3339 (optional)

    beforeTime

    (query) Filter runs to those scheduled before this time, RFC3339 (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • List runs for a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDRuns(taskID: String, zapTraceSpan: String? = nil, after: String? = nil, limit: Int? = nil, afterTime: Date? = nil, beforeTime: Date? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Runs?

    Parameters

    taskID

    (path) The ID of the task to get runs for.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    after

    (query) Returns runs after a specific ID. (optional)

    limit

    (query) The number of runs to return (optional, default to 100)

    afterTime

    (query) Filter runs to those scheduled after this time, RFC3339 (optional)

    beforeTime

    (query) Filter runs to those scheduled before this time, RFC3339 (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve a single run for a task

    Declaration

    Swift

    public func getTasksIDRunsID(taskID: String, runID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Run?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    runID

    (path) The run ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve a single run for a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDRunsID(taskID: String, runID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Run?

    Parameters

    taskID

    (path) The task ID.

    runID

    (path) The run ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve all logs for a run

    Declaration

    Swift

    public func getTasksIDRunsIDLogs(taskID: String, runID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Logs?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) ID of task to get logs for.

    runID

    (path) ID of run to get logs for.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retrieve all logs for a run

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func getTasksIDRunsIDLogs(taskID: String, runID: String, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Logs?

    Parameters

    taskID

    (path) ID of task to get logs for.

    runID

    (path) ID of run to get logs for.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Update a task

    Declaration

    Swift

    public func patchTasksID(taskID: String, taskUpdateRequest: TaskUpdateRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Task?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    taskUpdateRequest

    (body) Task update to apply

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Update a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func patchTasksID(taskID: String, taskUpdateRequest: TaskUpdateRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Task?

    Parameters

    taskID

    (path) The task ID.

    taskUpdateRequest

    (body) Task update to apply

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Create a new task

    Declaration

    Swift

    public func postTasks(taskCreateRequest: TaskCreateRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Task?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskCreateRequest

    (body) Task to create

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Create a new task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func postTasks(taskCreateRequest: TaskCreateRequest, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Task?

    Parameters

    taskCreateRequest

    (body) Task to create

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Add a label to a task

    Declaration

    Swift

    public func postTasksIDLabels(taskID: String, labelMapping: LabelMapping, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: LabelResponse?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    labelMapping

    (body) Label to add

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Add a label to a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func postTasksIDLabels(taskID: String, labelMapping: LabelMapping, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> LabelResponse?

    Parameters

    taskID

    (path) The task ID.

    labelMapping

    (body) Label to add

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Add a member to a task

    Declaration

    Swift

    public func postTasksIDMembers(taskID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceMember?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    addResourceMemberRequestBody

    (body) User to add as member

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Add a member to a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func postTasksIDMembers(taskID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceMember?

    Parameters

    taskID

    (path) The task ID.

    addResourceMemberRequestBody

    (body) User to add as member

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Add an owner to a task

    Declaration

    Swift

    public func postTasksIDOwners(taskID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: ResourceOwner?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    addResourceMemberRequestBody

    (body) User to add as owner

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Add an owner to a task

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func postTasksIDOwners(taskID: String, addResourceMemberRequestBody: AddResourceMemberRequestBody, zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> ResourceOwner?

    Parameters

    taskID

    (path) The task ID.

    addResourceMemberRequestBody

    (body) User to add as owner

    zapTraceSpan

    (header) OpenTracing span context (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Manually start a task run, overriding the current schedule

    Declaration

    Swift

    public func postTasksIDRuns(taskID: String, zapTraceSpan: String? = nil, runManually: RunManually? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Run?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path)

    zapTraceSpan

    (header) OpenTracing span context (optional)

    runManually

    (body) (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Manually start a task run, overriding the current schedule

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func postTasksIDRuns(taskID: String, zapTraceSpan: String? = nil, runManually: RunManually? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Run?

    Parameters

    taskID

    (path)

    zapTraceSpan

    (header) OpenTracing span context (optional)

    runManually

    (body) (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retry a task run

    Declaration

    Swift

    public func postTasksIDRunsIDRetry(taskID: String, runID: String, zapTraceSpan: String? = nil, body: Any? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: Run?, _ error: InfluxDBClient.InfluxDBError?) -> Void)

    Parameters

    taskID

    (path) The task ID.

    runID

    (path) The run ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    body

    (body) (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects

  • Retry a task run

    Declaration

    Swift

    @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
    public func postTasksIDRunsIDRetry(taskID: String, runID: String, zapTraceSpan: String? = nil, body: Any? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> Run?

    Parameters

    taskID

    (path) The task ID.

    runID

    (path) The run ID.

    zapTraceSpan

    (header) OpenTracing span context (optional)

    body

    (body) (optional)

    apiResponseQueue

    The queue on which api response is dispatched.

    completion

    completion handler to receive the data and the error objects