package taskproto
Get desktop application:
View/edit binary Protocol Buffers messages
service TaskService
task.proto:239rpc CreateTask (, )
task.proto:240message
task.proto:32string task_name = 1
string tenant_id = 2
string query_text = 3
task running sql
string owner = 4
optional string comment = 5
some comment
optional schedule_options = 7
optional warehouse_options = 8
optional int32 suspend_task_after_num_failures = 9
SUSPEND_TASK_AFTER_NUM_FAILURES
bool if_not_exist = 10
repeated string after = 11
DAG
optional string when_condition = 12
map<string, string> session_parameters = 13
optional string error_integration = 14
TaskSQLType task_sql_type = 15
optional script_sql = 16
message
task.proto:58optional error = 1
uint64 task_id = 2
rpc DescribeTask (, )
task.proto:241message
task.proto:81string tenant_id = 1
string task_name = 2
bool if_exist = 3
message
task.proto:112optional task = 1
optional error = 2
rpc ExecuteTask (, )
task.proto:242message
task.proto:72string tenant_id = 1
string task_name = 2
message
task.proto:77optional error = 2
rpc DropTask (, )
task.proto:243message
task.proto:63string tenant_id = 1
string task_name = 2
bool if_exist = 3
message
task.proto:68optional error = 1
rpc AlterTask (, )
task.proto:244message
task.proto:130string task_name = 1
string tenant_id = 2
optional string query_text = 3
task running sql
optional string comment = 4
some comment
AlterTaskRequest.AlterTaskType alter_task_type = 5
string owner = 6
optional schedule_options = 7
bool if_exist = 8
optional warehouse_options = 9
optional int32 suspend_task_after_num_failures = 10
SUSPEND_TASK_AFTER_NUM_FAILURES
optional string when_condition = 11
repeated string add_after = 12
repeated string remove_after = 13
bool set_session_parameters = 14
map<string, string> session_parameters = 15
optional string error_integration = 16
TaskSQLType task_sql_type = 17
optional script_sql = 18
message
task.proto:160optional error = 1
optional task = 2
rpc ShowTasks (, )
task.proto:245message
task.proto:117every owner has a roles list like ["role1", "role2"], list tasks in the role list
string tenant_id = 1
string name_like = 2
int32 result_limit = 4
repeated string owners = 5
all available roles under current client
repeated string task_ids = 6
all task ids which permit to access for given user
message
task.proto:125repeated tasks = 1
optional error = 2
rpc ShowTaskRuns (, )
task.proto:246message
task.proto:165string tenant_id = 1
string scheduled_time_start = 2
RFC3339 time
string scheduled_time_end = 3
int32 result_limit = 4
A number specifying the maximum number of rows returned max:10000, default: 100
bool error_only = 5
When set to TRUE, this function returns only task runs that failed or were cancelled.
repeated string owners = 6
repeated string task_ids = 7
string task_name = 8
repeated string task_names = 9
optional string root_task_id = 10
optional int32 page_size = 90
100 by default
optional int64 next_page_token = 91
optional int64 previous_page_token = 92
message
task.proto:212repeated task_runs = 1
optional error = 2
optional int64 next_page_token = 6
optional int64 previous_page_token = 7
rpc GetTaskDependents (, )
task.proto:247message
task.proto:219string tenant_id = 1
string task_name = 2
bool recursive = 3
message
task.proto:225repeated task = 1
optional error = 2
rpc EnableTaskDependents (, )
task.proto:248message
task.proto:230string tenant_id = 1
string task_name = 2
message
task.proto:235optional error = 1
Used in:
Suspend = 0
Resume = 1
Set = 2
ModifyAs = 3
ModifyWhen = 4
AddAfter = 5
RemoveAfter = 6
message
task.proto:6Used in: , , ,
optional int32 interval = 1
secs, INTERVAL= '5 second' means execute sql every 5 secs
optional string cron = 2
CRON = '0 2 * * *' means Every night at 2 AM. UTC time zone.
optional string time_zone = 3
"UTC..."
ScheduleOptions.ScheduleType schedule_type = 4
optional uint64 milliseconds_interval = 5
milliseconds level interval
Used in:
interval_type = 0
cron_type = 1
message
task.proto:28Used in: ,
repeated string sqls = 1
message
task.proto:87Used in: , , ,
uint64 task_id = 1
string task_name = 2
string query_text = 4
optional string comment = 5
string owner = 6
optional schedule_options = 7
optional warehouse_options = 8
optional string next_scheduled_at = 9
optional int32 suspend_task_after_num_failures = 10
SUSPEND_TASK_AFTER_NUM_FAILURES
Task.Status status = 12
string created_at = 14
RFC 3339 format time
string updated_at = 15
optional string last_suspended_at = 16
repeated string after = 17
optional string when_condition = 18
map<string, string> session_parameters = 19
optional string error_integration = 20
Used in:
Suspended = 0
Started = 1
message
task.proto:52Used in: , , , , , , , ,
string kind = 1
string message = 2
int32 code = 3
message
task.proto:182Used in:
uint64 task_id = 1
string task_name = 2
string query_text = 4
optional string comment = 5
string owner = 6
optional schedule_options = 7
string run_id = 8
int32 attempt_number = 9
optional warehouse_options = 10
TaskRun.State state = 11
int64 error_code = 12
optional string error_message = 13
string scheduled_time = 14
optional string completed_time = 16
string query_id = 17
string condition_text = 18
string root_task_id = 19
map<string, string> session_parameters = 20
Used in:
SCHEDULED = 0
EXECUTING = 1
SUCCEEDED = 2
FAILED = 3
CANCELLED = 4
Used in: ,
SQL = 0
SCRIPT = 1
message
task.proto:18Used in: , , ,
optional string warehouse = 1
warehouse or using_warehouse_size
optional string using_warehouse_size = 2
TODO using warehouse or just use serverless warehouse by size