Class: Zilla::StorageV1Api

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/api/storage_v1_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StorageV1Api

Returns a new instance of StorageV1Api.



19
20
21
# File 'lib/zilla/api/storage_v1_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/zilla/api/storage_v1_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_storage_v1_csi_driver(body, opts = {}) ⇒ IoK8sApiStorageV1CSIDriver

create a CSIDriver

Parameters:

Options Hash (opts):

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the `ServerSideFieldValidation` feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the `ServerSideFieldValidation` feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the `ServerSideFieldValidation` feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



31
32
33
34
# File 'lib/zilla/api/storage_v1_api.rb', line 31

def create_storage_v1_csi_driver(body, opts = {})
  data, _status_code, _headers = create_storage_v1_csi_driver_with_http_info(body, opts)
  data
end

#create_storage_v1_csi_driver_with_http_info(body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>

create a CSIDriver

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

  • (Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>)

    IoK8sApiStorageV1CSIDriver data, response status code and response headers



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/zilla/api/storage_v1_api.rb', line 44

def create_storage_v1_csi_driver_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.create_storage_v1_csi_driver ...'
  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 StorageV1Api.create_storage_v1_csi_driver"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIDriver'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.create_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#create_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#create_storage_v1_csi_node(body, opts = {}) ⇒ IoK8sApiStorageV1CSINode

create a CSINode

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



108
109
110
111
# File 'lib/zilla/api/storage_v1_api.rb', line 108

def create_storage_v1_csi_node(body, opts = {})
  data, _status_code, _headers = create_storage_v1_csi_node_with_http_info(body, opts)
  data
end

#create_storage_v1_csi_node_with_http_info(body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>

create a CSINode

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

  • (Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>)

    IoK8sApiStorageV1CSINode data, response status code and response headers



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/zilla/api/storage_v1_api.rb', line 121

def create_storage_v1_csi_node_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.create_storage_v1_csi_node ...'
  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 StorageV1Api.create_storage_v1_csi_node"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSINode'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.create_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#create_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#create_storage_v1_namespaced_csi_storage_capacity(namespace, body, opts = {}) ⇒ IoK8sApiStorageV1CSIStorageCapacity

create a CSIStorageCapacity

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



186
187
188
189
190
# File 'lib/zilla/api/storage_v1_api.rb', line 186

def create_storage_v1_namespaced_csi_storage_capacity(namespace, body, opts = {})
  data, _status_code, _headers = create_storage_v1_namespaced_csi_storage_capacity_with_http_info(namespace, body,
                                                                                                  opts)
  data
end

#create_storage_v1_namespaced_csi_storage_capacity_with_http_info(namespace, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIStorageCapacity, Integer, Hash)>

create a CSIStorageCapacity

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



201
202
203
204
205
206
207
208
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
255
256
257
258
259
260
261
262
# File 'lib/zilla/api/storage_v1_api.rb', line 201

def create_storage_v1_namespaced_csi_storage_capacity_with_http_info(namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.create_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.create_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.create_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities'.sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIStorageCapacity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.create_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#create_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#create_storage_v1_storage_class(body, opts = {}) ⇒ IoK8sApiStorageV1StorageClass

create a StorageClass

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



272
273
274
275
# File 'lib/zilla/api/storage_v1_api.rb', line 272

def create_storage_v1_storage_class(body, opts = {})
  data, _status_code, _headers = create_storage_v1_storage_class_with_http_info(body, opts)
  data
end

#create_storage_v1_storage_class_with_http_info(body, opts = {}) ⇒ Array<(IoK8sApiStorageV1StorageClass, Integer, Hash)>

create a StorageClass

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



285
286
287
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
335
336
337
338
339
# File 'lib/zilla/api/storage_v1_api.rb', line 285

def create_storage_v1_storage_class_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.create_storage_v1_storage_class ...'
  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 StorageV1Api.create_storage_v1_storage_class"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1StorageClass'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.create_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#create_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#create_storage_v1_volume_attachment(body, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

create a VolumeAttachment

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



349
350
351
352
# File 'lib/zilla/api/storage_v1_api.rb', line 349

def create_storage_v1_volume_attachment(body, opts = {})
  data, _status_code, _headers = create_storage_v1_volume_attachment_with_http_info(body, opts)
  data
end

#create_storage_v1_volume_attachment_with_http_info(body, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

create a VolumeAttachment

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



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

def create_storage_v1_volume_attachment_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.create_storage_v1_volume_attachment ...'
  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 StorageV1Api.create_storage_v1_volume_attachment"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.create_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#create_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_collection_csi_driver(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete collection of CSIDriver

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



434
435
436
437
# File 'lib/zilla/api/storage_v1_api.rb', line 434

def delete_storage_v1_collection_csi_driver(opts = {})
  data, _status_code, _headers = delete_storage_v1_collection_csi_driver_with_http_info(opts)
  data
end

#delete_storage_v1_collection_csi_driver_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1Status, Integer, Hash)>

delete collection of CSIDriver

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



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
510
511
# File 'lib/zilla/api/storage_v1_api.rb', line 455

def delete_storage_v1_collection_csi_driver_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_collection_csi_driver ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:gracePeriodSeconds] = opts[:grace_period_seconds] unless opts[:grace_period_seconds].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:orphanDependents] = opts[:orphan_dependents] unless opts[:orphan_dependents].nil?
  query_params[:propagationPolicy] = opts[:propagation_policy] unless opts[:propagation_policy].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1Status'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_collection_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_collection_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_collection_csi_node(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete collection of CSINode

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



529
530
531
532
# File 'lib/zilla/api/storage_v1_api.rb', line 529

def delete_storage_v1_collection_csi_node(opts = {})
  data, _status_code, _headers = delete_storage_v1_collection_csi_node_with_http_info(opts)
  data
end

#delete_storage_v1_collection_csi_node_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1Status, Integer, Hash)>

delete collection of CSINode

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



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
594
595
596
597
598
599
600
601
602
603
604
605
606
# File 'lib/zilla/api/storage_v1_api.rb', line 550

