workflows.v2#
Classes:
-
JobStatus–Runtime status of the Job.
-
JobInfo–Information about Job executed by the workflow runner contains a real-time updates and Job's events with Job state.
-
WorkflowServiceGetJobInfoRequest–The WorkflowServiceGetJobInfoRequest class.
-
WorkflowServiceGetJobInfoResponse–Response object representing the job info.
-
WorkflowServiceStartJobRequest–The WorkflowServiceStartJobRequest class.
-
WorkflowServiceStartJobResponse–Response object representing the starting of a job.
-
WorkflowServiceStopJobRequest–The WorkflowServiceStopJobRequest class.
-
WorkflowServiceStopJobResponse–The WorkflowServiceStopJobResponse class.
-
WorkflowServiceWaitJobRequest–The WorkflowServiceWaitJobRequest class.
-
WorkflowServiceWaitJobResponse–The WorkflowServiceWaitJobResponse class.
-
WorkflowServiceStub– -
WorkflowServiceBase–
Bases: Enum
Runtime status of the Job.
Attributes:
-
UNSPECIFIED–Default value if status is not specified.
-
RUNNING–Job is currently executed by the workflow runner.
-
PAUSED–Job execution is paused (not supported for now and reserved only for future purposes
-
COMPLETED–Job execution is successfully completed.
-
FAILED–Job execution was failed.
-
CANCELLED–Job execution was interrupted (cancelled).
-
PENDING–Job is created but still not started and waiting for beginning of execution.
class-attribute
instance-attribute
#
UNSPECIFIED = 0
Default value if status is not specified.
class-attribute
instance-attribute
#
RUNNING = 1
Job is currently executed by the workflow runner.
class-attribute
instance-attribute
#
PAUSED = 2
Job execution is paused (not supported for now and reserved only for future purposes for saving numeration sequence).
class-attribute
instance-attribute
#
COMPLETED = 3
Job execution is successfully completed.
class-attribute
instance-attribute
#
CANCELLED = 5
Job execution was interrupted (cancelled).
class-attribute
instance-attribute
#
PENDING = 6
Job is created but still not started and waiting for beginning of execution.
dataclass
#
JobInfo(job_id: str = betterproto.string_field(1), create_date: datetime = betterproto.message_field(2), status: JobStatus = betterproto.enum_field(3), start_options: StartJobOptions = betterproto.message_field(4))
Bases: Message
Information about Job executed by the workflow runner contains a real-time updates and Job's events with Job state.
Attributes:
-
job_id(str) –A Job unique runtime ID.
-
create_date(datetime) –A date and time when JobInfo was created.
-
status(JobStatus) –A Job execution state.
-
start_options(StartJobOptions) –A Job starting options.
class-attribute
instance-attribute
#
job_id: str = betterproto.string_field(1)
A Job unique runtime ID.
class-attribute
instance-attribute
#
create_date: datetime = betterproto.message_field(2)
A date and time when JobInfo was created.
class-attribute
instance-attribute
#
status: JobStatus = betterproto.enum_field(3)
A Job execution state.
class-attribute
instance-attribute
#
start_options: StartJobOptions = betterproto.message_field(4)
A Job starting options.
dataclass
#
WorkflowServiceGetJobInfoRequest(job_id: str = betterproto.string_field(1))
dataclass
#
WorkflowServiceGetJobInfoResponse(job_info: JobInfo = betterproto.message_field(1))
dataclass
#
WorkflowServiceStartJobRequest(job_name: str = betterproto.string_field(1), options: StartJobOptions = betterproto.message_field(2))
Bases: Message
The WorkflowServiceStartJobRequest class.
Attributes:
-
job_name(str) –Job display name.
-
options(StartJobOptions) –Job starting options.
dataclass
#
WorkflowServiceStartJobResponse(job_info: JobInfo = betterproto.message_field(1))
dataclass
#
WorkflowServiceStopJobRequest(job_id: str = betterproto.string_field(1))
dataclass
#
WorkflowServiceStopJobResponse()
Bases: Message
The WorkflowServiceStopJobResponse class.
dataclass
#
WorkflowServiceWaitJobRequest(job_id: str = betterproto.string_field(1))
dataclass
#
WorkflowServiceWaitJobResponse()
Bases: Message
The WorkflowServiceWaitJobResponse class.
Bases: ServiceStub
Methods:
-
get_job_info–Get Job information.
-
start_job–Start Job execution.
-
stop_job–Stop the Job execution.
-
wait_job–Wait for the Job execution will be finished.
async
#
get_job_info(workflow_service_get_job_info_request: WorkflowServiceGetJobInfoRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceGetJobInfoResponse
Get Job information.
async
#
start_job(workflow_service_start_job_request: WorkflowServiceStartJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceStartJobResponse
Start Job execution.
async
#
stop_job(workflow_service_stop_job_request: WorkflowServiceStopJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceStopJobResponse
Stop the Job execution.
async
#
wait_job(workflow_service_wait_job_request: WorkflowServiceWaitJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceWaitJobResponse
Wait for the Job execution will be finished.
Bases: ServiceBase
Methods:
-
get_job_info–Get Job information.
-
start_job–Start Job execution.
-
stop_job–Stop the Job execution.
-
wait_job–Wait for the Job execution will be finished.
async
#
get_job_info(workflow_service_get_job_info_request: WorkflowServiceGetJobInfoRequest) -> WorkflowServiceGetJobInfoResponse
Get Job information.
async
#
start_job(workflow_service_start_job_request: WorkflowServiceStartJobRequest) -> WorkflowServiceStartJobResponse
Start Job execution.
async
#
stop_job(workflow_service_stop_job_request: WorkflowServiceStopJobRequest) -> WorkflowServiceStopJobResponse
Stop the Job execution.
async
#
wait_job(workflow_service_wait_job_request: WorkflowServiceWaitJobRequest) -> WorkflowServiceWaitJobResponse
Wait for the Job execution will be finished.