Class: Kubernetes::NetworkingV1beta1Api

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworkingV1beta1Api

Returns a new instance of NetworkingV1beta1Api.



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

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses(body, opts = {}) ⇒ V1beta1IPAddress

create an IPAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



30
31
32
33
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 30

def create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses(body, opts = {})
  data, _status_code, _headers = create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(body, opts)
  data
end

#create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(body, opts = {}) ⇒ Array<(V1beta1IPAddress, Integer, Hash)>

create an IPAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

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

    V1beta1IPAddress data, response status code and response headers



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

def create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#create_ip_address_post_apis_networking_k8s_io_v1beta1_ipaddresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs(body, opts = {}) ⇒ V1beta1ServiceCIDR

create a ServiceCIDR

Parameters:

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



103
104
105
106
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 103

def create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs(body, opts = {})
  data, _status_code, _headers = create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(body, opts)
  data
end

#create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(body, opts = {}) ⇒ Array<(V1beta1ServiceCIDR, Integer, Hash)>

create a ServiceCIDR

Parameters:

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 116

def create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#create_service_cidr_post_apis_networking_k8s_io_v1beta1_servicecidrs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses(opts = {}) ⇒ V1Status

delete collection of IPAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

  • :timeout_seconds (Integer)

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

  • :body (V1DeleteOptions)

Returns:



187
188
189
190
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 187

def delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses(opts = {})
  data, _status_code, _headers = delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(opts)
  data
end

#delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(opts = {}) ⇒ Array<(V1Status, Integer, Hash)>

delete collection of IPAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

  • :timeout_seconds (Integer)

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

  • :body (V1DeleteOptions)

Returns:

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

    V1Status data, response status code and response headers



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 211

def delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses ...'
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'continue'] = opts[:'continue'] if !opts[:'continue'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldSelector'] = opts[:'field_selector'] if !opts[:'field_selector'].nil?
  query_params[:'gracePeriodSeconds'] = opts[:'grace_period_seconds'] if !opts[:'grace_period_seconds'].nil?
  query_params[:'ignoreStoreReadErrorWithClusterBreakingPotential'] = opts[:'ignore_store_read_error_with_cluster_breaking_potential'] if !opts[:'ignore_store_read_error_with_cluster_breaking_potential'].nil?
  query_params[:'labelSelector'] = opts[:'label_selector'] if !opts[:'label_selector'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'orphanDependents'] = opts[:'orphan_dependents'] if !opts[:'orphan_dependents'].nil?
  query_params[:'propagationPolicy'] = opts[:'propagation_policy'] if !opts[:'propagation_policy'].nil?
  query_params[:'resourceVersion'] = opts[:'resource_version'] if !opts[:'resource_version'].nil?
  query_params[:'resourceVersionMatch'] = opts[:'resource_version_match'] if !opts[:'resource_version_match'].nil?
  query_params[:'sendInitialEvents'] = opts[:'send_initial_events'] if !opts[:'send_initial_events'].nil?
  query_params[:'shardSelector'] = opts[:'shard_selector'] if !opts[:'shard_selector'].nil?
  query_params[:'timeoutSeconds'] = opts[:'timeout_seconds'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#delete_collection_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs(opts = {}) ⇒ V1Status

delete collection of ServiceCIDR

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

  • :timeout_seconds (Integer)

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

  • :body (V1DeleteOptions)

Returns:



289
290
291
292
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 289

def delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs(opts = {})
  data, _status_code, _headers = delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(opts)
  data
end

#delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(opts = {}) ⇒ Array<(V1Status, Integer, Hash)>

delete collection of ServiceCIDR

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

  • :timeout_seconds (Integer)

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

  • :body (V1DeleteOptions)

Returns:

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

    V1Status data, response status code and response headers



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 313

def delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs ...'
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'continue'] = opts[:'continue'] if !opts[:'continue'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldSelector'] = opts[:'field_selector'] if !opts[:'field_selector'].nil?
  query_params[:'gracePeriodSeconds'] = opts[:'grace_period_seconds'] if !opts[:'grace_period_seconds'].nil?
  query_params[:'ignoreStoreReadErrorWithClusterBreakingPotential'] = opts[:'ignore_store_read_error_with_cluster_breaking_potential'] if !opts[:'ignore_store_read_error_with_cluster_breaking_potential'].nil?
  query_params[:'labelSelector'] = opts[:'label_selector'] if !opts[:'label_selector'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'orphanDependents'] = opts[:'orphan_dependents'] if !opts[:'orphan_dependents'].nil?
  query_params[:'propagationPolicy'] = opts[:'propagation_policy'] if !opts[:'propagation_policy'].nil?
  query_params[:'resourceVersion'] = opts[:'resource_version'] if !opts[:'resource_version'].nil?
  query_params[:'resourceVersionMatch'] = opts[:'resource_version_match'] if !opts[:'resource_version_match'].nil?
  query_params[:'sendInitialEvents'] = opts[:'send_initial_events'] if !opts[:'send_initial_events'].nil?
  query_params[:'shardSelector'] = opts[:'shard_selector'] if !opts[:'shard_selector'].nil?
  query_params[:'timeoutSeconds'] = opts[:'timeout_seconds'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#delete_collection_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

delete an IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

Returns:



383
384
385
386
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 383

def delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, opts = {})
  data, _status_code, _headers = delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, opts)
  data
end

#delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, opts = {}) ⇒ Array<(V1Status, Integer, Hash)>

delete an IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

Returns:

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

    V1Status data, response status code and response headers



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 399

def delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'gracePeriodSeconds'] = opts[:'grace_period_seconds'] if !opts[:'grace_period_seconds'].nil?
  query_params[:'ignoreStoreReadErrorWithClusterBreakingPotential'] = opts[:'ignore_store_read_error_with_cluster_breaking_potential'] if !opts[:'ignore_store_read_error_with_cluster_breaking_potential'].nil?
  query_params[:'orphanDependents'] = opts[:'orphan_dependents'] if !opts[:'orphan_dependents'].nil?
  query_params[:'propagationPolicy'] = opts[:'propagation_policy'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#delete_ip_address_delete_apis_networking_k8s_io_v1beta1_ipaddresses_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

delete a ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

Returns:



464
465
466
467
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 464

def delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, opts = {})
  data, _status_code, _headers = delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, opts)
  data
end

#delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, opts = {}) ⇒ Array<(V1Status, Integer, Hash)>

delete a ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :ignore_store_read_error_with_cluster_breaking_potential (Boolean)

    if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it

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

Returns:

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

    V1Status data, response status code and response headers



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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 480

def delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'gracePeriodSeconds'] = opts[:'grace_period_seconds'] if !opts[:'grace_period_seconds'].nil?
  query_params[:'ignoreStoreReadErrorWithClusterBreakingPotential'] = opts[:'ignore_store_read_error_with_cluster_breaking_potential'] if !opts[:'ignore_store_read_error_with_cluster_breaking_potential'].nil?
  query_params[:'orphanDependents'] = opts[:'orphan_dependents'] if !opts[:'orphan_dependents'].nil?
  query_params[:'propagationPolicy'] = opts[:'propagation_policy'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#delete_service_cidr_delete_apis_networking_k8s_io_v1beta1_servicecidrs_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_api_resources_get_apis_networking_k8s_io_v1beta1(opts = {}) ⇒ V1APIResourceList

get available resources

Parameters:

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

    the optional parameters

Returns:



537
538
539
540
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 537

def get_api_resources_get_apis_networking_k8s_io_v1beta1(opts = {})
  data, _status_code, _headers = get_api_resources_get_apis_networking_k8s_io_v1beta1_with_http_info(opts)
  data
end

#get_api_resources_get_apis_networking_k8s_io_v1beta1_with_http_info(opts = {}) ⇒ Array<(V1APIResourceList, Integer, Hash)>

get available resources

Parameters:

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

    the optional parameters

Returns:

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

    V1APIResourceList data, response status code and response headers



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

def get_api_resources_get_apis_networking_k8s_io_v1beta1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.get_api_resources_get_apis_networking_k8s_io_v1beta1 ...'
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/'

  # 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', 'application/cbor'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.get_api_resources_get_apis_networking_k8s_io_v1beta1",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#get_api_resources_get_apis_networking_k8s_io_v1beta1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses(opts = {}) ⇒ V1beta1IPAddressList

list or watch objects of kind IPAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

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



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

def list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses(opts = {})
  data, _status_code, _headers = list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(opts)
  data
end

#list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(opts = {}) ⇒ Array<(V1beta1IPAddressList, Integer, Hash)>

list or watch objects of kind IPAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

  • :timeout_seconds (Integer)

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

  • :watch (Boolean)

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

Returns:

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

    V1beta1IPAddressList data, response status code and response headers



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

def list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses ...'
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'allowWatchBookmarks'] = opts[:'allow_watch_bookmarks'] if !opts[:'allow_watch_bookmarks'].nil?
  query_params[:'continue'] = opts[:'continue'] if !opts[:'continue'].nil?
  query_params[:'fieldSelector'] = opts[:'field_selector'] if !opts[:'field_selector'].nil?
  query_params[:'labelSelector'] = opts[:'label_selector'] if !opts[:'label_selector'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'resourceVersion'] = opts[:'resource_version'] if !opts[:'resource_version'].nil?
  query_params[:'resourceVersionMatch'] = opts[:'resource_version_match'] if !opts[:'resource_version_match'].nil?
  query_params[:'sendInitialEvents'] = opts[:'send_initial_events'] if !opts[:'send_initial_events'].nil?
  query_params[:'shardSelector'] = opts[:'shard_selector'] if !opts[:'shard_selector'].nil?
  query_params[:'timeoutSeconds'] = opts[:'timeout_seconds'] if !opts[:'timeout_seconds'].nil?
  query_params[:'watch'] = opts[:'watch'] if !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/cbor', 'application/json;stream=watch', 'application/vnd.kubernetes.protobuf;stream=watch', 'application/cbor-seq'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#list_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs(opts = {}) ⇒ V1beta1ServiceCIDRList

list or watch objects of kind ServiceCIDR

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

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



695
696
697
698
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 695

def list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs(opts = {})
  data, _status_code, _headers = list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(opts)
  data
end

#list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(opts = {}) ⇒ Array<(V1beta1ServiceCIDRList, Integer, Hash)>