def delete_storage_v1_collection_csi_node_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_collection_csi_node ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:gracePeriodSeconds] = opts[:grace_period_seconds] unless opts[:grace_period_seconds].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:orphanDependents] = opts[:orphan_dependents] unless opts[:orphan_dependents].nil?
  query_params[:propagationPolicy] = opts[:propagation_policy] unless opts[:propagation_policy].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1Status'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_collection_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_collection_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_collection_namespaced_csi_storage_capacity(namespace, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete collection of CSIStorageCapacity

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



625
626
627
628
629
630
# File 'lib/zilla/api/storage_v1_api.rb', line 625

def delete_storage_v1_collection_namespaced_csi_storage_capacity(namespace, opts = {})
  data, _status_code, _headers = delete_storage_v1_collection_namespaced_csi_storage_capacity_with_http_info(
    namespace, opts
  )
  data
end

#delete_storage_v1_collection_namespaced_csi_storage_capacity_with_http_info(namespace, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1Status, Integer, Hash)>

delete collection of CSIStorageCapacity

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
# File 'lib/zilla/api/storage_v1_api.rb', line 649

def delete_storage_v1_collection_namespaced_csi_storage_capacity_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_collection_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.delete_storage_v1_collection_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities'.sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:gracePeriodSeconds] = opts[:grace_period_seconds] unless opts[:grace_period_seconds].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:orphanDependents] = opts[:orphan_dependents] unless opts[:orphan_dependents].nil?
  query_params[:propagationPolicy] = opts[:propagation_policy] unless opts[:propagation_policy].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1Status'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_collection_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_collection_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_collection_storage_class(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete collection of StorageClass

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



731
732
733
734
# File 'lib/zilla/api/storage_v1_api.rb', line 731

def delete_storage_v1_collection_storage_class(opts = {})
  data, _status_code, _headers = delete_storage_v1_collection_storage_class_with_http_info(opts)
  data
end

#delete_storage_v1_collection_storage_class_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1Status, Integer, Hash)>

delete collection of StorageClass

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
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
# File 'lib/zilla/api/storage_v1_api.rb', line 752

def delete_storage_v1_collection_storage_class_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_collection_storage_class ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:gracePeriodSeconds] = opts[:grace_period_seconds] unless opts[:grace_period_seconds].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:orphanDependents] = opts[:orphan_dependents] unless opts[:orphan_dependents].nil?
  query_params[:propagationPolicy] = opts[:propagation_policy] unless opts[:propagation_policy].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1Status'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_collection_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_collection_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_collection_volume_attachment(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete collection of VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



826
827
828
829
# File 'lib/zilla/api/storage_v1_api.rb', line 826

def delete_storage_v1_collection_volume_attachment(opts = {})
  data, _status_code, _headers = delete_storage_v1_collection_volume_attachment_with_http_info(opts)
  data
end

#delete_storage_v1_collection_volume_attachment_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1Status, Integer, Hash)>

delete collection of VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :field_selector (String)

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

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

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

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

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

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

  • :timeout_seconds (Integer)

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
# File 'lib/zilla/api/storage_v1_api.rb', line 847

def delete_storage_v1_collection_volume_attachment_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_collection_volume_attachment ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:continue] = opts[:continue] unless opts[:continue].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldSelector] = opts[:field_selector] unless opts[:field_selector].nil?
  query_params[:gracePeriodSeconds] = opts[:grace_period_seconds] unless opts[:grace_period_seconds].nil?
  query_params[:labelSelector] = opts[:label_selector] unless opts[:label_selector].nil?
  query_params[:limit] = opts[:limit] unless opts[:limit].nil?
  query_params[:orphanDependents] = opts[:orphan_dependents] unless opts[:orphan_dependents].nil?
  query_params[:propagationPolicy] = opts[:propagation_policy] unless opts[:propagation_policy].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].nil?
  query_params[:timeoutSeconds] = opts[:timeout_seconds] unless opts[:timeout_seconds].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1Status'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_collection_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_collection_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_csi_driver(name, opts = {}) ⇒ IoK8sApiStorageV1CSIDriver

delete a CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



915
916
917
918
# File 'lib/zilla/api/storage_v1_api.rb', line 915

def delete_storage_v1_csi_driver(name, opts = {})
  data, _status_code, _headers = delete_storage_v1_csi_driver_with_http_info(name, opts)
  data
end

#delete_storage_v1_csi_driver_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>

delete a CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:

  • (Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>)

    IoK8sApiStorageV1CSIDriver data, response status code and response headers



930
931
932
933
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
# File 'lib/zilla/api/storage_v1_api.rb', line 930

def delete_storage_v1_csi_driver_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_csi_driver ...'
  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 StorageV1Api.delete_storage_v1_csi_driver"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIDriver'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_csi_node(name, opts = {}) ⇒ IoK8sApiStorageV1CSINode

delete a CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



997
998
999
1000
# File 'lib/zilla/api/storage_v1_api.rb', line 997

def delete_storage_v1_csi_node(name, opts = {})
  data, _status_code, _headers = delete_storage_v1_csi_node_with_http_info(name, opts)
  data
end

#delete_storage_v1_csi_node_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>

delete a CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:

  • (Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>)

    IoK8sApiStorageV1CSINode data, response status code and response headers



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'lib/zilla/api/storage_v1_api.rb', line 1012

def delete_storage_v1_csi_node_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_csi_node ...'
  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 StorageV1Api.delete_storage_v1_csi_node"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSINode'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_namespaced_csi_storage_capacity(name, namespace, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete a CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



1080
1081
1082
1083
1084
# File 'lib/zilla/api/storage_v1_api.rb', line 1080

def delete_storage_v1_namespaced_csi_storage_capacity(name, namespace, opts = {})
  data, _status_code, _headers = delete_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace,
                                                                                                  opts)
  data
end

#delete_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1Status, Integer, Hash)>

