Skip to content

workflows.v3beta#

zen_api.workflows.v3beta #

Classes:

JobStatus #

Bases: Enum

Enumerates possible job statuses.

Attributes:

  • UNSPECIFIED –

    Default enum value.

  • NOT_LOADED –

    Job template is not loaded.

  • LOADED –

    Job template is loaded.

  • RUNNING –

    Job is running.

  • FINALIZING –

    Finalizing job results after the job was completed successfully.

  • ARCHIVING –

    Archiving job results after they were finalized.

  • COMPLETED –

    Job was completed successfully.

  • ABORTED –

    Job was aborted.

  • CANCELED –

    Job was canceled.

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default enum value.

NOT_LOADED class-attribute instance-attribute #

NOT_LOADED = 1

Job template is not loaded.

LOADED class-attribute instance-attribute #

LOADED = 2

Job template is loaded.

RUNNING class-attribute instance-attribute #

RUNNING = 3

Job is running.

FINALIZING class-attribute instance-attribute #

FINALIZING = 4

Finalizing job results after the job was completed successfully.

ARCHIVING class-attribute instance-attribute #

ARCHIVING = 5

Archiving job results after they were finalized.

COMPLETED class-attribute instance-attribute #

COMPLETED = 6

Job was completed successfully.

ABORTED class-attribute instance-attribute #

ABORTED = 7

Job was aborted.

CANCELED class-attribute instance-attribute #

CANCELED = 8

Job was canceled.

JobTemplateInfo dataclass #

JobTemplateInfo(name: str = betterproto.string_field(1), description: str = betterproto.string_field(2), category: str = betterproto.string_field(3), subcategory: str = betterproto.string_field(4))

Bases: Message

Contains information about a job template.

Attributes:

  • name (str) –

    The job template's name.

  • description (str) –

    The job template's description.

  • category (str) –

    The job template's category.

  • subcategory (str) –

    The job template's subcategory.

name class-attribute instance-attribute #

name: str = betterproto.string_field(1)

The job template's name.

description class-attribute instance-attribute #

description: str = betterproto.string_field(2)

The job template's description.

category class-attribute instance-attribute #

category: str = betterproto.string_field(3)

The job template's category.

subcategory class-attribute instance-attribute #

subcategory: str = betterproto.string_field(4)

The job template's subcategory.

WorkflowServiceGetAvailableJobTemplatesRequest dataclass #

WorkflowServiceGetAvailableJobTemplatesRequest(category: str = betterproto.string_field(1), subcategory: str = betterproto.string_field(2))

Bases: Message

The WorkflowServiceGetAvailableJobTemplatesRequest class.

Attributes:

  • category (str) –

    Optional filter for job templates. If category is provided then only job templates that are

  • subcategory (str) –

    Optional filter for job templates. If subcategory is provided then only job templates that

category class-attribute instance-attribute #

category: str = betterproto.string_field(1)

Optional filter for job templates. If category is provided then only job templates that are in the specified category will be listed.

subcategory class-attribute instance-attribute #

subcategory: str = betterproto.string_field(2)

Optional filter for job templates. If subcategory is provided then only job templates that are in the specified subcategory will be listed.

WorkflowServiceGetAvailableJobTemplatesResponse dataclass #

WorkflowServiceGetAvailableJobTemplatesResponse(job_templates: List[JobTemplateInfo] = betterproto.message_field(1))

Bases: Message

Represents a list of all available job templates.

Attributes:

job_templates class-attribute instance-attribute #

job_templates: List[JobTemplateInfo] = betterproto.message_field(1)

The available job templates.

WorkflowServiceGetStatusRequest dataclass #

WorkflowServiceGetStatusRequest()

Bases: Message

The WorkflowServiceGetStatusRequest class.

WorkflowServiceGetStatusResponse dataclass #

WorkflowServiceGetStatusResponse(job_status: JobStatus = betterproto.enum_field(1))

Bases: Message

Response containing the job status.

Attributes:

job_status class-attribute instance-attribute #

job_status: JobStatus = betterproto.enum_field(1)

The job status.

WorkflowServiceIsJobRunningRequest dataclass #

WorkflowServiceIsJobRunningRequest()

Bases: Message

The WorkflowServiceIsJobRunningRequest class.

WorkflowServiceIsJobRunningResponse dataclass #

