Kubernetes::NetworkingV1Api

All URIs are relative to https://localhost

Method	HTTP request	Description
create_namespaced_network_policy	POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
delete_collection_namespaced_network_policy	DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
delete_namespaced_network_policy	DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
get_api_resources	GET /apis/networking.k8s.io/v1/
list_namespaced_network_policy	GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
list_network_policy_for_all_namespaces	GET /apis/networking.k8s.io/v1/networkpolicies
patch_namespaced_network_policy	PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
read_namespaced_network_policy	GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
replace_namespaced_network_policy	PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}

create_namespaced_network_policy

V1NetworkPolicy create_namespaced_network_policy(namespacebody, opts)

create a NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

body = Kubernetes::V1NetworkPolicy.new # V1NetworkPolicy | 

opts = { 
  include_uninitialized: true, # BOOLEAN | If true, partially initialized resources are included in the response.
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  dry_run: "dry_run_example" # 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
}

begin
  result = api_instance.create_namespaced_network_policy(namespacebody, opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->create_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
namespace	String	object name and auth scope, such as for teams and projects
body	V1NetworkPolicy
include_uninitialized	BOOLEAN	If true, partially initialized resources are included in the response.	[optional]
pretty	String	If 'true', then the output is pretty printed.	[optional]
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	[optional]

Return type

V1NetworkPolicy

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

delete_collection_namespaced_network_policy

V1Status delete_collection_namespaced_network_policy(namespace, opts)

delete collection of NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

opts = { 
  include_uninitialized: true, # BOOLEAN | If true, partially initialized resources are included in the response.
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  continue: "continue_example", # 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 \"next key\".  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: "field_selector_example", # String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
  label_selector: "label_selector_example", # String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
  limit: 56, # Integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` 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: "resource_version_example", # String | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
  timeout_seconds: 56, # Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
  watch: true # BOOLEAN | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
}

begin
  result = api_instance.delete_collection_namespaced_network_policy(namespace, opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->delete_collection_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
namespace	String	object name and auth scope, such as for teams and projects
include_uninitialized	BOOLEAN	If true, partially initialized resources are included in the response.	[optional]
pretty	String	If 'true', then the output is pretty printed.	[optional]
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 "next key". 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.	[optional]
field_selector	String	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
label_selector	String	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
limit	Integer	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` 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.	[optional]
resource_version	String	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]
timeout_seconds	Integer	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.	[optional]
watch	BOOLEAN	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

V1Status

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

delete_namespaced_network_policy

V1Status delete_namespaced_network_policy(name, namespace, , opts)

delete a NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

name = "name_example" # String | name of the NetworkPolicy

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

opts = { 
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  body: Kubernetes::V1DeleteOptions.new, # V1DeleteOptions | 
  dry_run: "dry_run_example", # 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: 56, # Integer | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
  orphan_dependents: true, # BOOLEAN | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
  propagation_policy: "propagation_policy_example" # 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: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
}

begin
  result = api_instance.delete_namespaced_network_policy(name, namespace, , opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->delete_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	name of the NetworkPolicy
namespace	String	object name and auth scope, such as for teams and projects
pretty	String	If 'true', then the output is pretty printed.	[optional]
body	V1DeleteOptions		[optional]
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	[optional]
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.	[optional]
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 "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.	[optional]
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: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.	[optional]

Return type

V1Status

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

get_api_resources

V1APIResourceList get_api_resources

get available resources

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

begin
  result = api_instance.get_api_resources
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->get_api_resources: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList

Authorization

BearerToken

HTTP request headers

Content-Type: application/json, application/yaml, application/vnd.kubernetes.protobuf
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

list_namespaced_network_policy

V1NetworkPolicyList list_namespaced_network_policy(namespace, opts)

list or watch objects of kind NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

opts = { 
  include_uninitialized: true, # BOOLEAN | If true, partially initialized resources are included in the response.
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  continue: "continue_example", # 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 \"next key\".  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: "field_selector_example", # String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
  label_selector: "label_selector_example", # String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
  limit: 56, # Integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` 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: "resource_version_example", # String | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
  timeout_seconds: 56, # Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
  watch: true # BOOLEAN | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
}

begin
  result = api_instance.list_namespaced_network_policy(namespace, opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->list_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
namespace	String	object name and auth scope, such as for teams and projects
include_uninitialized	BOOLEAN	If true, partially initialized resources are included in the response.	[optional]
pretty	String	If 'true', then the output is pretty printed.	[optional]
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 "next key". 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.	[optional]
field_selector	String	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
label_selector	String	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
limit	Integer	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` 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.	[optional]
resource_version	String	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]
timeout_seconds	Integer	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.	[optional]
watch	BOOLEAN	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

V1NetworkPolicyList

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

list_network_policy_for_all_namespaces

V1NetworkPolicyList list_network_policy_for_all_namespaces(opts)

list or watch objects of kind NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

opts = { 
  continue: "continue_example", # 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 \"next key\".  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: "field_selector_example", # String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
  include_uninitialized: true, # BOOLEAN | If true, partially initialized resources are included in the response.
  label_selector: "label_selector_example", # String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
  limit: 56, # Integer | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  resource_version: "resource_version_example", # String | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
  timeout_seconds: 56, # Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
  watch: true # BOOLEAN | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
}

begin
  result = api_instance.list_network_policy_for_all_namespaces(opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->list_network_policy_for_all_namespaces: #{e}"
end

Parameters

Name	Type	Description	Notes
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 "next key". 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.	[optional]
field_selector	String	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
include_uninitialized	BOOLEAN	If true, partially initialized resources are included in the response.	[optional]
label_selector	String	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
limit	Integer	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` 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.	[optional]
pretty	String	If 'true', then the output is pretty printed.	[optional]
resource_version	String	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]
timeout_seconds	Integer	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.	[optional]
watch	BOOLEAN	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

V1NetworkPolicyList

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

patch_namespaced_network_policy

V1NetworkPolicy patch_namespaced_network_policy(name, namespace, body, opts)

partially update the specified NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

name = "name_example" # String | name of the NetworkPolicy

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

body = nil # Object | 

opts = { 
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  dry_run: "dry_run_example" # 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
}

begin
  result = api_instance.patch_namespaced_network_policy(name, namespace, body, opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->patch_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	name of the NetworkPolicy
namespace	String	object name and auth scope, such as for teams and projects
body	Object
pretty	String	If 'true', then the output is pretty printed.	[optional]
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	[optional]

Return type

V1NetworkPolicy

Authorization

BearerToken

HTTP request headers

Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

read_namespaced_network_policy

V1NetworkPolicy read_namespaced_network_policy(name, namespace, , opts)

read the specified NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

name = "name_example" # String | name of the NetworkPolicy

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

opts = { 
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  exact: true, # BOOLEAN | Should the export be exact.  Exact export maintains cluster-specific fields like 'Namespace'.
  export: true # BOOLEAN | Should this value be exported.  Export strips fields that a user can not specify.
}

begin
  result = api_instance.read_namespaced_network_policy(name, namespace, , opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->read_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	name of the NetworkPolicy
namespace	String	object name and auth scope, such as for teams and projects
pretty	String	If 'true', then the output is pretty printed.	[optional]
exact	BOOLEAN	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.	[optional]
export	BOOLEAN	Should this value be exported. Export strips fields that a user can not specify.	[optional]

Return type

V1NetworkPolicy

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replace_namespaced_network_policy

V1NetworkPolicy replace_namespaced_network_policy(name, namespace, body, opts)

replace the specified NetworkPolicy

Example

# load the gem
require 'kubernetes'
# setup authorization
Kubernetes.configure do |config|
  # Configure API key authorization: BearerToken
  config.api_key['authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['authorization'] = 'Bearer'
end

api_instance = Kubernetes::NetworkingV1Api.new

name = "name_example" # String | name of the NetworkPolicy

namespace = "namespace_example" # String | object name and auth scope, such as for teams and projects

body = Kubernetes::V1NetworkPolicy.new # V1NetworkPolicy | 

opts = { 
  pretty: "pretty_example", # String | If 'true', then the output is pretty printed.
  dry_run: "dry_run_example" # 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
}

begin
  result = api_instance.replace_namespaced_network_policy(name, namespace, body, opts)
  p result
rescue Kubernetes::ApiError => e
  puts "Exception when calling NetworkingV1Api->replace_namespaced_network_policy: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	name of the NetworkPolicy
namespace	String	object name and auth scope, such as for teams and projects
body	V1NetworkPolicy
pretty	String	If 'true', then the output is pretty printed.	[optional]
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	[optional]

Return type

V1NetworkPolicy

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

Files

NetworkingV1Api.md

Latest commit

History

NetworkingV1Api.md

File metadata and controls

Kubernetes::NetworkingV1Api

create_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers

delete_collection_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers

delete_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers

get_api_resources

Example

Parameters

Return type

Authorization

HTTP request headers

list_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers

list_network_policy_for_all_namespaces

Example

Parameters

Return type

Authorization

HTTP request headers

patch_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers

read_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers

replace_namespaced_network_policy

Example

Parameters

Return type

Authorization

HTTP request headers