delete a CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
# File 'lib/zilla/api/storage_v1_api.rb', line 1097

def delete_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.delete_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.delete_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}'.sub('{name}', CGI.escape(name.to_s)).sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1Status'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_storage_class(name, opts = {}) ⇒ IoK8sApiStorageV1StorageClass

delete a StorageClass

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



1171
1172
1173
1174
# File 'lib/zilla/api/storage_v1_api.rb', line 1171

def delete_storage_v1_storage_class(name, opts = {})
  data, _status_code, _headers = delete_storage_v1_storage_class_with_http_info(name, opts)
  data
end

#delete_storage_v1_storage_class_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1StorageClass, Integer, Hash)>

delete a StorageClass

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
# File 'lib/zilla/api/storage_v1_api.rb', line 1186

def delete_storage_v1_storage_class_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_storage_class ...'
  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 StorageV1Api.delete_storage_v1_storage_class"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1StorageClass'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_storage_v1_volume_attachment(name, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

delete a VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



1253
1254
1255
1256
# File 'lib/zilla/api/storage_v1_api.rb', line 1253

def delete_storage_v1_volume_attachment(name, opts = {})
  data, _status_code, _headers = delete_storage_v1_volume_attachment_with_http_info(name, opts)
  data
end

#delete_storage_v1_volume_attachment_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

delete a VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

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

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

  • :body (IoK8sApimachineryPkgApisMetaV1DeleteOptions)

Returns:



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/zilla/api/storage_v1_api.rb', line 1268

def delete_storage_v1_volume_attachment_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.delete_storage_v1_volume_attachment ...'
  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 StorageV1Api.delete_storage_v1_volume_attachment"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:body])

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.delete_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#delete_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#get_storage_v1_api_resources(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1APIResourceList

get available resources

Parameters:

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

    the optional parameters

Returns:



1328
1329
1330
1331
# File 'lib/zilla/api/storage_v1_api.rb', line 1328

def get_storage_v1_api_resources(opts = {})
  data, _status_code, _headers = get_storage_v1_api_resources_with_http_info(opts)
  data
end

#get_storage_v1_api_resources_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1APIResourceList, Integer, Hash)>

get available resources

Parameters:

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

    the optional parameters

Returns:



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'lib/zilla/api/storage_v1_api.rb', line 1336

def get_storage_v1_api_resources_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.get_storage_v1_api_resources ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1APIResourceList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.get_storage_v1_api_resources',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#get_storage_v1_api_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_storage_v1_csi_driver(opts = {}) ⇒ IoK8sApiStorageV1CSIDriverList

list or watch objects of kind CSIDriver

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1395
1396
1397
1398
# File 'lib/zilla/api/storage_v1_api.rb', line 1395

def list_storage_v1_csi_driver(opts = {})
  data, _status_code, _headers = list_storage_v1_csi_driver_with_http_info(opts)
  data
end

#list_storage_v1_csi_driver_with_http_info(opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIDriverList, Integer, Hash)>

list or watch objects of kind CSIDriver

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'lib/zilla/api/storage_v1_api.rb', line 1413

def list_storage_v1_csi_driver_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.list_storage_v1_csi_driver ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIDriverList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.list_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#list_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_storage_v1_csi_node(opts = {}) ⇒ IoK8sApiStorageV1CSINodeList

list or watch objects of kind CSINode

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1482
1483
1484
1485
# File 'lib/zilla/api/storage_v1_api.rb', line 1482

def list_storage_v1_csi_node(opts = {})
  data, _status_code, _headers = list_storage_v1_csi_node_with_http_info(opts)
  data
end

#list_storage_v1_csi_node_with_http_info(opts = {}) ⇒ Array<(IoK8sApiStorageV1CSINodeList, Integer, Hash)>

list or watch objects of kind CSINode

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
# File 'lib/zilla/api/storage_v1_api.rb', line 1500

def list_storage_v1_csi_node_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.list_storage_v1_csi_node ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSINodeList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.list_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#list_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_storage_v1_csi_storage_capacity_for_all_namespaces(opts = {}) ⇒ IoK8sApiStorageV1CSIStorageCapacityList

list or watch objects of kind CSIStorageCapacity

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



1569
1570
1571
1572
# File 'lib/zilla/api/storage_v1_api.rb', line 1569

def list_storage_v1_csi_storage_capacity_for_all_namespaces(opts = {})
  data, _status_code, _headers = list_storage_v1_csi_storage_capacity_for_all_namespaces_with_http_info(opts)
  data
end

#list_storage_v1_csi_storage_capacity_for_all_namespaces_with_http_info(opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIStorageCapacityList, Integer, Hash)>

list or watch objects of kind CSIStorageCapacity

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
# File 'lib/zilla/api/storage_v1_api.rb', line 1587

def list_storage_v1_csi_storage_capacity_for_all_namespaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.list_storage_v1_csi_storage_capacity_for_all_namespaces ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csistoragecapacities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIStorageCapacityList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.list_storage_v1_csi_storage_capacity_for_all_namespaces',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#list_storage_v1_csi_storage_capacity_for_all_namespaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_storage_v1_namespaced_csi_storage_capacity(namespace, opts = {}) ⇒ IoK8sApiStorageV1CSIStorageCapacityList

list or watch objects of kind CSIStorageCapacity

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1657
1658
1659
1660
# File 'lib/zilla/api/storage_v1_api.rb', line 1657

def list_storage_v1_namespaced_csi_storage_capacity(namespace, opts = {})
  data, _status_code, _headers = list_storage_v1_namespaced_csi_storage_capacity_with_http_info(namespace, opts)
  data
end

#list_storage_v1_namespaced_csi_storage_capacity_with_http_info(namespace, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIStorageCapacityList, Integer, Hash)>

list or watch objects of kind CSIStorageCapacity

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
# File 'lib/zilla/api/storage_v1_api.rb', line 1676

