onepanel.core.api.CronWorkflowServiceApi

All URIs are relative to http://localhost:8888

Method	HTTP request	Description
create_cron_workflow	POST /apis/v1beta1/{namespace}/cron_workflow
delete_cron_workflow	DELETE /apis/v1beta1/{namespace}/cron_workflows/{uid}
get_cron_workflow	GET /apis/v1beta1/{namespace}/cron_workflow/{uid}
list_cron_workflows	GET /apis/v1beta1/{namespace}/cron_workflows
list_cron_workflows2	GET /apis/v1beta1/{namespace}/cron_workflows/{workflowTemplateName}
update_cron_workflow	PUT /apis/v1beta1/{namespace}/cron_workflow/{uid}

create_cron_workflow

CronWorkflow create_cron_workflow(namespace, body)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
body = onepanel.core.api.CronWorkflow() # CronWorkflow | 

    try:
        api_response = api_instance.create_cron_workflow(namespace, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->create_cron_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
body	CronWorkflow

Return type

CronWorkflow

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_cron_workflow

object delete_cron_workflow(namespace, uid)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
uid = 'uid_example' # str | 

    try:
        api_response = api_instance.delete_cron_workflow(namespace, uid)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->delete_cron_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
uid	str

Return type

object

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cron_workflow

CronWorkflow get_cron_workflow(namespace, uid)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
uid = 'uid_example' # str | 

    try:
        api_response = api_instance.get_cron_workflow(namespace, uid)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->get_cron_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
uid	str

Return type

CronWorkflow

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_cron_workflows

ListCronWorkflowsResponse list_cron_workflows(namespace, workflow_template_name=workflow_template_name, page_size=page_size, page=page)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
workflow_template_name = 'workflow_template_name_example' # str |  (optional)
page_size = 56 # int |  (optional)
page = 56 # int |  (optional)

    try:
        api_response = api_instance.list_cron_workflows(namespace, workflow_template_name=workflow_template_name, page_size=page_size, page=page)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->list_cron_workflows: %s\n" % e)

Parameters

Name	Type	Notes
namespace	str
workflow_template_name	str	[optional]
page_size	int	[optional]
page	int	[optional]

Return type

ListCronWorkflowsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_cron_workflows2

ListCronWorkflowsResponse list_cron_workflows2(namespace, workflow_template_name, page_size=page_size, page=page)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
workflow_template_name = 'workflow_template_name_example' # str | 
page_size = 56 # int |  (optional)
page = 56 # int |  (optional)

    try:
        api_response = api_instance.list_cron_workflows2(namespace, workflow_template_name, page_size=page_size, page=page)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->list_cron_workflows2: %s\n" % e)

Parameters

Name	Type	Notes
namespace	str
workflow_template_name	str
page_size	int	[optional]
page	int	[optional]

Return type

ListCronWorkflowsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_cron_workflow

CronWorkflow update_cron_workflow(namespace, uid, body)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
uid = 'uid_example' # str | 
body = onepanel.core.api.CronWorkflow() # CronWorkflow | 

    try:
        api_response = api_instance.update_cron_workflow(namespace, uid, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->update_cron_workflow: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
uid	str
body	CronWorkflow

Return type

CronWorkflow

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CronWorkflowServiceApi.md

Latest commit

History

CronWorkflowServiceApi.md

File metadata and controls

onepanel.core.api.CronWorkflowServiceApi

create_cron_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_cron_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_cron_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_cron_workflows

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_cron_workflows2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_cron_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details