All URIs are relative to https://dbos
| Method | HTTP request | Description |
|---|---|---|
| create_flow | POST /jobFlows | Creates a new Flow, and returns its ID for later use. |
| get_job_definitions_by_flow | GET /jobFlows/{flowId}/jobs | Returns job definitions for the given flow ID. |
| get_job_flow | GET /jobFlows/{flowId} | Returns a Flow with the given ID, if any. |
| get_job_flows | GET /jobFlows | Returns all known flows. |
JobFlow create_flow(root_job_id=root_job_id)
Creates a new Flow, and returns its ID for later use.
This API creates a new Flow, optionally for an existing Job, and returns the new Flow. If a root Job is provided, and is already associated with a Flow, no flow is created, but the existing Flow is returned instead.
from __future__ import print_function
import time
import optimserverclientpython
from optimserverclientpython.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = optimserverclientpython.FlowApi()
root_job_id = 'root_job_id_example' # str | Identifier of the existing Job that should be the root of the new Flow. If the root Job is already associated with a Flow, no flow is created, but the existing flow is returned instead. If the root Job does not have an associated flow yet, a new Flow is created and the given root Job is associated to this new Flow. (optional)
try:
# Creates a new Flow, and returns its ID for later use.
api_response = api_instance.create_flow(root_job_id=root_job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowApi->create_flow: %s\n" % e)
| Name | Type | Description | Notes |
|---|---|---|---|
| root_job_id | str | Identifier of the existing Job that should be the root of the new Flow. If the root Job is already associated with a Flow, no flow is created, but the existing flow is returned instead. If the root Job does not have an associated flow yet, a new Flow is created and the given root Job is associated to this new Flow. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[JobDefinition] get_job_definitions_by_flow(flow_id)
Returns job definitions for the given flow ID.
This API allows you to retrieve job definitions by flow ID.
from __future__ import print_function
import time
import optimserverclientpython
from optimserverclientpython.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = optimserverclientpython.FlowApi()
flow_id = 'flow_id_example' # str |
try:
# Returns job definitions for the given flow ID.
api_response = api_instance.get_job_definitions_by_flow(flow_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowApi->get_job_definitions_by_flow: %s\n" % e)
| Name | Type | Description | Notes |
|---|---|---|---|
| flow_id | str |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobFlow get_job_flow(flow_id)
Returns a Flow with the given ID, if any.
This API allows you to retrieve a flow.
from __future__ import print_function
import time
import optimserverclientpython
from optimserverclientpython.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = optimserverclientpython.FlowApi()
flow_id = 'flow_id_example' # str |
try:
# Returns a Flow with the given ID, if any.
api_response = api_instance.get_job_flow(flow_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowApi->get_job_flow: %s\n" % e)
| Name | Type | Description | Notes |
|---|---|---|---|
| flow_id | str |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[JobFlow] get_job_flows()
Returns all known flows.
This API allows you to retrieve all flows from the system.
from __future__ import print_function
import time
import optimserverclientpython
from optimserverclientpython.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = optimserverclientpython.FlowApi()
try:
# Returns all known flows.
api_response = api_instance.get_job_flows()
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowApi->get_job_flows: %s\n" % e)
This endpoint does not need any parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]