Class: ArgoWorkflows::CronWorkflowServiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/api/cron_workflow_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CronWorkflowServiceApi

Returns a new instance of CronWorkflowServiceApi.



19
20
21
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cron_workflow_service_create_cron_workflow(namespace, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflow

Parameters:

  • namespace
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 26

def cron_workflow_service_create_cron_workflow(namespace, body, opts = {})
  data, _status_code, _headers = cron_workflow_service_create_cron_workflow_with_http_info(namespace, body, opts)
  data
end

#cron_workflow_service_create_cron_workflow_with_http_info(namespace, body, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflow data, response status code and response headers.

Parameters:

  • namespace
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 35

def cron_workflow_service_create_cron_workflow_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_create_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_create_cron_workflow"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CronWorkflowServiceApi.cron_workflow_service_create_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}'.sub('{' + 'namespace' + '}', namespace.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_create_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_delete_cron_workflow(namespace, name, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflowDeletedResponse

Parameters:

  • namespace
  • name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :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.

  • :delete_options_preconditions_uid (String) —

    Specifies the target UID. +optional.

  • :delete_options_preconditions_resource_version (String) —

    Specifies the target ResourceVersion +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 &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both. +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: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground. +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&#x3D;atomic.

Returns:



88
89
90
91
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 88

def cron_workflow_service_delete_cron_workflow(namespace, name, opts = {})
  data, _status_code, _headers = cron_workflow_service_delete_cron_workflow_with_http_info(namespace, name, opts)
  data
end

#cron_workflow_service_delete_cron_workflow_with_http_info(namespace, name, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflowDeletedResponse, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflowDeletedResponse data, response status code and response headers.

Parameters:

  • namespace
  • name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :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.

  • :delete_options_preconditions_uid (String) —

    Specifies the target UID. +optional.

  • :delete_options_preconditions_resource_version (String) —

    Specifies the target ResourceVersion +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 &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both. +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: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground. +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&#x3D;atomic.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 103

def cron_workflow_service_delete_cron_workflow_with_http_info(namespace, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_delete_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_delete_cron_workflow"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CronWorkflowServiceApi.cron_workflow_service_delete_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}/{name}'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'deleteOptions.gracePeriodSeconds'] = opts[:'delete_options_grace_period_seconds'] if !opts[:'delete_options_grace_period_seconds'].nil?
  query_params[:'deleteOptions.preconditions.uid'] = opts[:'delete_options_preconditions_uid'] if !opts[:'delete_options_preconditions_uid'].nil?
  query_params[:'deleteOptions.preconditions.resourceVersion'] = opts[:'delete_options_preconditions_resource_version'] if !opts[:'delete_options_preconditions_resource_version'].nil?
  query_params[:'deleteOptions.orphanDependents'] = opts[:'delete_options_orphan_dependents'] if !opts[:'delete_options_orphan_dependents'].nil?
  query_params[:'deleteOptions.propagationPolicy'] = opts[:'delete_options_propagation_policy'] if !opts[:'delete_options_propagation_policy'].nil?
  query_params[:'deleteOptions.dryRun'] = @api_client.build_collection_param(opts[:'delete_options_dry_run'], :multi) if !opts[:'delete_options_dry_run'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflowDeletedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_delete_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_get_cron_workflow(namespace, name, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflow

Parameters:

  • namespace
  • name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



157
158
159
160
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 157

def cron_workflow_service_get_cron_workflow(namespace, name, opts = {})
  data, _status_code, _headers = cron_workflow_service_get_cron_workflow_with_http_info(namespace, name, opts)
  data
end

#cron_workflow_service_get_cron_workflow_with_http_info(namespace, name, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflow data, response status code and response headers.

Parameters:

  • namespace
  • name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 167

def cron_workflow_service_get_cron_workflow_with_http_info(namespace, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_get_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_get_cron_workflow"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CronWorkflowServiceApi.cron_workflow_service_get_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}/{name}'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'getOptions.resourceVersion'] = opts[:'get_options_resource_version'] if !opts[:'get_options_resource_version'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_get_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_lint_cron_workflow(namespace, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflow

Parameters:

  • namespace
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



215
216
217
218
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 215

def cron_workflow_service_lint_cron_workflow(namespace, body, opts = {})
  data, _status_code, _headers = cron_workflow_service_lint_cron_workflow_with_http_info(namespace, body, opts)
  data
end

#cron_workflow_service_lint_cron_workflow_with_http_info(namespace, body, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflow data, response status code and response headers.

Parameters:

  • namespace
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 224

def cron_workflow_service_lint_cron_workflow_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_lint_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_lint_cron_workflow"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CronWorkflowServiceApi.cron_workflow_service_lint_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}/lint'.sub('{' + 'namespace' + '}', namespace.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_lint_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_list_cron_workflows(namespace, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflowList

Parameters:

  • namespace
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :list_options_label_selector (String) —

    A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional.

  • :list_options_field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything. +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.

  • :list_options_allow_watch_bookmarks (BOOLEAN) —

    allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;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 (String) —

    resourceVersion sets a constraint on what resource versions a request may be served from. See kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +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 kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +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.

  • :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 &#x60;continue&#x60; 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 (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 &quot;next key&quot;. 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 (BOOLEAN) —

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. 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 &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;io.k8s.initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise. +optional

Returns:



280
281
282
283
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 280

def cron_workflow_service_list_cron_workflows(namespace, opts = {})
  data, _status_code, _headers = cron_workflow_service_list_cron_workflows_with_http_info(namespace, opts)
  data
end

#cron_workflow_service_list_cron_workflows_with_http_info(namespace, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflowList, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflowList data, response status code and response headers.

Parameters:

  • namespace
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :list_options_label_selector (String) —

    A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional.

  • :list_options_field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything. +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.

  • :list_options_allow_watch_bookmarks (BOOLEAN) —

    allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#39;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 (String) —

    resourceVersion sets a constraint on what resource versions a request may be served from. See kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +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 kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +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.

  • :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 &#x60;continue&#x60; 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 (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 &quot;next key&quot;. 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 (BOOLEAN) —

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. 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 &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;io.k8s.initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise. +optional

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 298

def cron_workflow_service_list_cron_workflows_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_list_cron_workflows ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_list_cron_workflows"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}'.sub('{' + 'namespace' + '}', namespace.to_s)

  # query parameters
  query_params = {}
  query_params[:'listOptions.labelSelector'] = opts[:'list_options_label_selector'] if !opts[:'list_options_label_selector'].nil?
  query_params[:'listOptions.fieldSelector'] = opts[:'list_options_field_selector'] if !opts[:'list_options_field_selector'].nil?
  query_params[:'listOptions.watch'] = opts[:'list_options_watch'] if !opts[:'list_options_watch'].nil?
  query_params[:'listOptions.allowWatchBookmarks'] = opts[:'list_options_allow_watch_bookmarks'] if !opts[:'list_options_allow_watch_bookmarks'].nil?
  query_params[:'listOptions.resourceVersion'] = opts[:'list_options_resource_version'] if !opts[:'list_options_resource_version'].nil?
  query_params[:'listOptions.resourceVersionMatch'] = opts[:'list_options_resource_version_match'] if !opts[:'list_options_resource_version_match'].nil?
  query_params[:'listOptions.timeoutSeconds'] = opts[:'list_options_timeout_seconds'] if !opts[:'list_options_timeout_seconds'].nil?
  query_params[:'listOptions.limit'] = opts[:'list_options_limit'] if !opts[:'list_options_limit'].nil?
  query_params[:'listOptions.continue'] = opts[:'list_options_continue'] if !opts[:'list_options_continue'].nil?
  query_params[:'listOptions.sendInitialEvents'] = opts[:'list_options_send_initial_events'] if !opts[:'list_options_send_initial_events'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflowList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_list_cron_workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_resume_cron_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflow

Parameters:

  • namespace
  • name
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



352
353
354
355
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 352

def cron_workflow_service_resume_cron_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = cron_workflow_service_resume_cron_workflow_with_http_info(namespace, name, body, opts)
  data
end

#cron_workflow_service_resume_cron_workflow_with_http_info(namespace, name, body, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflow data, response status code and response headers.

Parameters:

  • namespace
  • name
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 362

def cron_workflow_service_resume_cron_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_resume_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_resume_cron_workflow"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CronWorkflowServiceApi.cron_workflow_service_resume_cron_workflow"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CronWorkflowServiceApi.cron_workflow_service_resume_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}/{name}/resume'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_resume_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_suspend_cron_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflow

Parameters:

  • namespace
  • name
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



414
415
416
417
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 414

def cron_workflow_service_suspend_cron_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = cron_workflow_service_suspend_cron_workflow_with_http_info(namespace, name, body, opts)
  data
end

#cron_workflow_service_suspend_cron_workflow_with_http_info(namespace, name, body, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflow data, response status code and response headers.

Parameters:

  • namespace
  • name
  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 424

def cron_workflow_service_suspend_cron_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_suspend_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_suspend_cron_workflow"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CronWorkflowServiceApi.cron_workflow_service_suspend_cron_workflow"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CronWorkflowServiceApi.cron_workflow_service_suspend_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}/{name}/suspend'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_suspend_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cron_workflow_service_update_cron_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1CronWorkflow

Parameters:

  • namespace
  • name —

    DEPRECATED: This field is ignored.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 476

def cron_workflow_service_update_cron_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = cron_workflow_service_update_cron_workflow_with_http_info(namespace, name, body, opts)
  data
end

#cron_workflow_service_update_cron_workflow_with_http_info(namespace, name, body, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1CronWorkflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1CronWorkflow data, response status code and response headers.

Parameters:

  • namespace
  • name —

    DEPRECATED: This field is ignored.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/argo_workflows/api/cron_workflow_service_api.rb', line 486

def cron_workflow_service_update_cron_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CronWorkflowServiceApi.cron_workflow_service_update_cron_workflow ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling CronWorkflowServiceApi.cron_workflow_service_update_cron_workflow"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling CronWorkflowServiceApi.cron_workflow_service_update_cron_workflow"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CronWorkflowServiceApi.cron_workflow_service_update_cron_workflow"
  end
  # resource path
  local_var_path = '/api/v1/cron-workflows/{namespace}/{name}'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['BearerToken']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IoArgoprojWorkflowV1alpha1CronWorkflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CronWorkflowServiceApi#cron_workflow_service_update_cron_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end