Class: ArgoWorkflows::WorkflowServiceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowServiceApi

Returns a new instance of WorkflowServiceApi.



19
20
21
 
# File 'lib/argo_workflows/api/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/workflow_service_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#workflow_service_create_workflow(namespace, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



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

def workflow_service_create_workflow(namespace, body, opts = {})
  data, _status_code, _headers = workflow_service_create_workflow_with_http_info(namespace, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow 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/workflow_service_api.rb', line 35

def workflow_service_create_workflow_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_create_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 WorkflowServiceApi.workflow_service_create_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 WorkflowServiceApi.workflow_service_create_workflow"
  end
  # resource path
  local_var_path = '/api/v1/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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_create_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_delete_workflow(namespace, name, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1WorkflowDeleteResponse

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.

  • :force (BOOLEAN)

Returns:



89
90
91
92
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 89

def workflow_service_delete_workflow(namespace, name, opts = {})
  data, _status_code, _headers = workflow_service_delete_workflow_with_http_info(namespace, name, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1WorkflowDeleteResponse 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.

  • :force (BOOLEAN)

Returns:



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
152
153
154
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 105

def workflow_service_delete_workflow_with_http_info(namespace, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_delete_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 WorkflowServiceApi.workflow_service_delete_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 WorkflowServiceApi.workflow_service_delete_workflow"
  end
  # resource path
  local_var_path = '/api/v1/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?
  query_params[:'force'] = opts[:'force'] if !opts[:'force'].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 => 'IoArgoprojWorkflowV1alpha1WorkflowDeleteResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_delete_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_get_workflow(namespace, name, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :fields (String) —

    Fields to be included or excluded in the response. e.g. &quot;spec,status.phase&quot;, &quot;-status.nodes&quot;.

Returns:



161
162
163
164
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 161

def workflow_service_get_workflow(namespace, name, opts = {})
  data, _status_code, _headers = workflow_service_get_workflow_with_http_info(namespace, name, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :fields (String) —

    Fields to be included or excluded in the response. e.g. &quot;spec,status.phase&quot;, &quot;-status.nodes&quot;.

Returns:



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
211
212
213
214
215
216
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 172

def workflow_service_get_workflow_with_http_info(namespace, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_get_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 WorkflowServiceApi.workflow_service_get_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 WorkflowServiceApi.workflow_service_get_workflow"
  end
  # resource path
  local_var_path = '/api/v1/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?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_get_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_lint_workflow(namespace, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 221

def workflow_service_lint_workflow(namespace, body, opts = {})
  data, _status_code, _headers = workflow_service_lint_workflow_with_http_info(namespace, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



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
267
268
269
270
271
272
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 230

def workflow_service_lint_workflow_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_lint_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 WorkflowServiceApi.workflow_service_lint_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 WorkflowServiceApi.workflow_service_lint_workflow"
  end
  # resource path
  local_var_path = '/api/v1/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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_lint_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_list_workflows(namespace, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1WorkflowList

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

  • :fields (String) —

    Fields to be included or excluded in the response. e.g. &quot;items.spec,items.status.phase&quot;, &quot;-items.status.nodes&quot;.

  • :name_filter (String) —

    Filter type used for name filtering. Exact | Contains | Prefix. Default to Exact.

Returns:



288
289
290
291
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 288

def workflow_service_list_workflows(namespace, opts = {})
  data, _status_code, _headers = workflow_service_list_workflows_with_http_info(namespace, opts)
  data
end

#workflow_service_list_workflows_with_http_info(namespace, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1WorkflowList, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1WorkflowList 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

  • :fields (String) —

    Fields to be included or excluded in the response. e.g. &quot;items.spec,items.status.phase&quot;, &quot;-items.status.nodes&quot;.

  • :name_filter (String) —

    Filter type used for name filtering. Exact | Contains | Prefix. Default to Exact.

Returns:



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
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 308

def workflow_service_list_workflows_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_list_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 WorkflowServiceApi.workflow_service_list_workflows"
  end
  # resource path
  local_var_path = '/api/v1/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?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'nameFilter'] = opts[:'name_filter'] if !opts[:'name_filter'].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 => 'IoArgoprojWorkflowV1alpha1WorkflowList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_list_workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_pod_logs(namespace, name, pod_name, opts = {}) ⇒ StreamResultOfIoArgoprojWorkflowV1alpha1LogEntry

DEPRECATED: Cannot work via HTTP if podName is an empty string. Use WorkflowLogs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :log_options_container (String) —

    The container for which to stream logs. Defaults to only container if there is one container in the pod. +optional.

  • :log_options_follow (BOOLEAN) —

    Follow the log stream of the pod. Defaults to false. +optional.

  • :log_options_previous (BOOLEAN) —

    Return previous terminated container logs. Defaults to false. +optional.

  • :log_options_since_seconds (String) —

    A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +optional.

  • :log_options_since_time_seconds (String) —

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

  • :log_options_since_time_nanos (Integer) —

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

  • :log_options_timestamps (BOOLEAN) —

    If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +optional.

  • :log_options_tail_lines (String) —

    If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +optional.

  • :log_options_limit_bytes (String) —

    If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +optional.

  • :log_options_insecure_skip_tls_verify_backend (BOOLEAN) —

    insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver&#39;s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +optional.

  • :grep (String)
  • :selector (String)

Returns:



377
378
379
380
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 377

def workflow_service_pod_logs(namespace, name, pod_name, opts = {})
  data, _status_code, _headers = workflow_service_pod_logs_with_http_info(namespace, name, pod_name, opts)
  data
end

#workflow_service_pod_logs_with_http_info(namespace, name, pod_name, opts = {}) ⇒ Array<(StreamResultOfIoArgoprojWorkflowV1alpha1LogEntry, Fixnum, Hash)>

DEPRECATED: Cannot work via HTTP if podName is an empty string. Use WorkflowLogs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :log_options_container (String) —

    The container for which to stream logs. Defaults to only container if there is one container in the pod. +optional.

  • :log_options_follow (BOOLEAN) —

    Follow the log stream of the pod. Defaults to false. +optional.

  • :log_options_previous (BOOLEAN) —

    Return previous terminated container logs. Defaults to false. +optional.

  • :log_options_since_seconds (String) —

    A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +optional.

  • :log_options_since_time_seconds (String) —

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

  • :log_options_since_time_nanos (Integer) —

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

  • :log_options_timestamps (BOOLEAN) —

    If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +optional.

  • :log_options_tail_lines (String) —

    If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +optional.

  • :log_options_limit_bytes (String) —

    If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +optional.

  • :log_options_insecure_skip_tls_verify_backend (BOOLEAN) —

    insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver&#39;s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +optional.

  • :grep (String)
  • :selector (String)

Returns:



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
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
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 400

def workflow_service_pod_logs_with_http_info(namespace, name, pod_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_pod_logs ...'
  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 WorkflowServiceApi.workflow_service_pod_logs"
  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 WorkflowServiceApi.workflow_service_pod_logs"
  end
  # verify the required parameter 'pod_name' is set
  if @api_client.config.client_side_validation && pod_name.nil?
    fail ArgumentError, "Missing the required parameter 'pod_name' when calling WorkflowServiceApi.workflow_service_pod_logs"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/{podName}/log'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s).sub('{' + 'podName' + '}', pod_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'logOptions.container'] = opts[:'log_options_container'] if !opts[:'log_options_container'].nil?
  query_params[:'logOptions.follow'] = opts[:'log_options_follow'] if !opts[:'log_options_follow'].nil?
  query_params[:'logOptions.previous'] = opts[:'log_options_previous'] if !opts[:'log_options_previous'].nil?
  query_params[:'logOptions.sinceSeconds'] = opts[:'log_options_since_seconds'] if !opts[:'log_options_since_seconds'].nil?
  query_params[:'logOptions.sinceTime.seconds'] = opts[:'log_options_since_time_seconds'] if !opts[:'log_options_since_time_seconds'].nil?
  query_params[:'logOptions.sinceTime.nanos'] = opts[:'log_options_since_time_nanos'] if !opts[:'log_options_since_time_nanos'].nil?
  query_params[:'logOptions.timestamps'] = opts[:'log_options_timestamps'] if !opts[:'log_options_timestamps'].nil?
  query_params[:'logOptions.tailLines'] = opts[:'log_options_tail_lines'] if !opts[:'log_options_tail_lines'].nil?
  query_params[:'logOptions.limitBytes'] = opts[:'log_options_limit_bytes'] if !opts[:'log_options_limit_bytes'].nil?
  query_params[:'logOptions.insecureSkipTLSVerifyBackend'] = opts[:'log_options_insecure_skip_tls_verify_backend'] if !opts[:'log_options_insecure_skip_tls_verify_backend'].nil?
  query_params[:'grep'] = opts[:'grep'] if !opts[:'grep'].nil?
  query_params[:'selector'] = opts[:'selector'] if !opts[:'selector'].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 => 'StreamResultOfIoArgoprojWorkflowV1alpha1LogEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_pod_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_resubmit_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



464
465
466
467
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 464

def workflow_service_resubmit_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_resubmit_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



474
475
476
477
478
479
480
481
482
483
484
485
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
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 474

def workflow_service_resubmit_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_resubmit_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 WorkflowServiceApi.workflow_service_resubmit_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 WorkflowServiceApi.workflow_service_resubmit_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 WorkflowServiceApi.workflow_service_resubmit_workflow"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/resubmit'.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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_resubmit_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_resume_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



526
527
528
529
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 526

def workflow_service_resume_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_resume_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 536

def workflow_service_resume_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_resume_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 WorkflowServiceApi.workflow_service_resume_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 WorkflowServiceApi.workflow_service_resume_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 WorkflowServiceApi.workflow_service_resume_workflow"
  end
  # resource path
  local_var_path = '/api/v1/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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_resume_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_retry_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



588
589
590
591
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 588

def workflow_service_retry_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_retry_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 598

def workflow_service_retry_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_retry_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 WorkflowServiceApi.workflow_service_retry_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 WorkflowServiceApi.workflow_service_retry_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 WorkflowServiceApi.workflow_service_retry_workflow"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/retry'.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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_retry_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_set_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



650
651
652
653
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 650

def workflow_service_set_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_set_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 660

def workflow_service_set_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_set_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 WorkflowServiceApi.workflow_service_set_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 WorkflowServiceApi.workflow_service_set_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 WorkflowServiceApi.workflow_service_set_workflow"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/set'.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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_set_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_stop_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



712
713
714
715
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 712

def workflow_service_stop_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_stop_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 722

def workflow_service_stop_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_stop_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 WorkflowServiceApi.workflow_service_stop_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 WorkflowServiceApi.workflow_service_stop_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 WorkflowServiceApi.workflow_service_stop_workflow"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/stop'.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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_stop_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_submit_workflow(namespace, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



773
774
775
776
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 773

def workflow_service_submit_workflow(namespace, body, opts = {})
  data, _status_code, _headers = workflow_service_submit_workflow_with_http_info(namespace, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 782

def workflow_service_submit_workflow_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_submit_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 WorkflowServiceApi.workflow_service_submit_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 WorkflowServiceApi.workflow_service_submit_workflow"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/submit'.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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_submit_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_suspend_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



830
831
832
833
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 830

def workflow_service_suspend_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_suspend_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 840

def workflow_service_suspend_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_suspend_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 WorkflowServiceApi.workflow_service_suspend_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 WorkflowServiceApi.workflow_service_suspend_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 WorkflowServiceApi.workflow_service_suspend_workflow"
  end
  # resource path
  local_var_path = '/api/v1/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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_suspend_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_terminate_workflow(namespace, name, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



892
893
894
895
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 892

def workflow_service_terminate_workflow(namespace, name, body, opts = {})
  data, _status_code, _headers = workflow_service_terminate_workflow_with_http_info(namespace, name, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 902

def workflow_service_terminate_workflow_with_http_info(namespace, name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_terminate_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 WorkflowServiceApi.workflow_service_terminate_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 WorkflowServiceApi.workflow_service_terminate_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 WorkflowServiceApi.workflow_service_terminate_workflow"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/terminate'.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 => 'IoArgoprojWorkflowV1alpha1Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_terminate_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_watch_events(namespace, opts = {}) ⇒ StreamResultOfIoK8sApiCoreV1Event

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:



962
963
964
965
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 962

def workflow_service_watch_events(namespace, opts = {})
  data, _status_code, _headers = workflow_service_watch_events_with_http_info(namespace, opts)
  data
end

#workflow_service_watch_events_with_http_info(namespace, opts = {}) ⇒ Array<(StreamResultOfIoK8sApiCoreV1Event, Fixnum, Hash)>

Returns StreamResultOfIoK8sApiCoreV1Event 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:



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 980

def workflow_service_watch_events_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_watch_events ...'
  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 WorkflowServiceApi.workflow_service_watch_events"
  end
  # resource path
  local_var_path = '/api/v1/stream/events/{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 => 'StreamResultOfIoK8sApiCoreV1Event')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_watch_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_watch_workflows(namespace, opts = {}) ⇒ StreamResultOfIoArgoprojWorkflowV1alpha1WorkflowWatchEvent

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

  • :fields (String)

Returns:



1043
1044
1045
1046
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 1043

def workflow_service_watch_workflows(namespace, opts = {})
  data, _status_code, _headers = workflow_service_watch_workflows_with_http_info(namespace, opts)
  data
end

#workflow_service_watch_workflows_with_http_info(namespace, opts = {}) ⇒ Array<(StreamResultOfIoArgoprojWorkflowV1alpha1WorkflowWatchEvent, Fixnum, Hash)>

Returns StreamResultOfIoArgoprojWorkflowV1alpha1WorkflowWatchEvent 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

  • :fields (String)

Returns:



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 1062

def workflow_service_watch_workflows_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_watch_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 WorkflowServiceApi.workflow_service_watch_workflows"
  end
  # resource path
  local_var_path = '/api/v1/workflow-events/{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?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 => 'StreamResultOfIoArgoprojWorkflowV1alpha1WorkflowWatchEvent')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_watch_workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workflow_service_workflow_logs(namespace, name, opts = {}) ⇒ StreamResultOfIoArgoprojWorkflowV1alpha1LogEntry

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pod_name (String)
  • :log_options_container (String) —

    The container for which to stream logs. Defaults to only container if there is one container in the pod. +optional.

  • :log_options_follow (BOOLEAN) —

    Follow the log stream of the pod. Defaults to false. +optional.

  • :log_options_previous (BOOLEAN) —

    Return previous terminated container logs. Defaults to false. +optional.

  • :log_options_since_seconds (String) —

    A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +optional.

  • :log_options_since_time_seconds (String) —

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

  • :log_options_since_time_nanos (Integer) —

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

  • :log_options_timestamps (BOOLEAN) —

    If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +optional.

  • :log_options_tail_lines (String) —

    If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +optional.

  • :log_options_limit_bytes (String) —

    If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +optional.

  • :log_options_insecure_skip_tls_verify_backend (BOOLEAN) —

    insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver&#39;s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +optional.

  • :grep (String)
  • :selector (String)

Returns:



1129
1130
1131
1132
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 1129

def workflow_service_workflow_logs(namespace, name, opts = {})
  data, _status_code, _headers = workflow_service_workflow_logs_with_http_info(namespace, name, opts)
  data
end

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

Returns StreamResultOfIoArgoprojWorkflowV1alpha1LogEntry data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pod_name (String)
  • :log_options_container (String) —

    The container for which to stream logs. Defaults to only container if there is one container in the pod. +optional.

  • :log_options_follow (BOOLEAN) —

    Follow the log stream of the pod. Defaults to false. +optional.

  • :log_options_previous (BOOLEAN) —

    Return previous terminated container logs. Defaults to false. +optional.

  • :log_options_since_seconds (String) —

    A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +optional.

  • :log_options_since_time_seconds (String) —

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

  • :log_options_since_time_nanos (Integer) —

    Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.

  • :log_options_timestamps (BOOLEAN) —

    If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +optional.

  • :log_options_tail_lines (String) —

    If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +optional.

  • :log_options_limit_bytes (String) —

    If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +optional.

  • :log_options_insecure_skip_tls_verify_backend (BOOLEAN) —

    insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver&#39;s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +optional.

  • :grep (String)
  • :selector (String)

Returns:



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/argo_workflows/api/workflow_service_api.rb', line 1151

def workflow_service_workflow_logs_with_http_info(namespace, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowServiceApi.workflow_service_workflow_logs ...'
  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 WorkflowServiceApi.workflow_service_workflow_logs"
  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 WorkflowServiceApi.workflow_service_workflow_logs"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{namespace}/{name}/log'.sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}
  query_params[:'podName'] = opts[:'pod_name'] if !opts[:'pod_name'].nil?
  query_params[:'logOptions.container'] = opts[:'log_options_container'] if !opts[:'log_options_container'].nil?
  query_params[:'logOptions.follow'] = opts[:'log_options_follow'] if !opts[:'log_options_follow'].nil?
  query_params[:'logOptions.previous'] = opts[:'log_options_previous'] if !opts[:'log_options_previous'].nil?
  query_params[:'logOptions.sinceSeconds'] = opts[:'log_options_since_seconds'] if !opts[:'log_options_since_seconds'].nil?
  query_params[:'logOptions.sinceTime.seconds'] = opts[:'log_options_since_time_seconds'] if !opts[:'log_options_since_time_seconds'].nil?
  query_params[:'logOptions.sinceTime.nanos'] = opts[:'log_options_since_time_nanos'] if !opts[:'log_options_since_time_nanos'].nil?
  query_params[:'logOptions.timestamps'] = opts[:'log_options_timestamps'] if !opts[:'log_options_timestamps'].nil?
  query_params[:'logOptions.tailLines'] = opts[:'log_options_tail_lines'] if !opts[:'log_options_tail_lines'].nil?
  query_params[:'logOptions.limitBytes'] = opts[:'log_options_limit_bytes'] if !opts[:'log_options_limit_bytes'].nil?
  query_params[:'logOptions.insecureSkipTLSVerifyBackend'] = opts[:'log_options_insecure_skip_tls_verify_backend'] if !opts[:'log_options_insecure_skip_tls_verify_backend'].nil?
  query_params[:'grep'] = opts[:'grep'] if !opts[:'grep'].nil?
  query_params[:'selector'] = opts[:'selector'] if !opts[:'selector'].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 => 'StreamResultOfIoArgoprojWorkflowV1alpha1LogEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowServiceApi#workflow_service_workflow_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end