Class: Kubernetes::BatchV1Api

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/api/batch_v1_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchV1Api 



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

def api_client
  @api_client
end

Instance Method Details

#create_namespaced_job(namespace, body, opts = {}) ⇒ V1Job

create a Job

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :pretty (String) —

    If 'true', then the output is pretty printed.

  • :dry_run (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



32
33
34
35
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 32

def create_namespaced_job(namespace, body, opts = {})
  data, _status_code, _headers = create_namespaced_job_with_http_info(namespace, body, opts)
  data
end

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

create a Job

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 46

def create_namespaced_job_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.create_namespaced_job ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.create_namespaced_job"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError,
          "Missing the required parameter 'body' when calling BatchV1Api.create_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs'.sub('{namespace}',
                                                                    namespace.to_s)

  # query parameters
  query_params = {}
  unless opts[:include_uninitialized].nil?
    query_params[:includeUninitialized] =
      opts[:include_uninitialized]
  end
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?

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

  # 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: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#create_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_collection_namespaced_job(namespace, opts = {}) ⇒ V1Status

delete collection of Job

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

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

  • :field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • :label_selector (String) —

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

  • :limit (Integer) —

    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.

  • :resource_version (String) —

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it&#39;s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • :timeout_seconds (Integer) —

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • :watch (BOOLEAN) —

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.



116
117
118
119
120
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 116

def delete_collection_namespaced_job(namespace, opts = {})
  data, _status_code, _headers = delete_collection_namespaced_job_with_http_info(namespace,
                                                                                 opts)
  data
end

#delete_collection_namespaced_job_with_http_info(namespace, opts = {}) ⇒ Array<(V1Status, Fixnum, Hash)>

delete collection of Job

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

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

  • :field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • :label_selector (String) —

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

  • :limit (Integer) —

    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.

  • :resource_version (String) —

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it&#39;s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • :timeout_seconds (Integer) —

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • :watch (BOOLEAN) —

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.



136
137
138
139
140
141
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 136

def delete_collection_namespaced_job_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.delete_collection_namespaced_job ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.delete_collection_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs'.sub('{namespace}',
                                                                    namespace.to_s)

  # query parameters
  query_params = {}
  unless opts[:include_uninitialized].nil?
    query_params[:includeUninitialized] =
      opts[:include_uninitialized]
  end
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?
  query_params[:watch] = opts[:watch] unless opts[:watch].nil?

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

  # 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: 'V1Status')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#delete_collection_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_namespaced_job(name, namespace, opts = {}) ⇒ V1Status

delete a Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :body (V1DeleteOptions)
  • :dry_run (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

  • :grace_period_seconds (Integer) —

    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.

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

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



205
206
207
208
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 205

def delete_namespaced_job(name, namespace, opts = {})
  data, _status_code, _headers = delete_namespaced_job_with_http_info(name, namespace, opts)
  data
end

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

delete a Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :body (V1DeleteOptions)
  • :dry_run (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

  • :grace_period_seconds (Integer) —

    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.

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

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



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 222

def delete_namespaced_job_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.delete_namespaced_job ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.delete_namespaced_job"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.delete_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  unless opts[:grace_period_seconds].nil?
    query_params[:gracePeriodSeconds] =
      opts[:grace_period_seconds]
  end
  unless opts[:orphan_dependents].nil?
    query_params[:orphanDependents] =
      opts[:orphan_dependents]
  end
  unless opts[:propagation_policy].nil?
    query_params[:propagationPolicy] =
      opts[:propagation_policy]
  end

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:body])
  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: 'V1Status')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#delete_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#get_api_resources(opts = {}) ⇒ V1APIResourceList

get available resources



291
292
293
294
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 291

def get_api_resources(opts = {})
  data, _status_code, _headers = get_api_resources_with_http_info(opts)
  data
end

#get_api_resources_with_http_info(_opts = {}) ⇒ Array<(V1APIResourceList, Fixnum, Hash)>

get available resources



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 300

