Class: ArgoWorkflows::ArchivedWorkflowServiceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArchivedWorkflowServiceApi

Returns a new instance of ArchivedWorkflowServiceApi.



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

def api_client
  @api_client
end

Instance Method Details

#archived_workflow_service_delete_archived_workflow(uid, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1ArchivedWorkflowDeletedResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String)

Returns:



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

def archived_workflow_service_delete_archived_workflow(uid, opts = {})
  data, _status_code, _headers = archived_workflow_service_delete_archived_workflow_with_http_info(uid, opts)
  data
end

#archived_workflow_service_delete_archived_workflow_with_http_info(uid, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1ArchivedWorkflowDeletedResponse, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1ArchivedWorkflowDeletedResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String)

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
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 35

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

  # query parameters
  query_params = {}
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].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 => 'IoArgoprojWorkflowV1alpha1ArchivedWorkflowDeletedResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchivedWorkflowServiceApi#archived_workflow_service_delete_archived_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archived_workflow_service_get_archived_workflow(uid, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String)
  • :name (String)

Returns:



80
81
82
83
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 80

def archived_workflow_service_get_archived_workflow(uid, opts = {})
  data, _status_code, _headers = archived_workflow_service_get_archived_workflow_with_http_info(uid, opts)
  data
end

#archived_workflow_service_get_archived_workflow_with_http_info(uid, opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1Workflow, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String)
  • :name (String)

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 90

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

  # query parameters
  query_params = {}
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].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: ArchivedWorkflowServiceApi#archived_workflow_service_get_archived_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archived_workflow_service_list_archived_workflow_label_keys(opts = {}) ⇒ IoArgoprojWorkflowV1alpha1LabelKeys

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String)

Returns:



134
135
136
137
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 134

def archived_workflow_service_list_archived_workflow_label_keys(opts = {})
  data, _status_code, _headers = archived_workflow_service_list_archived_workflow_label_keys_with_http_info(opts)
  data
end

#archived_workflow_service_list_archived_workflow_label_keys_with_http_info(opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1LabelKeys, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1LabelKeys data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String)

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 142

def archived_workflow_service_list_archived_workflow_label_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchivedWorkflowServiceApi.archived_workflow_service_list_archived_workflow_label_keys ...'
  end
  # resource path
  local_var_path = '/api/v1/archived-workflows-label-keys'

  # query parameters
  query_params = {}
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].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 => 'IoArgoprojWorkflowV1alpha1LabelKeys')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchivedWorkflowServiceApi#archived_workflow_service_list_archived_workflow_label_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archived_workflow_service_list_archived_workflow_label_values(opts = {}) ⇒ IoArgoprojWorkflowV1alpha1LabelValues

Parameters:

  • 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

  • :namespace (String)

Returns:



191
192
193
194
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 191

def archived_workflow_service_list_archived_workflow_label_values(opts = {})
  data, _status_code, _headers = archived_workflow_service_list_archived_workflow_label_values_with_http_info(opts)
  data
end

#archived_workflow_service_list_archived_workflow_label_values_with_http_info(opts = {}) ⇒ Array<(IoArgoprojWorkflowV1alpha1LabelValues, Fixnum, Hash)>

Returns IoArgoprojWorkflowV1alpha1LabelValues data, response status code and response headers.

Parameters:

  • 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

  • :namespace (String)

Returns:



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 209

def archived_workflow_service_list_archived_workflow_label_values_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchivedWorkflowServiceApi.archived_workflow_service_list_archived_workflow_label_values ...'
  end
  # resource path
  local_var_path = '/api/v1/archived-workflows-label-values'

  # 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[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].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 => 'IoArgoprojWorkflowV1alpha1LabelValues')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchivedWorkflowServiceApi#archived_workflow_service_list_archived_workflow_label_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archived_workflow_service_list_archived_workflows(opts = {}) ⇒ IoArgoprojWorkflowV1alpha1WorkflowList

Parameters:

  • 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

  • :name_prefix (String)
  • :namespace (String)

Returns:



269
270
271
272
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 269

def archived_workflow_service_list_archived_workflows(opts = {})
  data, _status_code, _headers = archived_workflow_service_list_archived_workflows_with_http_info(opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1WorkflowList data, response status code and response headers.

Parameters:

  • 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

  • :name_prefix (String)
  • :namespace (String)

Returns:



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 288

def archived_workflow_service_list_archived_workflows_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchivedWorkflowServiceApi.archived_workflow_service_list_archived_workflows ...'
  end
  # resource path
  local_var_path = '/api/v1/archived-workflows'

  # 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[:'namePrefix'] = opts[:'name_prefix'] if !opts[:'name_prefix'].nil?
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].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: ArchivedWorkflowServiceApi#archived_workflow_service_list_archived_workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archived_workflow_service_resubmit_archived_workflow(uid, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



339
340
341
342
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 339

def archived_workflow_service_resubmit_archived_workflow(uid, body, opts = {})
  data, _status_code, _headers = archived_workflow_service_resubmit_archived_workflow_with_http_info(uid, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 348

def archived_workflow_service_resubmit_archived_workflow_with_http_info(uid, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchivedWorkflowServiceApi.archived_workflow_service_resubmit_archived_workflow ...'
  end
  # verify the required parameter 'uid' is set
  if @api_client.config.client_side_validation && uid.nil?
    fail ArgumentError, "Missing the required parameter 'uid' when calling ArchivedWorkflowServiceApi.archived_workflow_service_resubmit_archived_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 ArchivedWorkflowServiceApi.archived_workflow_service_resubmit_archived_workflow"
  end
  # resource path
  local_var_path = '/api/v1/archived-workflows/{uid}/resubmit'.sub('{' + 'uid' + '}', uid.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: ArchivedWorkflowServiceApi#archived_workflow_service_resubmit_archived_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archived_workflow_service_retry_archived_workflow(uid, body, opts = {}) ⇒ IoArgoprojWorkflowV1alpha1Workflow

Parameters:

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

    the optional parameters

Returns:



395
396
397
398
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 395

def archived_workflow_service_retry_archived_workflow(uid, body, opts = {})
  data, _status_code, _headers = archived_workflow_service_retry_archived_workflow_with_http_info(uid, body, opts)
  data
end

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

Returns IoArgoprojWorkflowV1alpha1Workflow data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/argo_workflows/api/archived_workflow_service_api.rb', line 404

def archived_workflow_service_retry_archived_workflow_with_http_info(uid, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ArchivedWorkflowServiceApi.archived_workflow_service_retry_archived_workflow ...'
  end
  # verify the required parameter 'uid' is set
  if @api_client.config.client_side_validation && uid.nil?
    fail ArgumentError, "Missing the required parameter 'uid' when calling ArchivedWorkflowServiceApi.archived_workflow_service_retry_archived_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 ArchivedWorkflowServiceApi.archived_workflow_service_retry_archived_workflow"
  end
  # resource path
  local_var_path = '/api/v1/archived-workflows/{uid}/retry'.sub('{' + 'uid' + '}', uid.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: ArchivedWorkflowServiceApi#archived_workflow_service_retry_archived_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end