1. Packages
  2. InfluxDB
  3. API Docs
  4. getTask
InfluxDB v1.5.0 published on Wednesday, Jul 2, 2025 by komminarlabs

influxdb.getTask

Explore with Pulumi AI

influxdb logo
InfluxDB v1.5.0 published on Wednesday, Jul 2, 2025 by komminarlabs

    List all task.

    Using getTask

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTask(args: GetTaskArgs, opts?: InvokeOptions): Promise<GetTaskResult>
    function getTaskOutput(args: GetTaskOutputArgs, opts?: InvokeOptions): Output<GetTaskResult>
    def get_task(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTaskResult
    def get_task_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTaskResult]
    func LookupTask(ctx *Context, args *LookupTaskArgs, opts ...InvokeOption) (*LookupTaskResult, error)
    func LookupTaskOutput(ctx *Context, args *LookupTaskOutputArgs, opts ...InvokeOption) LookupTaskResultOutput

    > Note: This function is named LookupTask in the Go SDK.

    public static class GetTask 
    {
        public static Task<GetTaskResult> InvokeAsync(GetTaskArgs args, InvokeOptions? opts = null)
        public static Output<GetTaskResult> Invoke(GetTaskInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTaskResult> getTask(GetTaskArgs args, InvokeOptions options)
    public static Output<GetTaskResult> getTask(GetTaskArgs args, InvokeOptions options)
    
    fn::invoke:
      function: influxdb:index/getTask:getTask
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The task ID.
    Id string
    The task ID.
    id String
    The task ID.
    id string
    The task ID.
    id str
    The task ID.
    id String
    The task ID.

    getTask Result

    The following output properties are available:

    AuthorizationId string
    The authorization ID. Specifies the authorization used when the task communicates with the query engine.
    CreatedAt string
    The timestamp when the task was created.
    Cron string
    The Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
    Description string
    The description of the task.
    Every string
    The interval duration literal at which the task runs. every also determines when the task first runs, depending on the specified time.
    Flux string
    The Flux script that the task executes.
    Id string
    The task ID.
    Labels List<KomminarLabs.InfluxDB.Outputs.GetTaskLabel>
    The labels associated with the task.
    LastRunError string
    The error message from the last task run, if any.
    LastRunStatus string
    The status of the last task run.
    LatestCompleted string
    A timestamp RFC3339 date/time format of the latest scheduled and completed run.
    Links KomminarLabs.InfluxDB.Outputs.GetTaskLinks
    Links related to the task.
    Name string
    The name of the task.
    Offset string
    The duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
    Org string
    The organization name. Specifies the organization that owns the task.
    OrgId string
    The organization ID. Specifies the organization that owns the task.
    OwnerId string
    The user ID. Specifies the owner of the task.
    Status string
    The status of the task (active or inactive).
    UpdatedAt string
    The timestamp when the task was last updated.
    AuthorizationId string
    The authorization ID. Specifies the authorization used when the task communicates with the query engine.
    CreatedAt string
    The timestamp when the task was created.
    Cron string
    The Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
    Description string
    The description of the task.
    Every string
    The interval duration literal at which the task runs. every also determines when the task first runs, depending on the specified time.
    Flux string
    The Flux script that the task executes.
    Id string
    The task ID.
    Labels []GetTaskLabel
    The labels associated with the task.
    LastRunError string
    The error message from the last task run, if any.
    LastRunStatus string
    The status of the last task run.
    LatestCompleted string
    A timestamp RFC3339 date/time format of the latest scheduled and completed run.
    Links GetTaskLinks
    Links related to the task.
    Name string
    The name of the task.
    Offset string
    The duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
    Org string
    The organization name. Specifies the organization that owns the task.
    OrgId string
    The organization ID. Specifies the organization that owns the task.
    OwnerId string
    The user ID. Specifies the owner of the task.
    Status string
    The status of the task (active or inactive).
    UpdatedAt string
    The timestamp when the task was last updated.
    authorizationId String
    The authorization ID. Specifies the authorization used when the task communicates with the query engine.
    createdAt String
    The timestamp when the task was created.
    cron String
    The Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
    description String
    The description of the task.
    every String
    The interval duration literal at which the task runs. every also determines when the task first runs, depending on the specified time.
    flux String
    The Flux script that the task executes.
    id String
    The task ID.
    labels List<GetTaskLabel>
    The labels associated with the task.
    lastRunError String
    The error message from the last task run, if any.
    lastRunStatus String
    The status of the last task run.
    latestCompleted String
    A timestamp RFC3339 date/time format of the latest scheduled and completed run.
    links GetTaskLinks
    Links related to the task.
    name String
    The name of the task.
    offset String
    The duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
    org String
    The organization name. Specifies the organization that owns the task.
    orgId String
    The organization ID. Specifies the organization that owns the task.
    ownerId String
    The user ID. Specifies the owner of the task.
    status String
    The status of the task (active or inactive).
    updatedAt String
    The timestamp when the task was last updated.
    authorizationId string
    The authorization ID. Specifies the authorization used when the task communicates with the query engine.
    createdAt string
    The timestamp when the task was created.
    cron string
    The Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
    description string
    The description of the task.
    every string
    The interval duration literal at which the task runs. every also determines when the task first runs, depending on the specified time.
    flux string
    The Flux script that the task executes.
    id string
    The task ID.
    labels GetTaskLabel[]
    The labels associated with the task.
    lastRunError string
    The error message from the last task run, if any.
    lastRunStatus string
    The status of the last task run.
    latestCompleted string
    A timestamp RFC3339 date/time format of the latest scheduled and completed run.
    links GetTaskLinks
    Links related to the task.
    name string
    The name of the task.
    offset string
    The duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
    org string
    The organization name. Specifies the organization that owns the task.
    orgId string
    The organization ID. Specifies the organization that owns the task.
    ownerId string
    The user ID. Specifies the owner of the task.
    status string
    The status of the task (active or inactive).
    updatedAt string
    The timestamp when the task was last updated.
    authorization_id str
    The authorization ID. Specifies the authorization used when the task communicates with the query engine.
    created_at str
    The timestamp when the task was created.
    cron str
    The Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
    description str
    The description of the task.
    every str
    The interval duration literal at which the task runs. every also determines when the task first runs, depending on the specified time.
    flux str
    The Flux script that the task executes.
    id str
    The task ID.
    labels Sequence[GetTaskLabel]
    The labels associated with the task.
    last_run_error str
    The error message from the last task run, if any.
    last_run_status str
    The status of the last task run.
    latest_completed str
    A timestamp RFC3339 date/time format of the latest scheduled and completed run.
    links GetTaskLinks
    Links related to the task.
    name str
    The name of the task.
    offset str
    The duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
    org str
    The organization name. Specifies the organization that owns the task.
    org_id str
    The organization ID. Specifies the organization that owns the task.
    owner_id str
    The user ID. Specifies the owner of the task.
    status str
    The status of the task (active or inactive).
    updated_at str
    The timestamp when the task was last updated.
    authorizationId String
    The authorization ID. Specifies the authorization used when the task communicates with the query engine.
    createdAt String
    The timestamp when the task was created.
    cron String
    The Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
    description String
    The description of the task.
    every String
    The interval duration literal at which the task runs. every also determines when the task first runs, depending on the specified time.
    flux String
    The Flux script that the task executes.
    id String
    The task ID.
    labels List<Property Map>
    The labels associated with the task.
    lastRunError String
    The error message from the last task run, if any.
    lastRunStatus String
    The status of the last task run.
    latestCompleted String
    A timestamp RFC3339 date/time format of the latest scheduled and completed run.
    links Property Map
    Links related to the task.
    name String
    The name of the task.
    offset String
    The duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
    org String
    The organization name. Specifies the organization that owns the task.
    orgId String
    The organization ID. Specifies the organization that owns the task.
    ownerId String
    The user ID. Specifies the owner of the task.
    status String
    The status of the task (active or inactive).
    updatedAt String
    The timestamp when the task was last updated.

    Supporting Types

    GetTaskLabel

    Id string
    The label ID.
    Name string
    The label name.
    OrgId string
    The organization ID.
    Properties Dictionary<string, string>
    The key-value pairs associated with this label.
    Id string
    The label ID.
    Name string
    The label name.
    OrgId string
    The organization ID.
    Properties map[string]string
    The key-value pairs associated with this label.
    id String
    The label ID.
    name String
    The label name.
    orgId String
    The organization ID.
    properties Map<String,String>
    The key-value pairs associated with this label.
    id string
    The label ID.
    name string
    The label name.
    orgId string
    The organization ID.
    properties {[key: string]: string}
    The key-value pairs associated with this label.
    id str
    The label ID.
    name str
    The label name.
    org_id str
    The organization ID.
    properties Mapping[str, str]
    The key-value pairs associated with this label.
    id String
    The label ID.
    name String
    The label name.
    orgId String
    The organization ID.
    properties Map<String>
    The key-value pairs associated with this label.
    Labels string
    URI of resource.
    Logs string
    URI of resource.
    Members string
    URI of resource.
    Owners string
    URI of resource.
    Runs string
    URI of resource.
    Self string
    URI of resource.
    Labels string
    URI of resource.
    Logs string
    URI of resource.
    Members string
    URI of resource.
    Owners string
    URI of resource.
    Runs string
    URI of resource.
    Self string
    URI of resource.
    labels String
    URI of resource.
    logs String
    URI of resource.
    members String
    URI of resource.
    owners String
    URI of resource.
    runs String
    URI of resource.
    self String
    URI of resource.
    labels string
    URI of resource.
    logs string
    URI of resource.
    members string
    URI of resource.
    owners string
    URI of resource.
    runs string
    URI of resource.
    self string
    URI of resource.
    labels str
    URI of resource.
    logs str
    URI of resource.
    members str
    URI of resource.
    owners str
    URI of resource.
    runs str
    URI of resource.
    self str
    URI of resource.
    labels String
    URI of resource.
    logs String
    URI of resource.
    members String
    URI of resource.
    owners String
    URI of resource.
    runs String
    URI of resource.
    self String
    URI of resource.

    Package Details

    Repository
    influxdb komminarlabs/pulumi-influxdb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the influxdb Terraform Provider.
    influxdb logo
    InfluxDB v1.5.0 published on Wednesday, Jul 2, 2025 by komminarlabs