Class: Zilla::ApiregistrationV1Api

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiregistrationV1Api

Returns a new instance of ApiregistrationV1Api.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#create_apiregistration_v1_api_service(body, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

create an APIService

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/apiregistration_v1_api.rb', line 31

def create_apiregistration_v1_api_service(body, opts = {})
  data, _status_code, _headers = create_apiregistration_v1_api_service_with_http_info(body, opts)
  data
end

#create_apiregistration_v1_api_service_with_http_info(body, opts = {}) ⇒ Array<(IoK8sKubeAggregatorPkgApisApiregistrationV1APIService, Integer, Hash)>

create an APIService

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:



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/apiregistration_v1_api.rb', line 44

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices'

  # 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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.create_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#create_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_apiregistration_v1_api_service(name, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete an APIService

Parameters:

  • name (String) —

    name of the APIService

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



110
111
112
113
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 110

def delete_apiregistration_v1_api_service(name, opts = {})
  data, _status_code, _headers = delete_apiregistration_v1_api_service_with_http_info(name, opts)
  data
end

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

delete an APIService

Parameters:

  • name (String) —

    name of the APIService

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



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
176
177
178
179
180
181
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 125

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sApimachineryPkgApisMetaV1Status'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.delete_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#delete_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#delete_apiregistration_v1_collection_api_service(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1Status

delete collection of APIService

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:



199
200
201
202
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 199

def delete_apiregistration_v1_collection_api_service(opts = {})
  data, _status_code, _headers = delete_apiregistration_v1_collection_api_service_with_http_info(opts)
  data
end

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

delete collection of APIService

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:



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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 220

def delete_apiregistration_v1_collection_api_service_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiregistrationV1Api.delete_apiregistration_v1_collection_api_service ...'
  end
  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices'

  # 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: :'ApiregistrationV1Api.delete_apiregistration_v1_collection_api_service',
    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: ApiregistrationV1Api#delete_apiregistration_v1_collection_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#get_apiregistration_v1_api_resources(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1APIResourceList

get available resources

Parameters:

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 281

def get_apiregistration_v1_api_resources(opts = {})
  data, _status_code, _headers = get_apiregistration_v1_api_resources_with_http_info(opts)
  data
end

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

get available resources

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 289

def get_apiregistration_v1_api_resources_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiregistrationV1Api.get_apiregistration_v1_api_resources ...'
  end
  # resource path
  local_var_path = '/apis/apiregistration.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: :'ApiregistrationV1Api.get_apiregistration_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: ApiregistrationV1Api#get_apiregistration_v1_api_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#list_apiregistration_v1_api_service(opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIServiceList

list or watch objects of kind APIService

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:



348
349
350
351
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 348

def list_apiregistration_v1_api_service(opts = {})
  data, _status_code, _headers = list_apiregistration_v1_api_service_with_http_info(opts)
  data
end

#list_apiregistration_v1_api_service_with_http_info(opts = {}) ⇒ Array<(IoK8sKubeAggregatorPkgApisApiregistrationV1APIServiceList, Integer, Hash)>

list or watch objects of kind APIService

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:



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
417
418
419
420
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 366

def list_apiregistration_v1_api_service_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiregistrationV1Api.list_apiregistration_v1_api_service ...'
  end
  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices'

  # 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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIServiceList'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.list_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#list_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#patch_apiregistration_v1_api_service(name, body, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

partially update the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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



432
433
434
435
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 432

def patch_apiregistration_v1_api_service(name, body, opts = {})
  data, _status_code, _headers = patch_apiregistration_v1_api_service_with_http_info(name, body, opts)
  data
end

#patch_apiregistration_v1_api_service_status(name, body, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

partially update status of the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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



524
525
526
527
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 524

def patch_apiregistration_v1_api_service_status(name, body, opts = {})
  data, _status_code, _headers = patch_apiregistration_v1_api_service_status_with_http_info(name, body, opts)
  data
end

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

partially update status of the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 539

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.patch_apiregistration_v1_api_service_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: ApiregistrationV1Api#patch_apiregistration_v1_api_service_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

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

partially update the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 447

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.patch_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#patch_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_apiregistration_v1_api_service(name, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

read the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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

    the optional parameters

Options Hash (opts):

  • :pretty (String) —

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

Returns:



611
612
613
614
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 611

