View Source Kubegen.K8sClient.RbacAuthorizationK8sIo.V1.ClusterRole (kubegen v0.1.2)
Summary
Functions
Server-Side applies the given resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Create a resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1.
Deletes the resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
with name
.
Deletes all the resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Get the resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
by name
.
Patches the given resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
with the given json_patch
.
List resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Patches the given resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
with the given merge_patch
.
Updates the given resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Wait until the given callback
returns true for a resource of kind
clusterroles in apiVersion rbac.authorization.k8s.io/v1
Watches for events on resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Watches for events on a single resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Functions
@spec apply(update :: map(), field_manager :: String.t(), force :: boolean()) :: Kubereq.response()
Server-Side applies the given resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
In order to understand fieldManager
and force
, refer to the
Kubernetes documentation about Field Management
@spec create(resource :: map()) :: Kubereq.response()
Create a resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1.
@spec delete(name :: String.t()) :: Kubereq.response()
Deletes the resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
with name
.
@spec delete_all(opts :: keyword()) :: Kubereq.response()
Deletes all the resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Options
:field_selectors
- A list of field selectors. SeeKubereq.Step.FieldSelector
for more infos.:label_selectors
- A list of field selectors. SeeKubereq.Step.LabelSelector
for more infos.
@spec get(name :: String.t()) :: Kubereq.response()
Get the resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
by name
.
@spec json_patch(name :: String.t(), json_patch :: map()) :: Kubereq.response()
Patches the given resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
with the given json_patch
.
@spec list(opts :: keyword()) :: Kubereq.response()
List resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Options
:field_selectors
- A list of field selectors. SeeKubereq.Step.FieldSelector
for more infos.:label_selectors
- A list of field selectors. SeeKubereq.Step.LabelSelector
for more infos.
@spec merge_patch(name :: String.t(), merge_patch :: String.t()) :: Kubereq.response()
Patches the given resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
with the given merge_patch
.
@spec update(resource :: map()) :: Kubereq.response()
Updates the given resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
@spec wait_until( name :: String.t(), callback :: Kubereq.wait_until_callback(), timeout :: integer() ) :: Kubereq.wait_until_response()
Wait until the given callback
returns true for a resource of kind
clusterroles in apiVersion rbac.authorization.k8s.io/v1
Callback Args and Result
The given callback
is called with the resource as argument. If the resource
was deleted, :deleted
is passed as argument.
The callback should return a boolean.
Options
timeout
- Timeout in ms after function terminates with{:error, :timeout}
. Defaults to10_000
.
@spec watch(opts :: keyword()) :: Kubereq.watch_response()
Watches for events on resources of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Options
:resource_version
- If given, starts to stream from the givenresourceVersion
of the resource list. Otherwise starts streaming from HEAD.:stream_to
- If set to apid
, streams events to the given pid. If set to{pid, ref}
, the messages are in the form{ref, event}
.:field_selectors
- A list of field selectors. SeeKubereq.Step.FieldSelector
for more infos.:label_selectors
- A list of field selectors. SeeKubereq.Step.LabelSelector
for more infos.
@spec watch_single(name :: String.t(), opts :: keyword()) :: Kubereq.watch_response()
Watches for events on a single resource of kind clusterroles
in apiVersion
rbac.authorization.k8s.io/v1
.
Options
:resource_version
- If given, starts to stream from the givenresourceVersion
of the resource list. Otherwise starts streaming from HEAD.:stream_to
- If set to apid
, streams events to the given pid. If set to{pid, ref}
, the messages are in the form{ref, event}
.:field_selectors
- A list of field selectors. SeeKubereq.Step.FieldSelector
for more infos.:label_selectors
- A list of field selectors. SeeKubereq.Step.LabelSelector
for more infos.