def list_storage_v1_namespaced_csi_storage_capacity_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.list_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.list_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities'.sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIStorageCapacityList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.list_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#list_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_storage_v1_storage_class(opts = {}) ⇒ IoK8sApiStorageV1StorageClassList

list or watch objects of kind StorageClass

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1753
1754
1755
1756
# File 'lib/zilla/api/storage_v1_api.rb', line 1753

def list_storage_v1_storage_class(opts = {})
  data, _status_code, _headers = list_storage_v1_storage_class_with_http_info(opts)
  data
end

#list_storage_v1_storage_class_with_http_info(opts = {}) ⇒ Array<(IoK8sApiStorageV1StorageClassList, Integer, Hash)>

list or watch objects of kind StorageClass

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'lib/zilla/api/storage_v1_api.rb', line 1771

def list_storage_v1_storage_class_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.list_storage_v1_storage_class ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1StorageClassList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.list_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#list_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_storage_v1_volume_attachment(opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachmentList

list or watch objects of kind VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1840
1841
1842
1843
# File 'lib/zilla/api/storage_v1_api.rb', line 1840

def list_storage_v1_volume_attachment(opts = {})
  data, _status_code, _headers = list_storage_v1_volume_attachment_with_http_info(opts)
  data
end

#list_storage_v1_volume_attachment_with_http_info(opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachmentList, Integer, Hash)>

list or watch objects of kind VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

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

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

    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

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

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

Returns:



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
# File 'lib/zilla/api/storage_v1_api.rb', line 1858

def list_storage_v1_volume_attachment_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.list_storage_v1_volume_attachment ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachmentList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.list_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#list_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_storage_v1_csi_driver(name, body, opts = {}) ⇒ IoK8sApiStorageV1CSIDriver

partially update the specified CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



1924
1925
1926
1927
# File 'lib/zilla/api/storage_v1_api.rb', line 1924

def patch_storage_v1_csi_driver(name, body, opts = {})
  data, _status_code, _headers = patch_storage_v1_csi_driver_with_http_info(name, body, opts)
  data
end

#patch_storage_v1_csi_driver_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>

partially update the specified CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:

  • (Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>)

    IoK8sApiStorageV1CSIDriver data, response status code and response headers



1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
# File 'lib/zilla/api/storage_v1_api.rb', line 1939

