snowflake.getTasks

Explore with Pulumi AI

Snowflake v1.1.3 published on Saturday, Mar 8, 2025 by Pulumi

Using getTasks

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 getTasks(args: GetTasksArgs, opts?: InvokeOptions): Promise<GetTasksResult>
function getTasksOutput(args: GetTasksOutputArgs, opts?: InvokeOptions): Output<GetTasksResult>

def get_tasks(in_: Optional[GetTasksIn] = None,
              like: Optional[str] = None,
              limit: Optional[GetTasksLimit] = None,
              root_only: Optional[bool] = None,
              starts_with: Optional[str] = None,
              with_parameters: Optional[bool] = None,
              opts: Optional[InvokeOptions] = None) -> GetTasksResult
def get_tasks_output(in_: Optional[pulumi.Input[GetTasksInArgs]] = None,
              like: Optional[pulumi.Input[str]] = None,
              limit: Optional[pulumi.Input[GetTasksLimitArgs]] = None,
              root_only: Optional[pulumi.Input[bool]] = None,
              starts_with: Optional[pulumi.Input[str]] = None,
              with_parameters: Optional[pulumi.Input[bool]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTasksResult]

func GetTasks(ctx *Context, args *GetTasksArgs, opts ...InvokeOption) (*GetTasksResult, error)
func GetTasksOutput(ctx *Context, args *GetTasksOutputArgs, opts ...InvokeOption) GetTasksResultOutput

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

public static class GetTasks 
{
    public static Task<GetTasksResult> InvokeAsync(GetTasksArgs args, InvokeOptions? opts = null)
    public static Output<GetTasksResult> Invoke(GetTasksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTasksResult> getTasks(GetTasksArgs args, InvokeOptions options)
public static Output<GetTasksResult> getTasks(GetTasksArgs args, InvokeOptions options)

fn::invoke:
  function: snowflake:index/getTasks:getTasks
  arguments:
    # arguments dictionary

The following arguments are supported:

In GetTasksIn: IN clause to filter the list of objects
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
RootOnly bool: Filters the command output to return only root tasks (tasks with no predecessors).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithParameters bool: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

In GetTasksIn: IN clause to filter the list of objects
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
RootOnly bool: Filters the command output to return only root tasks (tasks with no predecessors).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithParameters bool: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

in GetTasksIn: IN clause to filter the list of objects
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
rootOnly Boolean: Filters the command output to return only root tasks (tasks with no predecessors).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withParameters Boolean: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

in GetTasksIn: IN clause to filter the list of objects
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
rootOnly boolean: Filters the command output to return only root tasks (tasks with no predecessors).
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withParameters boolean: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

in_ GetTasksIn: IN clause to filter the list of objects
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
root_only bool: Filters the command output to return only root tasks (tasks with no predecessors).
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_parameters bool: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

in Property Map: IN clause to filter the list of objects
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
rootOnly Boolean: Filters the command output to return only root tasks (tasks with no predecessors).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withParameters Boolean: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

getTasks Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Tasks List<GetTasksTask>: Holds the aggregated output of all task details queries.
In GetTasksIn: IN clause to filter the list of objects
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
RootOnly bool: Filters the command output to return only root tasks (tasks with no predecessors).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithParameters bool: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
Tasks []GetTasksTask: Holds the aggregated output of all task details queries.
In GetTasksIn: IN clause to filter the list of objects
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
RootOnly bool: Filters the command output to return only root tasks (tasks with no predecessors).
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithParameters bool: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
tasks List<GetTasksTask>: Holds the aggregated output of all task details queries.
in GetTasksIn: IN clause to filter the list of objects
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
rootOnly Boolean: Filters the command output to return only root tasks (tasks with no predecessors).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withParameters Boolean: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
tasks GetTasksTask[]: Holds the aggregated output of all task details queries.
in GetTasksIn: IN clause to filter the list of objects
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
rootOnly boolean: Filters the command output to return only root tasks (tasks with no predecessors).
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withParameters boolean: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
tasks Sequence[GetTasksTask]: Holds the aggregated output of all task details queries.
in_ GetTasksIn: IN clause to filter the list of objects
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetTasksLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
root_only bool: Filters the command output to return only root tasks (tasks with no predecessors).
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_parameters bool: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
tasks List<Property Map>: Holds the aggregated output of all task details queries.
in Property Map: IN clause to filter the list of objects
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
rootOnly Boolean: Filters the command output to return only root tasks (tasks with no predecessors).
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withParameters Boolean: Runs SHOW PARAMETERS FOR TASK for each task returned by SHOW TASK and saves the output to the parameters field as a map. By default this value is set to true.

Supporting Types

GetTasksIn

Account bool: Returns records for the entire account.
Application string: Returns records for the specified application.
ApplicationPackage string: Returns records for the specified application package.
Database string: Returns records for the current database in use or for a specified database.
Schema string: Returns records for the current schema in use or a specified schema. Use fully qualified name.

Account bool: Returns records for the entire account.
Application string: Returns records for the specified application.
ApplicationPackage string: Returns records for the specified application package.
Database string: Returns records for the current database in use or for a specified database.
Schema string: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account Boolean: Returns records for the entire account.
application String: Returns records for the specified application.
applicationPackage String: Returns records for the specified application package.
database String: Returns records for the current database in use or for a specified database.
schema String: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account boolean: Returns records for the entire account.
application string: Returns records for the specified application.
applicationPackage string: Returns records for the specified application package.
database string: Returns records for the current database in use or for a specified database.
schema string: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account bool: Returns records for the entire account.
application str: Returns records for the specified application.
application_package str: Returns records for the specified application package.
database str: Returns records for the current database in use or for a specified database.
schema str: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account Boolean: Returns records for the entire account.
application String: Returns records for the specified application.
applicationPackage String: Returns records for the specified application package.
database String: Returns records for the current database in use or for a specified database.
schema String: Returns records for the current schema in use or a specified schema. Use fully qualified name.

GetTasksLimit

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Integer: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows number: The maximum number of rows to return.
from string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows int: The maximum number of rows to return.
from_ str: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Number: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.