list or watch objects of kind ServiceCIDR

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

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

  • :send_initial_events (Boolean)

    &#x60;sendInitialEvents&#x3D;true&#x60; may be set together with &#x60;watch&#x3D;true&#x60;. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic &quot;Bookmark&quot; event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with &#x60;&quot;k8s.io/initial-events-end&quot;: &quot;true&quot;&#x60; annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When &#x60;sendInitialEvents&#x60; option is set, we require &#x60;resourceVersionMatch&#x60; option to also be set. The semantic of the watch request is as following: - &#x60;resourceVersionMatch&#x60; &#x3D; NotOlderThan is interpreted as &quot;data at least as new as the provided &#x60;resourceVersion&#x60;&quot; and the bookmark event is send when the state is synced to a &#x60;resourceVersion&#x60; at least as fresh as the one provided by the ListOptions. If &#x60;resourceVersion&#x60; is unset, this is interpreted as &quot;consistent read&quot; and the bookmark event is send when the state is synced at least to the moment when request started being processed. - &#x60;resourceVersionMatch&#x60; set to any other value or unset Invalid error is returned. Defaults to true if &#x60;resourceVersion&#x3D;&quot;&quot;&#x60; or &#x60;resourceVersion&#x3D;&quot;0&quot;&#x60; (for backward compatibility reasons) and to false otherwise.

  • :shard_selector (String)

    shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) shardRange(object.metadata.uid, &#39;0x0&#39;, &#39;0x8000000000000000&#39;) || shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) Field paths use CEL-style object-rooted syntax (e.g. &quot;object.metadata.uid&quot;), NOT the fieldSelector format (&quot;metadata.uid&quot;). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a &#39;0x&#39; prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0x10000000000000000&#39;) 4-shard split: shard 0: shardRange(object.metadata.uid, &#39;0x0000000000000000&#39;, &#39;0x4000000000000000&#39;) shard 1: shardRange(object.metadata.uid, &#39;0x4000000000000000&#39;, &#39;0x8000000000000000&#39;) shard 2: shardRange(object.metadata.uid, &#39;0x8000000000000000&#39;, &#39;0xc000000000000000&#39;) shard 3: shardRange(object.metadata.uid, &#39;0xc000000000000000&#39;, &#39;0x10000000000000000&#39;) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.

  • :timeout_seconds (Integer)

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

  • :watch (Boolean)

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

Returns:

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

    V1beta1ServiceCIDRList data, response status code and response headers



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 715

def list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs ...'
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'allowWatchBookmarks'] = opts[:'allow_watch_bookmarks'] if !opts[:'allow_watch_bookmarks'].nil?
  query_params[:'continue'] = opts[:'continue'] if !opts[:'continue'].nil?
  query_params[:'fieldSelector'] = opts[:'field_selector'] if !opts[:'field_selector'].nil?
  query_params[:'labelSelector'] = opts[:'label_selector'] if !opts[:'label_selector'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'resourceVersion'] = opts[:'resource_version'] if !opts[:'resource_version'].nil?
  query_params[:'resourceVersionMatch'] = opts[:'resource_version_match'] if !opts[:'resource_version_match'].nil?
  query_params[:'sendInitialEvents'] = opts[:'send_initial_events'] if !opts[:'send_initial_events'].nil?
  query_params[:'shardSelector'] = opts[:'shard_selector'] if !opts[:'shard_selector'].nil?
  query_params[:'timeoutSeconds'] = opts[:'timeout_seconds'] if !opts[:'timeout_seconds'].nil?
  query_params[:'watch'] = opts[:'watch'] if !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/cbor', 'application/json;stream=watch', 'application/vnd.kubernetes.protobuf;stream=watch', 'application/cbor-seq'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#list_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, body, opts = {}) ⇒ V1beta1IPAddress

partially update the specified IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



781
782
783
784
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 781

def patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, body, opts = {})
  data, _status_code, _headers = patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, body, opts)
  data
end

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

partially update the specified IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

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

Returns:

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

    V1beta1IPAddress data, response status code and response headers



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
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 796

def patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !opts[:'field_validation'].nil?
  query_params[:'force'] = opts[:'force'] if !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', 'application/cbor'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml', 'application/apply-patch+cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#patch_ip_address_patch_apis_networking_k8s_io_v1beta1_ipaddresses_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, body, opts = {}) ⇒ V1beta1ServiceCIDR

partially update the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



865
866
867
868
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 865

def patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, body, opts = {})
  data, _status_code, _headers = patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, body, opts)
  data
end

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

partially update the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

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

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



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
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 880

def patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !opts[:'field_validation'].nil?
  query_params[:'force'] = opts[:'force'] if !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', 'application/cbor'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml', 'application/apply-patch+cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#patch_service_cidr_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status(name, body, opts = {}) ⇒ V1beta1ServiceCIDR

partially update status of the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



949
950
951
952
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 949

def patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status(name, body, opts = {})
  data, _status_code, _headers = patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, body, opts)
  data
end

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

partially update status of the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

  • :force (Boolean)

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

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



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
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 964

def patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !opts[:'field_validation'].nil?
  query_params[:'force'] = opts[:'force'] if !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', 'application/cbor'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/merge-patch+json', 'application/strategic-merge-patch+json', 'application/apply-patch+yaml', 'application/apply-patch+cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#patch_service_cidr_status_patch_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, opts = {}) ⇒ V1beta1IPAddress

read the specified IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Returns:



1028
1029
1030
1031
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1028

def read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, opts = {})
  data, _status_code, _headers = read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, opts)
  data
end

#read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, opts = {}) ⇒ Array<(V1beta1IPAddress, Integer, Hash)>

read the specified IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Returns:

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

    V1beta1IPAddress data, response status code and response headers



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1038

def read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !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', 'application/cbor'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#read_ip_address_get_apis_networking_k8s_io_v1beta1_ipaddresses_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, opts = {}) ⇒ V1beta1ServiceCIDR

read the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Returns:



1092
1093
1094
1095
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1092

def read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, opts = {})
  data, _status_code, _headers = read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, opts)
  data
end

#read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, opts = {}) ⇒ Array<(V1beta1ServiceCIDR, Integer, Hash)>

read the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1102

def read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !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', 'application/cbor'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#read_service_cidr_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status(name, opts = {}) ⇒ V1beta1ServiceCIDR

read status of the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Returns:



1156
1157
1158
1159
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1156

def read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status(name, opts = {})
  data, _status_code, _headers = read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, opts)
  data
end

#read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, opts = {}) ⇒ Array<(V1beta1ServiceCIDR, Integer, Hash)>

read status of the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1166

def read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !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', 'application/cbor'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#read_service_cidr_status_get_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, body, opts = {}) ⇒ V1beta1IPAddress

replace the specified IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



1224
1225
1226
1227
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1224

def replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name(name, body, opts = {})
  data, _status_code, _headers = replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, body, opts)
  data
end

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

replace the specified IPAddress

Parameters:

  • name (String)

    name of the IPAddress

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

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

    V1beta1IPAddress data, response status code and response headers



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1238

def replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/ipaddresses/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#replace_ip_address_put_apis_networking_k8s_io_v1beta1_ipaddresses_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, body, opts = {}) ⇒ V1beta1ServiceCIDR

replace the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



1303
1304
1305
1306
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1303

def replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name(name, body, opts = {})
  data, _status_code, _headers = replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, body, opts)
  data
end

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

replace the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1317

def replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#replace_service_cidr_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status(name, body, opts = {}) ⇒ V1beta1ServiceCIDR

replace status of the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - 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:



1382
1383
1384
1385
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1382

def replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status(name, body, opts = {})
  data, _status_code, _headers = replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, body, opts)
  data
end

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

replace status of the specified ServiceCIDR

Parameters:

  • name (String)

    name of the ServiceCIDR

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

    the optional parameters

Options Hash (opts):

  • :pretty (String)

    If &#39;true&#39;, then the output is pretty printed. Defaults to &#39;false&#39; unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

  • :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. 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. - 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 in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Returns:

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

    V1beta1ServiceCIDR data, response status code and response headers



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
# File 'lib/kubernetes/api/networking_v1beta1_api.rb', line 1396

def replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkingV1beta1Api.replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NetworkingV1beta1Api.replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NetworkingV1beta1Api.replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status"
  end
  # resource path
  local_var_path = '/apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
  query_params[:'fieldManager'] = opts[:'field_manager'] if !opts[:'field_manager'].nil?
  query_params[:'fieldValidation'] = opts[:'field_validation'] if !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', 'application/cbor'])

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

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

  new_options = opts.merge(
    :operation => :"NetworkingV1beta1Api.replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 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: NetworkingV1beta1Api#replace_service_cidr_status_put_apis_networking_k8s_io_v1beta1_servicecidrs_by_name_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end