def patch_storage_v1_csi_driver_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.patch_storage_v1_csi_driver ...'
  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 StorageV1Api.patch_storage_v1_csi_driver"
  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 StorageV1Api.patch_storage_v1_csi_driver"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?
  query_params[:force] = opts[:force] unless opts[:force].nil?

  # header parameters
  header_params = opts[: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'
  content_type = @api_client.select_header_content_type(['application/json-patch+json',
                                                         'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml'])
  header_params['Content-Type'] = content_type unless content_type.nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIDriver'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.patch_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#patch_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_storage_v1_csi_node(name, body, opts = {}) ⇒ IoK8sApiStorageV1CSINode

partially update the specified CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2015
2016
2017
2018
# File 'lib/zilla/api/storage_v1_api.rb', line 2015

def patch_storage_v1_csi_node(name, body, opts = {})
  data, _status_code, _headers = patch_storage_v1_csi_node_with_http_info(name, body, opts)
  data
end

#patch_storage_v1_csi_node_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>

partially update the specified CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:

  • (Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>)

    IoK8sApiStorageV1CSINode data, response status code and response headers



2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
# File 'lib/zilla/api/storage_v1_api.rb', line 2030

def patch_storage_v1_csi_node_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.patch_storage_v1_csi_node ...'
  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 StorageV1Api.patch_storage_v1_csi_node"
  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 StorageV1Api.patch_storage_v1_csi_node"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?
  query_params[:force] = opts[:force] unless opts[:force].nil?

  # header parameters
  header_params = opts[: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'
  content_type = @api_client.select_header_content_type(['application/json-patch+json',
                                                         'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml'])
  header_params['Content-Type'] = content_type unless content_type.nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSINode'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.patch_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#patch_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_storage_v1_namespaced_csi_storage_capacity(name, namespace, body, opts = {}) ⇒ IoK8sApiStorageV1CSIStorageCapacity

partially update the specified CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2107
2108
2109
2110
2111
# File 'lib/zilla/api/storage_v1_api.rb', line 2107

def patch_storage_v1_namespaced_csi_storage_capacity(name, namespace, body, opts = {})
  data, _status_code, _headers = patch_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace,
                                                                                                 body, opts)
  data
end

#patch_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIStorageCapacity, Integer, Hash)>

partially update the specified CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
# File 'lib/zilla/api/storage_v1_api.rb', line 2124

def patch_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.patch_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.patch_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.patch_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.patch_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}'.sub('{name}', CGI.escape(name.to_s)).sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?
  query_params[:force] = opts[:force] unless opts[:force].nil?

  # header parameters
  header_params = opts[: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'
  content_type = @api_client.select_header_content_type(['application/json-patch+json',
                                                         'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml'])
  header_params['Content-Type'] = content_type unless content_type.nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIStorageCapacity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.patch_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#patch_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_storage_v1_storage_class(name, body, opts = {}) ⇒ IoK8sApiStorageV1StorageClass

partially update the specified StorageClass

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2207
2208
2209
2210
# File 'lib/zilla/api/storage_v1_api.rb', line 2207

def patch_storage_v1_storage_class(name, body, opts = {})
  data, _status_code, _headers = patch_storage_v1_storage_class_with_http_info(name, body, opts)
  data
end

#patch_storage_v1_storage_class_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1StorageClass, Integer, Hash)>

partially update the specified StorageClass

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
# File 'lib/zilla/api/storage_v1_api.rb', line 2222

def patch_storage_v1_storage_class_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.patch_storage_v1_storage_class ...'
  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 StorageV1Api.patch_storage_v1_storage_class"
  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 StorageV1Api.patch_storage_v1_storage_class"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?
  query_params[:force] = opts[:force] unless opts[:force].nil?

  # header parameters
  header_params = opts[: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'
  content_type = @api_client.select_header_content_type(['application/json-patch+json',
                                                         'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml'])
  header_params['Content-Type'] = content_type unless content_type.nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1StorageClass'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.patch_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#patch_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_storage_v1_volume_attachment(name, body, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

partially update the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2298
2299
2300
2301
# File 'lib/zilla/api/storage_v1_api.rb', line 2298

def patch_storage_v1_volume_attachment(name, body, opts = {})
  data, _status_code, _headers = patch_storage_v1_volume_attachment_with_http_info(name, body, opts)
  data
end

#patch_storage_v1_volume_attachment_status(name, body, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

partially update status of the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2389
2390
2391
2392
# File 'lib/zilla/api/storage_v1_api.rb', line 2389

def patch_storage_v1_volume_attachment_status(name, body, opts = {})
  data, _status_code, _headers = patch_storage_v1_volume_attachment_status_with_http_info(name, body, opts)
  data
end

#patch_storage_v1_volume_attachment_status_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

partially update status of the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
# File 'lib/zilla/api/storage_v1_api.rb', line 2404

def patch_storage_v1_volume_attachment_status_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.patch_storage_v1_volume_attachment_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 StorageV1Api.patch_storage_v1_volume_attachment_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 StorageV1Api.patch_storage_v1_volume_attachment_status"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}/status'.sub('{name}',
                                                                                 CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?
  query_params[:force] = opts[:force] unless opts[:force].nil?

  # header parameters
  header_params = opts[: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'
  content_type = @api_client.select_header_content_type(['application/json-patch+json',
                                                         'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml'])
  header_params['Content-Type'] = content_type unless content_type.nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.patch_storage_v1_volume_attachment_status',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#patch_storage_v1_volume_attachment_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_storage_v1_volume_attachment_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

partially update the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

    Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Returns:



2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'lib/zilla/api/storage_v1_api.rb', line 2313

def patch_storage_v1_volume_attachment_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.patch_storage_v1_volume_attachment ...'
  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 StorageV1Api.patch_storage_v1_volume_attachment"
  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 StorageV1Api.patch_storage_v1_volume_attachment"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?
  query_params[:force] = opts[:force] unless opts[:force].nil?

  # header parameters
  header_params = opts[: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'
  content_type = @api_client.select_header_content_type(['application/json-patch+json',
                                                         'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml'])
  header_params['Content-Type'] = content_type unless content_type.nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.patch_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#patch_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_storage_v1_csi_driver(name, opts = {}) ⇒ IoK8sApiStorageV1CSIDriver

read the specified CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2476
2477
2478
2479
# File 'lib/zilla/api/storage_v1_api.rb', line 2476

def read_storage_v1_csi_driver(name, opts = {})
  data, _status_code, _headers = read_storage_v1_csi_driver_with_http_info(name, opts)
  data
end

#read_storage_v1_csi_driver_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>

read the specified CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:

  • (Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>)

    IoK8sApiStorageV1CSIDriver data, response status code and response headers



2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'lib/zilla/api/storage_v1_api.rb', line 2486

def read_storage_v1_csi_driver_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.read_storage_v1_csi_driver ...'
  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 StorageV1Api.read_storage_v1_csi_driver"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIDriver'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.read_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#read_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_storage_v1_csi_node(name, opts = {}) ⇒ IoK8sApiStorageV1CSINode

read the specified CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2544
2545
2546
2547
# File 'lib/zilla/api/storage_v1_api.rb', line 2544

def read_storage_v1_csi_node(name, opts = {})
  data, _status_code, _headers = read_storage_v1_csi_node_with_http_info(name, opts)
  data
end

#read_storage_v1_csi_node_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>

read the specified CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:

  • (Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>)

    IoK8sApiStorageV1CSINode data, response status code and response headers



2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
# File 'lib/zilla/api/storage_v1_api.rb', line 2554

def read_storage_v1_csi_node_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.read_storage_v1_csi_node ...'
  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 StorageV1Api.read_storage_v1_csi_node"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSINode'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.read_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#read_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_storage_v1_namespaced_csi_storage_capacity(name, namespace, opts = {}) ⇒ IoK8sApiStorageV1CSIStorageCapacity

read the specified CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2613
2614
2615
2616
2617
# File 'lib/zilla/api/storage_v1_api.rb', line 2613

def read_storage_v1_namespaced_csi_storage_capacity(name, namespace, opts = {})
  data, _status_code, _headers = read_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace,
                                                                                                opts)
  data
end

#read_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIStorageCapacity, Integer, Hash)>

read the specified CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
# File 'lib/zilla/api/storage_v1_api.rb', line 2625

def read_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.read_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.read_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.read_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}'.sub('{name}', CGI.escape(name.to_s)).sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIStorageCapacity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.read_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#read_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_storage_v1_storage_class(name, opts = {}) ⇒ IoK8sApiStorageV1StorageClass

read the specified StorageClass

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2690
2691
2692
2693
# File 'lib/zilla/api/storage_v1_api.rb', line 2690

def read_storage_v1_storage_class(name, opts = {})
  data, _status_code, _headers = read_storage_v1_storage_class_with_http_info(name, opts)
  data
end

#read_storage_v1_storage_class_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1StorageClass, Integer, Hash)>

read the specified StorageClass

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
# File 'lib/zilla/api/storage_v1_api.rb', line 2700

def read_storage_v1_storage_class_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.read_storage_v1_storage_class ...'
  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 StorageV1Api.read_storage_v1_storage_class"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1StorageClass'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.read_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#read_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_storage_v1_volume_attachment(name, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

read the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2758
2759
2760
2761
# File 'lib/zilla/api/storage_v1_api.rb', line 2758

def read_storage_v1_volume_attachment(name, opts = {})
  data, _status_code, _headers = read_storage_v1_volume_attachment_with_http_info(name, opts)
  data
end

#read_storage_v1_volume_attachment_status(name, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

read status of the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2826
2827
2828
2829
# File 'lib/zilla/api/storage_v1_api.rb', line 2826

def read_storage_v1_volume_attachment_status(name, opts = {})
  data, _status_code, _headers = read_storage_v1_volume_attachment_status_with_http_info(name, opts)
  data
end

#read_storage_v1_volume_attachment_status_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

read status of the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
# File 'lib/zilla/api/storage_v1_api.rb', line 2836

def read_storage_v1_volume_attachment_status_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.read_storage_v1_volume_attachment_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 StorageV1Api.read_storage_v1_volume_attachment_status"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}/status'.sub('{name}',
                                                                                 CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.read_storage_v1_volume_attachment_status',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#read_storage_v1_volume_attachment_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_storage_v1_volume_attachment_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

read the specified VolumeAttachment

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

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

Returns:



2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
# File 'lib/zilla/api/storage_v1_api.rb', line 2768

def read_storage_v1_volume_attachment_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.read_storage_v1_volume_attachment ...'
  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 StorageV1Api.read_storage_v1_volume_attachment"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}'.sub('{name}', CGI.escape(name.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.read_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#read_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_storage_v1_csi_driver(name, body, opts = {}) ⇒ IoK8sApiStorageV1CSIDriver

replace the specified CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



2899
2900
2901
2902
# File 'lib/zilla/api/storage_v1_api.rb', line 2899

def replace_storage_v1_csi_driver(name, body, opts = {})
  data, _status_code, _headers = replace_storage_v1_csi_driver_with_http_info(name, body, opts)
  data
end

#replace_storage_v1_csi_driver_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>

replace the specified CSIDriver

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

  • (Array<(IoK8sApiStorageV1CSIDriver, Integer, Hash)>)

    IoK8sApiStorageV1CSIDriver data, response status code and response headers



2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
# File 'lib/zilla/api/storage_v1_api.rb', line 2913

def replace_storage_v1_csi_driver_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.replace_storage_v1_csi_driver ...'
  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 StorageV1Api.replace_storage_v1_csi_driver"
  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 StorageV1Api.replace_storage_v1_csi_driver"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csidrivers/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIDriver'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.replace_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#replace_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_storage_v1_csi_node(name, body, opts = {}) ⇒ IoK8sApiStorageV1CSINode

replace the specified CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



2983
2984
2985
2986
# File 'lib/zilla/api/storage_v1_api.rb', line 2983

def replace_storage_v1_csi_node(name, body, opts = {})
  data, _status_code, _headers = replace_storage_v1_csi_node_with_http_info(name, body, opts)
  data
end

#replace_storage_v1_csi_node_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>

replace the specified CSINode

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

  • (Array<(IoK8sApiStorageV1CSINode, Integer, Hash)>)

    IoK8sApiStorageV1CSINode data, response status code and response headers



2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
# File 'lib/zilla/api/storage_v1_api.rb', line 2997

def replace_storage_v1_csi_node_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.replace_storage_v1_csi_node ...'
  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 StorageV1Api.replace_storage_v1_csi_node"
  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 StorageV1Api.replace_storage_v1_csi_node"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/csinodes/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSINode'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.replace_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#replace_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_storage_v1_namespaced_csi_storage_capacity(name, namespace, body, opts = {}) ⇒ IoK8sApiStorageV1CSIStorageCapacity

replace the specified CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3068
3069
3070
3071
3072
# File 'lib/zilla/api/storage_v1_api.rb', line 3068

def replace_storage_v1_namespaced_csi_storage_capacity(name, namespace, body, opts = {})
  data, _status_code, _headers = replace_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace,
                                                                                                   body, opts)
  data
end

#replace_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1CSIStorageCapacity, Integer, Hash)>

replace the specified CSIStorageCapacity

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
# File 'lib/zilla/api/storage_v1_api.rb', line 3084

def replace_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.replace_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.replace_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.replace_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.replace_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}'.sub('{name}', CGI.escape(name.to_s)).sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1CSIStorageCapacity'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.replace_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#replace_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_storage_v1_storage_class(name, body, opts = {}) ⇒ IoK8sApiStorageV1StorageClass

