Class: Kubernetes::StorageV1alpha1Api

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StorageV1alpha1Api

Returns a new instance of StorageV1alpha1Api.



19
20
21
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_volume_attachment(body, opts = {}) ⇒ V1alpha1VolumeAttachment

create a VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

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

  • :pretty (String) —

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

  • :dry_run (String) —

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Returns:



31
32
33
34
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 31

def create_volume_attachment(body, opts = {})
  data, _status_code, _headers = create_volume_attachment_with_http_info(body, opts)
  data
end

#create_volume_attachment_with_http_info(body, opts = {}) ⇒ Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>

create a VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

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

  • :pretty (String) —

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

  • :dry_run (String) —

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Returns:

  • (Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>) —

    V1alpha1VolumeAttachment 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
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 44

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

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

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

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

  # form parameters
  form_params = {}

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

#delete_collection_volume_attachment(opts = {}) ⇒ V1Status

delete collection of VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

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

  • :pretty (String) —

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

  • :continue (String) —

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

  • :field_selector (String) —

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

  • :label_selector (String) —

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

  • :limit (Integer) —

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

  • :resource_version (String) —

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

  • :timeout_seconds (Integer) —

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

  • :watch (BOOLEAN) —

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

Returns:



107
108
109
110
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 107

def delete_collection_volume_attachment(opts = {})
  data, _status_code, _headers = delete_collection_volume_attachment_with_http_info(opts)
  data
end

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

delete collection of VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

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

  • :pretty (String) —

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

  • :continue (String) —

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

  • :field_selector (String) —

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

  • :label_selector (String) —

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

  • :limit (Integer) —

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

  • :resource_version (String) —

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

  • :timeout_seconds (Integer) —

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

  • :watch (BOOLEAN) —

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

Returns:

  • (Array<(V1Status, Fixnum, Hash)>) —

    V1Status data, response status code and response headers



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
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 125

def delete_collection_volume_attachment_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1alpha1Api.delete_collection_volume_attachment ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1alpha1/volumeattachments'

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

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

  # form parameters
  form_params = {}

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

#delete_volume_attachment(name, opts = {}) ⇒ V1Status

delete a VolumeAttachment

Parameters:

  • name —

    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.

  • :body (V1DeleteOptions)
  • :dry_run (String) —

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • :grace_period_seconds (Integer) —

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

  • :orphan_dependents (BOOLEAN) —

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

  • :propagation_policy (String) —

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

Returns:



186
187
188
189
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 186

def delete_volume_attachment(name, opts = {})
  data, _status_code, _headers = delete_volume_attachment_with_http_info(name, opts)
  data
end

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

delete a VolumeAttachment

Parameters:

  • name —

    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.

  • :body (V1DeleteOptions)
  • :dry_run (String) —

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • :grace_period_seconds (Integer) —

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

  • :orphan_dependents (BOOLEAN) —

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#39;s finalizers list. Either this field or PropagationPolicy may be set, but not both.

  • :propagation_policy (String) —

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#39;Orphan&#39; - orphan the dependents; &#39;Background&#39; - allow the garbage collector to delete the dependents in the background; &#39;Foreground&#39; - a cascading policy that deletes all dependents in the foreground.

Returns:

  • (Array<(V1Status, Fixnum, Hash)>) —

    V1Status data, response status code and response headers



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
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 202

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

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

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

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

  # form parameters
  form_params = {}

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

#get_api_resources(opts = {}) ⇒ V1APIResourceList

get available resources

Parameters:

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

    the optional parameters

Returns:



266
267
268
269
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 266

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

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

get available resources

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:

  • (Array<(V1APIResourceList, Fixnum, Hash)>) —

    V1APIResourceList data, response status code and response headers



275
276
277
278
279
280
281
282
283
284
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
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 275

