ArgoWorkflows::CronWorkflowServiceApi
All URIs are relative to http://localhost:2746
| Method | HTTP request | Description |
|---|---|---|
| cron_workflow_service_create_cron_workflow | POST /api/v1/cron-workflows/namespace | |
| cron_workflow_service_delete_cron_workflow | DELETE /api/v1/cron-workflows/namespace/name | |
| cron_workflow_service_get_cron_workflow | GET /api/v1/cron-workflows/namespace/name | |
| cron_workflow_service_lint_cron_workflow | POST /api/v1/cron-workflows/namespace/lint | |
| cron_workflow_service_list_cron_workflows | GET /api/v1/cron-workflows/namespace | |
| cron_workflow_service_resume_cron_workflow | PUT /api/v1/cron-workflows/namespace/name/resume | |
| cron_workflow_service_suspend_cron_workflow | PUT /api/v1/cron-workflows/namespace/name/suspend | |
| cron_workflow_service_update_cron_workflow | PUT /api/v1/cron-workflows/namespace/name |
cron_workflow_service_create_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflow cron_workflow_service_create_cron_workflow(namespace, body)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
body = ArgoWorkflows::IoArgoprojWorkflowV1alpha1CreateCronWorkflowRequest.new # IoArgoprojWorkflowV1alpha1CreateCronWorkflowRequest |
begin
result = api_instance.cron_workflow_service_create_cron_workflow(namespace, body)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_create_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| body | IoArgoprojWorkflowV1alpha1CreateCronWorkflowRequest |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflow
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_delete_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflowDeletedResponse cron_workflow_service_delete_cron_workflow(namespace, name, opts)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
name = 'name_example' # String |
opts = {
delete_options_grace_period_seconds: 'delete_options_grace_period_seconds_example', # String | 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.
delete_options_preconditions_uid: 'delete_options_preconditions_uid_example', # String | Specifies the target UID. +optional.
delete_options_preconditions_resource_version: 'delete_options_preconditions_resource_version_example', # String | Specifies the target ResourceVersion +optional.
delete_options_orphan_dependents: true, # BOOLEAN | 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.
delete_options_propagation_policy: 'delete_options_propagation_policy_example', # String | 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.
delete_options_dry_run: ['delete_options_dry_run_example'] # Array<String> | 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 +listType=atomic.
}
begin
result = api_instance.cron_workflow_service_delete_cron_workflow(namespace, name, opts)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_delete_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| name | String | ||
| delete_options_grace_period_seconds | String | 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 | String | Specifies the target UID. +optional. | [optional] |
| delete_options_preconditions_resource_version | String | Specifies the target ResourceVersion +optional. | [optional] |
| delete_options_orphan_dependents | BOOLEAN | 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 | String | 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 | Array<String> | 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 +listType=atomic. | [optional] |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflowDeletedResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_get_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflow cron_workflow_service_get_cron_workflow(namespace, name, opts)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
name = 'name_example' # String |
opts = {
get_options_resource_version: 'get_options_resource_version_example' # String | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional
}
begin
result = api_instance.cron_workflow_service_get_cron_workflow(namespace, name, opts)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_get_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| name | String | ||
| get_options_resource_version | String | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional | [optional] |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflow
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_lint_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflow cron_workflow_service_lint_cron_workflow(namespace, body)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
body = ArgoWorkflows::IoArgoprojWorkflowV1alpha1LintCronWorkflowRequest.new # IoArgoprojWorkflowV1alpha1LintCronWorkflowRequest |
begin
result = api_instance.cron_workflow_service_lint_cron_workflow(namespace, body)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_lint_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| body | IoArgoprojWorkflowV1alpha1LintCronWorkflowRequest |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflow
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_list_cron_workflows
IoArgoprojWorkflowV1alpha1CronWorkflowList cron_workflow_service_list_cron_workflows(namespace, opts)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
opts = {
list_options_label_selector: 'list_options_label_selector_example', # String | A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional.
list_options_field_selector: 'list_options_field_selector_example', # String | A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional.
list_options_watch: true, # BOOLEAN | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +optional.
list_options_allow_watch_bookmarks: true, # BOOLEAN | 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. +optional.
list_options_resource_version: 'list_options_resource_version_example', # String | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional
list_options_resource_version_match: 'list_options_resource_version_match_example', # String | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional
list_options_timeout_seconds: 'list_options_timeout_seconds_example', # String | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional.
list_options_limit: 'list_options_limit_example', # String | 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.
list_options_continue: 'list_options_continue_example', # String | 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.
list_options_send_initial_events: true # BOOLEAN | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"io.k8s.initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. +optional
}
begin
result = api_instance.cron_workflow_service_list_cron_workflows(namespace, opts)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_list_cron_workflows: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| list_options_label_selector | String | A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional. | [optional] |
| list_options_field_selector | String | A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional. | [optional] |
| list_options_watch | BOOLEAN | 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 | BOOLEAN | 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. +optional. | [optional] |
| list_options_resource_version | String | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional | [optional] |
| list_options_resource_version_match | String | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional | [optional] |
| list_options_timeout_seconds | String | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional. | [optional] |
| list_options_limit | String | 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 | String | 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] |
| list_options_send_initial_events | BOOLEAN | `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"io.k8s.initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as "data at least as new as the provided `resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise. +optional | [optional] |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflowList
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_resume_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflow cron_workflow_service_resume_cron_workflow(namespace, name, body)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
name = 'name_example' # String |
body = ArgoWorkflows::IoArgoprojWorkflowV1alpha1CronWorkflowResumeRequest.new # IoArgoprojWorkflowV1alpha1CronWorkflowResumeRequest |
begin
result = api_instance.cron_workflow_service_resume_cron_workflow(namespace, name, body)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_resume_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| name | String | ||
| body | IoArgoprojWorkflowV1alpha1CronWorkflowResumeRequest |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflow
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_suspend_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflow cron_workflow_service_suspend_cron_workflow(namespace, name, body)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
name = 'name_example' # String |
body = ArgoWorkflows::IoArgoprojWorkflowV1alpha1CronWorkflowSuspendRequest.new # IoArgoprojWorkflowV1alpha1CronWorkflowSuspendRequest |
begin
result = api_instance.cron_workflow_service_suspend_cron_workflow(namespace, name, body)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_suspend_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| name | String | ||
| body | IoArgoprojWorkflowV1alpha1CronWorkflowSuspendRequest |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflow
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cron_workflow_service_update_cron_workflow
IoArgoprojWorkflowV1alpha1CronWorkflow cron_workflow_service_update_cron_workflow(namespace, name, body)
Example
# load the gem
require 'argo_workflows'
# setup authorization
ArgoWorkflows.configure do |config|
# Configure API key authorization: BearerToken
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = ArgoWorkflows::CronWorkflowServiceApi.new
namespace = 'namespace_example' # String |
name = 'name_example' # String | DEPRECATED: This field is ignored.
body = ArgoWorkflows::IoArgoprojWorkflowV1alpha1UpdateCronWorkflowRequest.new # IoArgoprojWorkflowV1alpha1UpdateCronWorkflowRequest |
begin
result = api_instance.cron_workflow_service_update_cron_workflow(namespace, name, body)
p result
rescue ArgoWorkflows::ApiError => e
puts "Exception when calling CronWorkflowServiceApi->cron_workflow_service_update_cron_workflow: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | String | ||
| name | String | DEPRECATED: This field is ignored. | |
| body | IoArgoprojWorkflowV1alpha1UpdateCronWorkflowRequest |
Return type
IoArgoprojWorkflowV1alpha1CronWorkflow
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json