replace the specified StorageClass

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3161
3162
3163
3164
# File 'lib/zilla/api/storage_v1_api.rb', line 3161

def replace_storage_v1_storage_class(name, body, opts = {})
  data, _status_code, _headers = replace_storage_v1_storage_class_with_http_info(name, body, opts)
  data
end

#replace_storage_v1_storage_class_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1StorageClass, Integer, Hash)>

replace the specified StorageClass

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
# File 'lib/zilla/api/storage_v1_api.rb', line 3175

def replace_storage_v1_storage_class_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.replace_storage_v1_storage_class ...'
  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 StorageV1Api.replace_storage_v1_storage_class"
  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 StorageV1Api.replace_storage_v1_storage_class"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/storageclasses/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1StorageClass'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.replace_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#replace_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_storage_v1_volume_attachment(name, body, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

replace the specified VolumeAttachment

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3245
3246
3247
3248
# File 'lib/zilla/api/storage_v1_api.rb', line 3245

def replace_storage_v1_volume_attachment(name, body, opts = {})
  data, _status_code, _headers = replace_storage_v1_volume_attachment_with_http_info(name, body, opts)
  data
end

#replace_storage_v1_volume_attachment_status(name, body, opts = {}) ⇒ IoK8sApiStorageV1VolumeAttachment

replace status of the specified VolumeAttachment

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3329
3330
3331
3332
# File 'lib/zilla/api/storage_v1_api.rb', line 3329

def replace_storage_v1_volume_attachment_status(name, body, opts = {})
  data, _status_code, _headers = replace_storage_v1_volume_attachment_status_with_http_info(name, body, opts)
  data
end

#replace_storage_v1_volume_attachment_status_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

replace status of the specified VolumeAttachment

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
# File 'lib/zilla/api/storage_v1_api.rb', line 3343

