zen_api/workflows/v2/workflow_service.proto#
Version: 2026.5.1
Package: zen_api.workflows.v2
Service WorkflowService#
The IWorkflowService interface.
GetJobInfo#
Get Job information.
rpc GetJobInfo (zen_api.workflows.v2.WorkflowServiceGetJobInfoRequest) returns (zen_api.workflows.v2.WorkflowServiceGetJobInfoResponse);
Request: zen_api.workflows.v2.WorkflowServiceGetJobInfoRequest
Response: zen_api.workflows.v2.WorkflowServiceGetJobInfoResponse
StartJob#
Start Job execution.
rpc StartJob (zen_api.workflows.v2.WorkflowServiceStartJobRequest) returns (zen_api.workflows.v2.WorkflowServiceStartJobResponse);
Request: zen_api.workflows.v2.WorkflowServiceStartJobRequest
Response: zen_api.workflows.v2.WorkflowServiceStartJobResponse
StopJob#
Stop the Job execution.
rpc StopJob (zen_api.workflows.v2.WorkflowServiceStopJobRequest) returns (zen_api.workflows.v2.WorkflowServiceStopJobResponse);
Request: zen_api.workflows.v2.WorkflowServiceStopJobRequest
Response: zen_api.workflows.v2.WorkflowServiceStopJobResponse
WaitJob#
Wait for the Job execution will be finished.
rpc WaitJob (zen_api.workflows.v2.WorkflowServiceWaitJobRequest) returns (zen_api.workflows.v2.WorkflowServiceWaitJobResponse);
Request: zen_api.workflows.v2.WorkflowServiceWaitJobRequest
Response: zen_api.workflows.v2.WorkflowServiceWaitJobResponse
Message WorkflowServiceGetJobInfoRequest#
The WorkflowServiceGetJobInfoRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_id |
1 | string |
singular | Target Job ID. |
Message WorkflowServiceGetJobInfoResponse#
Response object representing the job info.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_info |
1 | zen_api.workflows.v2.JobInfo | singular | The job info. |
Message WorkflowServiceStartJobRequest#
The WorkflowServiceStartJobRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_name |
1 | string |
singular | Job display name. |
options |
2 | zen_api.workflows.v1.StartJobOptions | singular | Job starting options. |
Message WorkflowServiceStartJobResponse#
Response object representing the starting of a job.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_info |
1 | zen_api.workflows.v2.JobInfo | singular | The job info. |
Message WorkflowServiceStopJobRequest#
The WorkflowServiceStopJobRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_id |
1 | string |
singular | Target Job ID. |
Message WorkflowServiceStopJobResponse#
The WorkflowServiceStopJobResponse class.
Message WorkflowServiceWaitJobRequest#
The WorkflowServiceWaitJobRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_id |
1 | string |
singular | Target Job ID. |
Message WorkflowServiceWaitJobResponse#
The WorkflowServiceWaitJobResponse class.