openapi_client.CronWorkflowServiceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_cron_workflow	POST /api/v1/cron-workflows/{namespace}
delete_cron_workflow	DELETE /api/v1/cron-workflows/{namespace}/{name}
get_cron_workflow	GET /api/v1/cron-workflows/{namespace}/{name}
lint_cron_workflow	POST /api/v1/cron-workflows/{namespace}/lint
list_cron_workflows	GET /api/v1/cron-workflows/{namespace}
resume_cron_workflow	PUT /api/v1/cron-workflows/{namespace}/{name}/resume
suspend_cron_workflow	PUT /api/v1/cron-workflows/{namespace}/{name}/suspend
update_cron_workflow	PUT /api/v1/cron-workflows/{namespace}/{name}

create_cron_workflow

V1alpha1CronWorkflow create_cron_workflow(namespace, body)

Example

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


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

    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	V1alpha1CreateCronWorkflowRequest

Return type

V1alpha1CronWorkflow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

delete_cron_workflow

object delete_cron_workflow(namespace, name, delete_options_grace_period_seconds=delete_options_grace_period_seconds, delete_options_preconditions_uid=delete_options_preconditions_uid, delete_options_preconditions_resource_version=delete_options_preconditions_resource_version, delete_options_orphan_dependents=delete_options_orphan_dependents, delete_options_propagation_policy=delete_options_propagation_policy, delete_options_dry_run=delete_options_dry_run)

Example

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 
delete_options_grace_period_seconds = 'delete_options_grace_period_seconds_example' # str | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +optional. (optional)
delete_options_preconditions_uid = 'delete_options_preconditions_uid_example' # str | Specifies the target UID. +optional. (optional)
delete_options_preconditions_resource_version = 'delete_options_preconditions_resource_version_example' # str | Specifies the target ResourceVersion +optional. (optional)
delete_options_orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +optional. (optional)
delete_options_propagation_policy = 'delete_options_propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +optional. (optional)
delete_options_dry_run = ['delete_options_dry_run_example'] # list[str] | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional. (optional)

    try:
        api_response = api_instance.delete_cron_workflow(namespace, name, delete_options_grace_period_seconds=delete_options_grace_period_seconds, delete_options_preconditions_uid=delete_options_preconditions_uid, delete_options_preconditions_resource_version=delete_options_preconditions_resource_version, delete_options_orphan_dependents=delete_options_orphan_dependents, delete_options_propagation_policy=delete_options_propagation_policy, delete_options_dry_run=delete_options_dry_run)
        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
name	str
delete_options_grace_period_seconds	str	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +optional.	[optional]
delete_options_preconditions_uid	str	Specifies the target UID. +optional.	[optional]
delete_options_preconditions_resource_version	str	Specifies the target ResourceVersion +optional.	[optional]
delete_options_orphan_dependents	bool	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +optional.	[optional]
delete_options_propagation_policy	str	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +optional.	[optional]
delete_options_dry_run	list[str]	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional.	[optional]

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

get_cron_workflow

V1alpha1CronWorkflow get_cron_workflow(namespace, name, get_options_resource_version=get_options_resource_version)

Example

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 
get_options_resource_version = 'get_options_resource_version_example' # str | When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)

    try:
        api_response = api_instance.get_cron_workflow(namespace, name, get_options_resource_version=get_options_resource_version)
        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
name	str
get_options_resource_version	str	When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]

Return type

V1alpha1CronWorkflow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

lint_cron_workflow

V1alpha1CronWorkflow lint_cron_workflow(namespace, body)

Example

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


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

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

Parameters

Name	Type	Description	Notes
namespace	str
body	V1alpha1LintCronWorkflowRequest

Return type

V1alpha1CronWorkflow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

list_cron_workflows

V1alpha1CronWorkflowList list_cron_workflows(namespace, list_options_label_selector=list_options_label_selector, list_options_field_selector=list_options_field_selector, list_options_watch=list_options_watch, list_options_allow_watch_bookmarks=list_options_allow_watch_bookmarks, list_options_resource_version=list_options_resource_version, list_options_timeout_seconds=list_options_timeout_seconds, list_options_limit=list_options_limit, list_options_continue=list_options_continue)

Example

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
list_options_label_selector = 'list_options_label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional. (optional)
list_options_field_selector = 'list_options_field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional. (optional)
list_options_watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +optional. (optional)
list_options_allow_watch_bookmarks = True # bool | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +optional. (optional)
list_options_resource_version = 'list_options_resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. +optional. (optional)
list_options_timeout_seconds = 'list_options_timeout_seconds_example' # str | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional. (optional)
list_options_limit = 'list_options_limit_example' # str | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
list_options_continue = 'list_options_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)

    try:
        api_response = api_instance.list_cron_workflows(namespace, list_options_label_selector=list_options_label_selector, list_options_field_selector=list_options_field_selector, list_options_watch=list_options_watch, list_options_allow_watch_bookmarks=list_options_allow_watch_bookmarks, list_options_resource_version=list_options_resource_version, list_options_timeout_seconds=list_options_timeout_seconds, list_options_limit=list_options_limit, list_options_continue=list_options_continue)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CronWorkflowServiceApi->list_cron_workflows: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
list_options_label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional.	[optional]
list_options_field_selector	str	A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional.	[optional]
list_options_watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +optional.	[optional]
list_options_allow_watch_bookmarks	bool	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +optional.	[optional]
list_options_resource_version	str	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. +optional.	[optional]
list_options_timeout_seconds	str	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional.	[optional]
list_options_limit	str	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.	[optional]
list_options_continue	str	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.	[optional]

Return type

V1alpha1CronWorkflowList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

resume_cron_workflow

V1alpha1CronWorkflow resume_cron_workflow(namespace, name, body)

Example

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 
body = openapi_client.V1alpha1CronWorkflowResumeRequest() # V1alpha1CronWorkflowResumeRequest | 

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

Parameters

Name	Type	Description	Notes
namespace	str
name	str
body	V1alpha1CronWorkflowResumeRequest

Return type

V1alpha1CronWorkflow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

suspend_cron_workflow

V1alpha1CronWorkflow suspend_cron_workflow(namespace, name, body)

Example

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 
body = openapi_client.V1alpha1CronWorkflowSuspendRequest() # V1alpha1CronWorkflowSuspendRequest | 

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

Parameters

Name	Type	Description	Notes
namespace	str
name	str
body	V1alpha1CronWorkflowSuspendRequest

Return type

V1alpha1CronWorkflow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

update_cron_workflow

V1alpha1CronWorkflow update_cron_workflow(namespace, name, body)

Example

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CronWorkflowServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | DEPRECATED: This field is ignored.
body = openapi_client.V1alpha1UpdateCronWorkflowRequest() # V1alpha1UpdateCronWorkflowRequest | 

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

Parameters

Name	Type	Description
namespace	str
name	str	DEPRECATED: This field is ignored.
body	V1alpha1UpdateCronWorkflowRequest

Return type

V1alpha1CronWorkflow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful 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

openapi_client.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

lint_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

resume_cron_workflow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

suspend_cron_workflow

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