def replace_storage_v1_volume_attachment_status_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.replace_storage_v1_volume_attachment_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 StorageV1Api.replace_storage_v1_volume_attachment_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 StorageV1Api.replace_storage_v1_volume_attachment_status"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}/status'.sub('{name}',
                                                                                 CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.replace_storage_v1_volume_attachment_status',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#replace_storage_v1_volume_attachment_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_storage_v1_volume_attachment_with_http_info(name, body, opts = {}) ⇒ Array<(IoK8sApiStorageV1VolumeAttachment, Integer, Hash)>

replace the specified VolumeAttachment

Parameters:

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

  • :field_manager (String)

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by golang.org/pkg/unicode/#IsPrint.

  • :field_validation (String)

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the &#x60;ServerSideFieldValidation&#x60; feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the &#x60;ServerSideFieldValidation&#x60; feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the &#x60;ServerSideFieldValidation&#x60; feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
# File 'lib/zilla/api/storage_v1_api.rb', line 3259

def replace_storage_v1_volume_attachment_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.replace_storage_v1_volume_attachment ...'
  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 StorageV1Api.replace_storage_v1_volume_attachment"
  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 StorageV1Api.replace_storage_v1_volume_attachment"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/volumeattachments/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:dryRun] = opts[:dry_run] unless opts[:dry_run].nil?
  query_params[:fieldManager] = opts[:field_manager] unless opts[:field_manager].nil?
  query_params[:fieldValidation] = opts[:field_validation] unless opts[:field_validation].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApiStorageV1VolumeAttachment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.replace_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#replace_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_csi_driver(name, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch changes to an object of kind CSIDriver. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3419
3420
3421
3422
# File 'lib/zilla/api/storage_v1_api.rb', line 3419

def watch_storage_v1_csi_driver(name, opts = {})
  data, _status_code, _headers = watch_storage_v1_csi_driver_with_http_info(name, opts)
  data
end

#watch_storage_v1_csi_driver_list(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of CSIDriver. deprecated: use the ‘watch’ parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3513
3514
3515
3516
# File 'lib/zilla/api/storage_v1_api.rb', line 3513

def watch_storage_v1_csi_driver_list(opts = {})
  data, _status_code, _headers = watch_storage_v1_csi_driver_list_with_http_info(opts)
  data
end

#watch_storage_v1_csi_driver_list_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of CSIDriver. deprecated: use the &#39;watch&#39; parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
# File 'lib/zilla/api/storage_v1_api.rb', line 3531

def watch_storage_v1_csi_driver_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_csi_driver_list ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/csidrivers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_csi_driver_list',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_csi_driver_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_csi_driver_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch changes to an object of kind CSIDriver. deprecated: use the &#39;watch&#39; parameter with a list operation instead, filtered to a single item with the &#39;fieldSelector&#39; parameter.

Parameters:

  • name (String)

    name of the CSIDriver

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
# File 'lib/zilla/api/storage_v1_api.rb', line 3438

def watch_storage_v1_csi_driver_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_csi_driver ...'
  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 StorageV1Api.watch_storage_v1_csi_driver"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/csidrivers/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_csi_driver',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_csi_driver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_csi_node(name, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch changes to an object of kind CSINode. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3601
3602
3603
3604
# File 'lib/zilla/api/storage_v1_api.rb', line 3601

def watch_storage_v1_csi_node(name, opts = {})
  data, _status_code, _headers = watch_storage_v1_csi_node_with_http_info(name, opts)
  data
end

#watch_storage_v1_csi_node_list(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of CSINode. deprecated: use the ‘watch’ parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3695
3696
3697
3698
# File 'lib/zilla/api/storage_v1_api.rb', line 3695

def watch_storage_v1_csi_node_list(opts = {})
  data, _status_code, _headers = watch_storage_v1_csi_node_list_with_http_info(opts)
  data
end

#watch_storage_v1_csi_node_list_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of CSINode. deprecated: use the &#39;watch&#39; parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
# File 'lib/zilla/api/storage_v1_api.rb', line 3713

def watch_storage_v1_csi_node_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_csi_node_list ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/csinodes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_csi_node_list',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_csi_node_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_csi_node_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch changes to an object of kind CSINode. deprecated: use the &#39;watch&#39; parameter with a list operation instead, filtered to a single item with the &#39;fieldSelector&#39; parameter.

Parameters:

  • name (String)

    name of the CSINode

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'lib/zilla/api/storage_v1_api.rb', line 3620

def watch_storage_v1_csi_node_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_csi_node ...'
  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 StorageV1Api.watch_storage_v1_csi_node"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/csinodes/{name}'.sub('{name}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_csi_node',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_csi_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_csi_storage_capacity_list_for_all_namespaces(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of CSIStorageCapacity. deprecated: use the ‘watch’ parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3782
3783
3784
3785
# File 'lib/zilla/api/storage_v1_api.rb', line 3782

def watch_storage_v1_csi_storage_capacity_list_for_all_namespaces(opts = {})
  data, _status_code, _headers = watch_storage_v1_csi_storage_capacity_list_for_all_namespaces_with_http_info(opts)
  data
end

#watch_storage_v1_csi_storage_capacity_list_for_all_namespaces_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of CSIStorageCapacity. deprecated: use the &#39;watch&#39; parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
# File 'lib/zilla/api/storage_v1_api.rb', line 3800

def watch_storage_v1_csi_storage_capacity_list_for_all_namespaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_csi_storage_capacity_list_for_all_namespaces ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/csistoragecapacities'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_csi_storage_capacity_list_for_all_namespaces',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_csi_storage_capacity_list_for_all_namespaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_namespaced_csi_storage_capacity(name, namespace, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch changes to an object of kind CSIStorageCapacity. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3871
3872
3873
3874
3875
# File 'lib/zilla/api/storage_v1_api.rb', line 3871

def watch_storage_v1_namespaced_csi_storage_capacity(name, namespace, opts = {})
  data, _status_code, _headers = watch_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace,
                                                                                                 opts)
  data
end