def get_api_resources_with_http_info(_opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.get_api_resources ...'
  end
  # resource path
  local_var_path = '/apis/batch/v1/'

  # query parameters
  query_params = {}

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

  # 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: 'V1APIResourceList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#get_api_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_job_for_all_namespaces(opts = {}) ⇒ V1JobList

list or watch objects of kind Job

Options Hash (opts):

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

  • :field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :label_selector (String) —

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

  • :limit (Integer) —

    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.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :resource_version (String) —

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it&#39;s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • :timeout_seconds (Integer) —

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • :watch (BOOLEAN) —

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.



353
354
355
356
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 353

def list_job_for_all_namespaces(opts = {})
  data, _status_code, _headers = list_job_for_all_namespaces_with_http_info(opts)
  data
end

#list_job_for_all_namespaces_with_http_info(opts = {}) ⇒ Array<(V1JobList, Fixnum, Hash)>

list or watch objects of kind Job

Options Hash (opts):

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

  • :field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :label_selector (String) —

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

  • :limit (Integer) —

    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.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :resource_version (String) —

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it&#39;s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • :timeout_seconds (Integer) —

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • :watch (BOOLEAN) —

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 371

def list_job_for_all_namespaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.list_job_for_all_namespaces ...'
  end
  # resource path
  local_var_path = '/apis/batch/v1/jobs'

  # query parameters
  query_params = {}
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  unless opts[:include_uninitialized].nil?
    query_params[:includeUninitialized] =
      opts[:include_uninitialized]
  end
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?
  query_params[:watch] = opts[:watch] unless opts[:watch].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] =
    @api_client.select_header_accept(['application/json', 'application/yaml',
                                      'application/vnd.kubernetes.protobuf', 'application/json;stream=watch', 'application/vnd.kubernetes.protobuf;stream=watch'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['*/*'])

  # 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: 'V1JobList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#list_job_for_all_namespaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_namespaced_job(namespace, opts = {}) ⇒ V1JobList

list or watch objects of kind Job

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

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

  • :field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • :label_selector (String) —

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

  • :limit (Integer) —

    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.

  • :resource_version (String) —

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it&#39;s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • :timeout_seconds (Integer) —

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • :watch (BOOLEAN) —

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.



435
436
437
438
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 435

def list_namespaced_job(namespace, opts = {})
  data, _status_code, _headers = list_namespaced_job_with_http_info(namespace, opts)
  data
end

#list_namespaced_job_with_http_info(namespace, opts = {}) ⇒ Array<(V1JobList, Fixnum, Hash)>

list or watch objects of kind Job

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

    If true, partially initialized resources are included in the response.

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

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

  • :field_selector (String) —

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • :label_selector (String) —

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

  • :limit (Integer) —

    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.

  • :resource_version (String) —

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it&#39;s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

  • :timeout_seconds (Integer) —

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

  • :watch (BOOLEAN) —

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
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
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 454

def list_namespaced_job_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.list_namespaced_job ...'
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.list_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs'.sub('{namespace}',
                                                                    namespace.to_s)

  # query parameters
  query_params = {}
  unless opts[:include_uninitialized].nil?
    query_params[:includeUninitialized] =
      opts[:include_uninitialized]
  end
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?
  query_params[:watch] = opts[:watch] unless opts[:watch].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] =
    @api_client.select_header_accept(['application/json', 'application/yaml',
                                      'application/vnd.kubernetes.protobuf', 'application/json;stream=watch', 'application/vnd.kubernetes.protobuf;stream=watch'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['*/*'])

  # 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: 'V1JobList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#list_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_namespaced_job(name, namespace, body, opts = {}) ⇒ V1Job

partially update the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



520
521
522
523
524
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 520

def patch_namespaced_job(name, namespace, body, opts = {})
  data, _status_code, _headers = patch_namespaced_job_with_http_info(name, namespace, body,
                                                                     opts)
  data
end

#patch_namespaced_job_status(name, namespace, body, opts = {}) ⇒ V1Job

partially update status of the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



604
605
606
607
608
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 604

def patch_namespaced_job_status(name, namespace, body, opts = {})
  data, _status_code, _headers = patch_namespaced_job_status_with_http_info(name, namespace,
                                                                            body, opts)
  data
end

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

partially update status of the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



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
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 619

def patch_namespaced_job_status_with_http_info(name, namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.patch_namespaced_job_status ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.patch_namespaced_job_status"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.patch_namespaced_job_status"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError,
          "Missing the required parameter 'body' when calling BatchV1Api.patch_namespaced_job_status"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] =
    @api_client.select_header_accept(['application/json', 'application/yaml',
                                      'application/vnd.kubernetes.protobuf'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] =
    @api_client.select_header_content_type(['application/json-patch+json',
                                            'application/merge-patch+json', 'application/strategic-merge-patch+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(:PATCH, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#patch_namespaced_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

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

partially update the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



535
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
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 535

def patch_namespaced_job_with_http_info(name, namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.patch_namespaced_job ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.patch_namespaced_job"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.patch_namespaced_job"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError,
          "Missing the required parameter 'body' when calling BatchV1Api.patch_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] =
    @api_client.select_header_accept(['application/json', 'application/yaml',
                                      'application/vnd.kubernetes.protobuf'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] =
    @api_client.select_header_content_type(['application/json-patch+json',
                                            'application/merge-patch+json', 'application/strategic-merge-patch+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(:PATCH, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#patch_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_namespaced_job(name, namespace, opts = {}) ⇒ V1Job

read the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :exact (BOOLEAN) —

    Should the export be exact. Exact export maintains cluster-specific fields like &#39;Namespace&#39;.

  • :export (BOOLEAN) —

    Should this value be exported. Export strips fields that a user can not specify.



688
689
690
691
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 688

def read_namespaced_job(name, namespace, opts = {})
  data, _status_code, _headers = read_namespaced_job_with_http_info(name, namespace, opts)
  data
end

#read_namespaced_job_status(name, namespace, opts = {}) ⇒ V1Job

read status of the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.



763
764
765
766
767
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 763

def read_namespaced_job_status(name, namespace, opts = {})
  data, _status_code, _headers = read_namespaced_job_status_with_http_info(name, namespace,
                                                                           opts)
  data
end

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

read status of the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.



776
777
778
779
780
781
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
825
826
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 776

def read_namespaced_job_status_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.read_namespaced_job_status ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.read_namespaced_job_status"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.read_namespaced_job_status"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?

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

  # 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: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#read_namespaced_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

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

read the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :exact (BOOLEAN) —

    Should the export be exact. Exact export maintains cluster-specific fields like &#39;Namespace&#39;.

  • :export (BOOLEAN) —

    Should this value be exported. Export strips fields that a user can not specify.



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
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
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 702

def read_namespaced_job_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.read_namespaced_job ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.read_namespaced_job"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.read_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:exact] = opts[:exact] unless opts[:exact].nil?
  query_params[:export] = opts[:export] unless opts[:export].nil?

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

  # 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: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#read_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_namespaced_job(name, namespace, body, opts = {}) ⇒ V1Job

replace the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



837
838
839
840
841
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 837

def replace_namespaced_job(name, namespace, body, opts = {})
  data, _status_code, _headers = replace_namespaced_job_with_http_info(name, namespace, body,
                                                                       opts)
  data
end

#replace_namespaced_job_status(name, namespace, body, opts = {}) ⇒ V1Job

replace status of the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



919
920
921
922
923
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 919

def replace_namespaced_job_status(name, namespace, body, opts = {})
  data, _status_code, _headers = replace_namespaced_job_status_with_http_info(name, namespace,
                                                                              body, opts)
  data
end

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

replace status of the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 934

def replace_namespaced_job_status_with_http_info(name, namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.replace_namespaced_job_status ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.replace_namespaced_job_status"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.replace_namespaced_job_status"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError,
          "Missing the required parameter 'body' when calling BatchV1Api.replace_namespaced_job_status"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?

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

  # 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: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#replace_namespaced_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

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

replace the specified Job

Options Hash (opts):

  • :pretty (String) —

    If &#39;true&#39;, then the output is pretty printed.

  • :dry_run (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



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
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/kubernetes/api/batch_v1_api.rb', line 852

def replace_namespaced_job_with_http_info(name, namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchV1Api.replace_namespaced_job ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    raise ArgumentError,
          "Missing the required parameter 'name' when calling BatchV1Api.replace_namespaced_job"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    raise ArgumentError,
          "Missing the required parameter 'namespace' when calling BatchV1Api.replace_namespaced_job"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    raise ArgumentError,
          "Missing the required parameter 'body' when calling BatchV1Api.replace_namespaced_job"
  end

  # resource path
  local_var_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}'.sub('{name}', name.to_s).sub(
    '{namespace}', namespace.to_s
  )

  # query parameters
  query_params = {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?

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

  # 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: 'V1Job')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchV1Api#replace_namespaced_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end