WorkflowServiceIsJobRunningResponse(is_job_running: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the return value of IsJobRunning() method of the Workflow service.

Attributes:

  • is_job_running (bool) –

    A value indicating whether the loaded job is currently running.

is_job_running class-attribute instance-attribute #

is_job_running: bool = betterproto.bool_field(1)

A value indicating whether the loaded job is currently running.

WorkflowServiceIsJobTemplateLoadedRequest dataclass #

WorkflowServiceIsJobTemplateLoadedRequest()

Bases: Message

The WorkflowServiceIsJobTemplateLoadedRequest class.

WorkflowServiceIsJobTemplateLoadedResponse dataclass #

WorkflowServiceIsJobTemplateLoadedResponse(is_job_template_loaded: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the return value of IsJobTemplateLoaded() method of the Workflow service.

Attributes:

is_job_template_loaded class-attribute instance-attribute #

is_job_template_loaded: bool = betterproto.bool_field(1)

A value indicating whether a job template is loaded.

WorkflowServiceLoadJobTemplateRequest dataclass #

WorkflowServiceLoadJobTemplateRequest(job_template_name: str = betterproto.string_field(1), result_path: str = betterproto.string_field(2))

Bases: Message

The WorkflowServiceLoadJobTemplateRequest class.

Attributes:

  • job_template_name (str) –

    The name of the job template.

  • result_path (str) –

    Optional parameter for storing the result outside of ZEN archive. If provided the job result

job_template_name class-attribute instance-attribute #

job_template_name: str = betterproto.string_field(1)

The name of the job template.

result_path class-attribute instance-attribute #

result_path: str = betterproto.string_field(2)

Optional parameter for storing the result outside of ZEN archive. If provided the job result will be stored in the selected location and will not be uploaded to the archive.

WorkflowServiceLoadJobTemplateResponse dataclass #

WorkflowServiceLoadJobTemplateResponse()

Bases: Message

The WorkflowServiceLoadJobTemplateResponse class.

WorkflowServiceRegisterOnStatusChangedRequest dataclass #

WorkflowServiceRegisterOnStatusChangedRequest()

Bases: Message

The WorkflowServiceRegisterOnStatusChangedRequest class.

WorkflowServiceRegisterOnStatusChangedResponse dataclass #

WorkflowServiceRegisterOnStatusChangedResponse(job_status: JobStatus = betterproto.enum_field(1))

Bases: Message

Response containing the job status.

Attributes:

job_status class-attribute instance-attribute #

job_status: JobStatus = betterproto.enum_field(1)

The job status.

WorkflowServiceRunJobRequest dataclass #

WorkflowServiceRunJobRequest()

Bases: Message

The WorkflowServiceRunJobRequest class.

WorkflowServiceRunJobResponse dataclass #

WorkflowServiceRunJobResponse()

Bases: Message

Response object representing the return value of RunJob() method of the Workflow service.

WorkflowServiceStartJobRequest dataclass #

WorkflowServiceStartJobRequest()

Bases: Message

The WorkflowServiceStartJobRequest class.

WorkflowServiceStartJobResponse dataclass #

WorkflowServiceStartJobResponse()

Bases: Message

The WorkflowServiceStartJobResponse class.

WorkflowServiceStopJobRequest dataclass #

WorkflowServiceStopJobRequest()

Bases: Message

The WorkflowServiceStopJobRequest class.

WorkflowServiceStopJobResponse dataclass #

WorkflowServiceStopJobResponse()

Bases: Message

Response object representing the return value of StopJob() method of the Workflow service.

WorkflowServiceUnloadJobTemplateRequest dataclass #

WorkflowServiceUnloadJobTemplateRequest()

Bases: Message

The WorkflowServiceUnloadJobTemplateRequest class.

WorkflowServiceUnloadJobTemplateResponse dataclass #

WorkflowServiceUnloadJobTemplateResponse()

Bases: Message

The WorkflowServiceUnloadJobTemplateResponse class.

WorkflowServiceWaitJobRequest dataclass #

WorkflowServiceWaitJobRequest()

Bases: Message

The WorkflowServiceWaitJobRequest class.

WorkflowServiceWaitJobResponse dataclass #

WorkflowServiceWaitJobResponse()

Bases: Message

Response object representing the return value of WaitJob() method of the Workflow service.

WorkflowServiceStub #

Bases: ServiceStub

Methods:

get_available_job_templates async #

get_available_job_templates(workflow_service_get_available_job_templates_request: WorkflowServiceGetAvailableJobTemplatesRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceGetAvailableJobTemplatesResponse

Retrieves a list of all available job templates.

get_status async #

get_status(workflow_service_get_status_request: WorkflowServiceGetStatusRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceGetStatusResponse

Gets the job status.

is_job_running async #

is_job_running(workflow_service_is_job_running_request: WorkflowServiceIsJobRunningRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceIsJobRunningResponse

Checks if the loaded job is currently running.

is_job_template_loaded async #

is_job_template_loaded(workflow_service_is_job_template_loaded_request: WorkflowServiceIsJobTemplateLoadedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceIsJobTemplateLoadedResponse

Checks if a job template is loaded.

load_job_template async #

load_job_template(workflow_service_load_job_template_request: WorkflowServiceLoadJobTemplateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceLoadJobTemplateResponse

Loads a job template and prepares it for execution.

register_on_status_changed async #

register_on_status_changed(workflow_service_register_on_status_changed_request: WorkflowServiceRegisterOnStatusChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[WorkflowServiceRegisterOnStatusChangedResponse]

Register on job status changed events.

run_job async #

run_job(workflow_service_run_job_request: WorkflowServiceRunJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceRunJobResponse

Runs the loaded job template to completion.

start_job async #

start_job(workflow_service_start_job_request: WorkflowServiceStartJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceStartJobResponse

Starts the loaded job template but it doesn't wait for it to complete.

stop_job async #

stop_job(workflow_service_stop_job_request: WorkflowServiceStopJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceStopJobResponse

Stops the currently running job and waits for it to complete.

unload_job_template async #

unload_job_template(workflow_service_unload_job_template_request: WorkflowServiceUnloadJobTemplateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceUnloadJobTemplateResponse

Unloads the loaded job template.

wait_job async #

wait_job(workflow_service_wait_job_request: WorkflowServiceWaitJobRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowServiceWaitJobResponse

Waits for currently running job to complete.

WorkflowServiceBase #

Bases: ServiceBase

Methods:

get_available_job_templates async #

get_available_job_templates(workflow_service_get_available_job_templates_request: WorkflowServiceGetAvailableJobTemplatesRequest) -> WorkflowServiceGetAvailableJobTemplatesResponse

Retrieves a list of all available job templates.

get_status async #

get_status(workflow_service_get_status_request: WorkflowServiceGetStatusRequest) -> WorkflowServiceGetStatusResponse

Gets the job status.

is_job_running async #

is_job_running(workflow_service_is_job_running_request: WorkflowServiceIsJobRunningRequest) -> WorkflowServiceIsJobRunningResponse

Checks if the loaded job is currently running.

is_job_template_loaded async #

is_job_template_loaded(workflow_service_is_job_template_loaded_request: WorkflowServiceIsJobTemplateLoadedRequest) -> WorkflowServiceIsJobTemplateLoadedResponse

Checks if a job template is loaded.

load_job_template async #

load_job_template(workflow_service_load_job_template_request: WorkflowServiceLoadJobTemplateRequest) -> WorkflowServiceLoadJobTemplateResponse

Loads a job template and prepares it for execution.

register_on_status_changed async #

register_on_status_changed(workflow_service_register_on_status_changed_request: WorkflowServiceRegisterOnStatusChangedRequest) -> AsyncIterator[WorkflowServiceRegisterOnStatusChangedResponse]

Register on job status changed events.

run_job async #

run_job(workflow_service_run_job_request: WorkflowServiceRunJobRequest) -> WorkflowServiceRunJobResponse

Runs the loaded job template to completion.

start_job async #

start_job(workflow_service_start_job_request: WorkflowServiceStartJobRequest) -> WorkflowServiceStartJobResponse

Starts the loaded job template but it doesn't wait for it to complete.

stop_job async #

stop_job(workflow_service_stop_job_request: WorkflowServiceStopJobRequest) -> WorkflowServiceStopJobResponse

Stops the currently running job and waits for it to complete.

unload_job_template async #

unload_job_template(workflow_service_unload_job_template_request: WorkflowServiceUnloadJobTemplateRequest) -> WorkflowServiceUnloadJobTemplateResponse

Unloads the loaded job template.

wait_job async #

wait_job(workflow_service_wait_job_request: WorkflowServiceWaitJobRequest) -> WorkflowServiceWaitJobResponse

Waits for currently running job to complete.