def read_apiregistration_v1_api_service(name, opts = {})
  data, _status_code, _headers = read_apiregistration_v1_api_service_with_http_info(name, opts)
  data
end

#read_apiregistration_v1_api_service_status(name, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

read status of the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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

    the optional parameters

Options Hash (opts):

  • :pretty (String) —

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

Returns:



680
681
682
683
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 680

def read_apiregistration_v1_api_service_status(name, opts = {})
  data, _status_code, _headers = read_apiregistration_v1_api_service_status_with_http_info(name, opts)
  data
end

#read_apiregistration_v1_api_service_status_with_http_info(name, opts = {}) ⇒ Array<(IoK8sKubeAggregatorPkgApisApiregistrationV1APIService, Integer, Hash)>

read status of the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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

    the optional parameters

Options Hash (opts):

  • :pretty (String) —

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

Returns:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 690

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.read_apiregistration_v1_api_service_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: ApiregistrationV1Api#read_apiregistration_v1_api_service_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#read_apiregistration_v1_api_service_with_http_info(name, opts = {}) ⇒ Array<(IoK8sKubeAggregatorPkgApisApiregistrationV1APIService, Integer, Hash)>

read the specified APIService

Parameters:

  • name (String) —

    name of the APIService

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

    the optional parameters

Options Hash (opts):

  • :pretty (String) —

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

Returns:



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 621

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.read_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#read_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#replace_apiregistration_v1_api_service(name, body, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

replace the specified APIService

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:



753
754
755
756
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 753

def replace_apiregistration_v1_api_service(name, body, opts = {})
  data, _status_code, _headers = replace_apiregistration_v1_api_service_with_http_info(name, body, opts)
  data
end

#replace_apiregistration_v1_api_service_status(name, body, opts = {}) ⇒ IoK8sKubeAggregatorPkgApisApiregistrationV1APIService

replace status of the specified APIService

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:



838
839
840
841
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 838

def replace_apiregistration_v1_api_service_status(name, body, opts = {})
  data, _status_code, _headers = replace_apiregistration_v1_api_service_status_with_http_info(name, body, opts)
  data
end

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

replace status of the specified APIService

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:



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 852

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.replace_apiregistration_v1_api_service_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: ApiregistrationV1Api#replace_apiregistration_v1_api_service_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

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

replace the specified APIService

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:



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
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 767

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/apiservices/{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] || 'IoK8sKubeAggregatorPkgApisApiregistrationV1APIService'

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

  new_options = opts.merge(
    operation: :'ApiregistrationV1Api.replace_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#replace_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_apiregistration_v1_api_service(name, opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch changes to an object of kind APIService. 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 APIService

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



928
929
930
931
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 928

def watch_apiregistration_v1_api_service(name, opts = {})
  data, _status_code, _headers = watch_apiregistration_v1_api_service_with_http_info(name, opts)
  data
end

#watch_apiregistration_v1_api_service_list(opts = {}) ⇒ IoK8sApimachineryPkgApisMetaV1WatchEvent

watch individual changes to a list of APIService. 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:



1023
1024
1025
1026
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 1023

def watch_apiregistration_v1_api_service_list(opts = {})
  data, _status_code, _headers = watch_apiregistration_v1_api_service_list_with_http_info(opts)
  data
end

#watch_apiregistration_v1_api_service_list_with_http_info(opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch individual changes to a list of APIService. 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:



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
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 1041

def watch_apiregistration_v1_api_service_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiregistrationV1Api.watch_apiregistration_v1_api_service_list ...'
  end
  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/watch/apiservices'

  # 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: :'ApiregistrationV1Api.watch_apiregistration_v1_api_service_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: ApiregistrationV1Api#watch_apiregistration_v1_api_service_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#watch_apiregistration_v1_api_service_with_http_info(name, opts = {}) ⇒ Array<(IoK8sApimachineryPkgApisMetaV1WatchEvent, Integer, Hash)>

watch changes to an object of kind APIService. 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 APIService

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



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/zilla/api/apiregistration_v1_api.rb', line 947

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

  # resource path
  local_var_path = '/apis/apiregistration.k8s.io/v1/watch/apiservices/{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: :'ApiregistrationV1Api.watch_apiregistration_v1_api_service',
    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: ApiregistrationV1Api#watch_apiregistration_v1_api_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end