#watch_storage_v1_namespaced_csi_storage_capacity_list(namespace, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of CSIStorageCapacity. deprecated: use the ‘watch’ parameter with a list operation instead.

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3975
3976
3977
3978
3979
# File 'lib/zilla/api/storage_v1_api.rb', line 3975

def watch_storage_v1_namespaced_csi_storage_capacity_list(namespace, opts = {})
  data, _status_code, _headers = watch_storage_v1_namespaced_csi_storage_capacity_list_with_http_info(namespace,
                                                                                                      opts)
  data
end

#watch_storage_v1_namespaced_csi_storage_capacity_list_with_http_info(namespace, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of CSIStorageCapacity. deprecated: use the &#39;watch&#39; parameter with a list operation instead.

Parameters:

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
# File 'lib/zilla/api/storage_v1_api.rb', line 3995

def watch_storage_v1_namespaced_csi_storage_capacity_list_with_http_info(namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity_list ...'
  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 StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity_list"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities'.sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity_list',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_namespaced_csi_storage_capacity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch changes to an object of kind CSIStorageCapacity. deprecated: use the &#39;watch&#39; parameter with a list operation instead, filtered to a single item with the &#39;fieldSelector&#39; parameter.

Parameters:

  • name (String)

    name of the CSIStorageCapacity

  • namespace (String)

    object name and auth scope, such as for teams and projects

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
# File 'lib/zilla/api/storage_v1_api.rb', line 3892

def watch_storage_v1_namespaced_csi_storage_capacity_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity ...'
  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 StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity"
  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 StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities/{name}'.sub('{name}', CGI.escape(name.to_s)).sub(
    '{namespace}', CGI.escape(namespace.to_s)
  )

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_namespaced_csi_storage_capacity',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_namespaced_csi_storage_capacity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_storage_class(name, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch changes to an object of kind StorageClass. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4073
4074
4075
4076
# File 'lib/zilla/api/storage_v1_api.rb', line 4073

def watch_storage_v1_storage_class(name, opts = {})
  data, _status_code, _headers = watch_storage_v1_storage_class_with_http_info(name, opts)
  data
end

#watch_storage_v1_storage_class_list(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of StorageClass. deprecated: use the ‘watch’ parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4168
4169
4170
4171
# File 'lib/zilla/api/storage_v1_api.rb', line 4168

def watch_storage_v1_storage_class_list(opts = {})
  data, _status_code, _headers = watch_storage_v1_storage_class_list_with_http_info(opts)
  data
end

#watch_storage_v1_storage_class_list_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of StorageClass. deprecated: use the &#39;watch&#39; parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
# File 'lib/zilla/api/storage_v1_api.rb', line 4186

def watch_storage_v1_storage_class_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_storage_class_list ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/storageclasses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_storage_class_list',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_storage_class_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_storage_class_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch changes to an object of kind StorageClass. deprecated: use the &#39;watch&#39; parameter with a list operation instead, filtered to a single item with the &#39;fieldSelector&#39; parameter.

Parameters:

  • name (String)

    name of the StorageClass

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
# File 'lib/zilla/api/storage_v1_api.rb', line 4092

def watch_storage_v1_storage_class_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_storage_class ...'
  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 StorageV1Api.watch_storage_v1_storage_class"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/storageclasses/{name}'.sub('{name}',
                                                                             CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_storage_class',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_storage_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_volume_attachment(name, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch changes to an object of kind VolumeAttachment. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4256
4257
4258
4259
# File 'lib/zilla/api/storage_v1_api.rb', line 4256

def watch_storage_v1_volume_attachment(name, opts = {})
  data, _status_code, _headers = watch_storage_v1_volume_attachment_with_http_info(name, opts)
  data
end

#watch_storage_v1_volume_attachment_list(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of VolumeAttachment. deprecated: use the ‘watch’ parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4351
4352
4353
4354
# File 'lib/zilla/api/storage_v1_api.rb', line 4351

def watch_storage_v1_volume_attachment_list(opts = {})
  data, _status_code, _headers = watch_storage_v1_volume_attachment_list_with_http_info(opts)
  data
end

#watch_storage_v1_volume_attachment_list_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of VolumeAttachment. deprecated: use the &#39;watch&#39; parameter with a list operation instead.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
# File 'lib/zilla/api/storage_v1_api.rb', line 4369

def watch_storage_v1_volume_attachment_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_volume_attachment_list ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/volumeattachments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_volume_attachment_list',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_volume_attachment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_storage_v1_volume_attachment_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch changes to an object of kind VolumeAttachment. deprecated: use the &#39;watch&#39; parameter with a list operation instead, filtered to a single item with the &#39;fieldSelector&#39; parameter.

Parameters:

  • name (String)

    name of the VolumeAttachment

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

    the optional parameters

Options Hash (opts):

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

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

  • :pretty (String)

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

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

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

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

Returns:



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'lib/zilla/api/storage_v1_api.rb', line 4275

def watch_storage_v1_volume_attachment_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1Api.watch_storage_v1_volume_attachment ...'
  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 StorageV1Api.watch_storage_v1_volume_attachment"
  end

  # resource path
  local_var_path = '/apis/storage.k8s.io/v1/watch/volumeattachments/{name}'.sub('{name}',
                                                                                CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:allowWatchBookmarks] = opts[:allow_watch_bookmarks] unless opts[:allow_watch_bookmarks].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[:pretty] = opts[:pretty] unless opts[:pretty].nil?
  query_params[:resourceVersion] = opts[:resource_version] unless opts[:resource_version].nil?
  query_params[:resourceVersionMatch] = opts[:resource_version_match] unless opts[:resource_version_match].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 = opts[: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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IoK8sApimachineryPkgApisMetaV1WatchEvent'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerToken']

  new_options = opts.merge(
    operation: :'StorageV1Api.watch_storage_v1_volume_attachment',
    header_params:,
    query_params:,
    form_params:,
    body: post_body,
    auth_names:,
    return_type:
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorageV1Api#watch_storage_v1_volume_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end