def get_api_resources_with_http_info(_opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1alpha1Api.get_api_resources ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1alpha1/'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#list_volume_attachment(opts = {}) ⇒ V1alpha1VolumeAttachmentList

list or watch objects of kind VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

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

  • :pretty (String) —

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

  • :continue (String) —

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

  • :field_selector (String) —

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

  • :label_selector (String) —

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

  • :limit (Integer) —

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

  • :resource_version (String) —

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

  • :timeout_seconds (Integer) —

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

  • :watch (BOOLEAN) —

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

Returns:



328
329
330
331
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 328

def list_volume_attachment(opts = {})
  data, _status_code, _headers = list_volume_attachment_with_http_info(opts)
  data
end

#list_volume_attachment_with_http_info(opts = {}) ⇒ Array<(V1alpha1VolumeAttachmentList, Fixnum, Hash)>

list or watch objects of kind VolumeAttachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_uninitialized (BOOLEAN) —

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

  • :pretty (String) —

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

  • :continue (String) —

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

  • :field_selector (String) —

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

  • :label_selector (String) —

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

  • :limit (Integer) —

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

  • :resource_version (String) —

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

  • :timeout_seconds (Integer) —

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

  • :watch (BOOLEAN) —

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

Returns:



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

def list_volume_attachment_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorageV1alpha1Api.list_volume_attachment ...'
  end
  # resource path
  local_var_path = '/apis/storage.k8s.io/v1alpha1/volumeattachments'

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

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

  # form parameters
  form_params = {}

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

#patch_volume_attachment(name, body, opts = {}) ⇒ V1alpha1VolumeAttachment

partially update the specified VolumeAttachment

Parameters:

  • name —

    name of the VolumeAttachment

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

Returns:



404
405
406
407
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 404

def patch_volume_attachment(name, body, opts = {})
  data, _status_code, _headers = patch_volume_attachment_with_http_info(name, body, opts)
  data
end

#patch_volume_attachment_with_http_info(name, body, opts = {}) ⇒ Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>

partially update the specified VolumeAttachment

Parameters:

  • name —

    name of the VolumeAttachment

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

Returns:

  • (Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>) —

    V1alpha1VolumeAttachment data, response status code and response headers



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

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

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

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

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

  # form parameters
  form_params = {}

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

#read_volume_attachment(name, opts = {}) ⇒ V1alpha1VolumeAttachment

read the specified VolumeAttachment

Parameters:

  • name —

    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.

  • :exact (BOOLEAN) —

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

  • :export (BOOLEAN) —

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

Returns:



480
481
482
483
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 480

def read_volume_attachment(name, opts = {})
  data, _status_code, _headers = read_volume_attachment_with_http_info(name, opts)
  data
end

#read_volume_attachment_with_http_info(name, opts = {}) ⇒ Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>

read the specified VolumeAttachment

Parameters:

  • name —

    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.

  • :exact (BOOLEAN) —

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

  • :export (BOOLEAN) —

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

Returns:

  • (Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>) —

    V1alpha1VolumeAttachment data, response status code and response headers



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 493

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

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

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

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

  # form parameters
  form_params = {}

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

#replace_volume_attachment(name, body, opts = {}) ⇒ V1alpha1VolumeAttachment

replace the specified VolumeAttachment

Parameters:

  • name —

    name of the VolumeAttachment

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

Returns:



550
551
552
553
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 550

def replace_volume_attachment(name, body, opts = {})
  data, _status_code, _headers = replace_volume_attachment_with_http_info(name, body, opts)
  data
end

#replace_volume_attachment_with_http_info(name, body, opts = {}) ⇒ Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>

replace the specified VolumeAttachment

Parameters:

  • name —

    name of the VolumeAttachment

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

Returns:

  • (Array<(V1alpha1VolumeAttachment, Fixnum, Hash)>) —

    V1alpha1VolumeAttachment data, response status code and response headers



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
607
608
609
610
611
612
613
614
 
# File 'lib/kubernetes/api/storage_v1alpha1_api.rb', line 563

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

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

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

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

  # form parameters
  form_params = {}

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