You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These are common to spec-generated clients of all languages, but it helps Rust devs who haven't used the other languages' clients before.
Resource types are under api, etc, then under modules corresponding to the API group and version, like core/v1/Pod -> core::v1::Pod
Functions are associated with the relevant resource type. Eg functions dealing with pods are found in api::core::v1::Pod's docs.
Exceptions: Subresources like Status or pod logs are returned by functions of the base resource, eq Foo::read_*_status or Pod::read_namespaced_pod_log.
Exceptions to the exceptions: Some subresources like api::authentication::v1::TokenRequest and api::core::v1::Binding are created from functions associated with their own type (TokenRequest::create_namespaced_service_account_token and Binding::create_namespaced_pod_binding respectively) instead of the parent resource's type.
Create a resource with create_*. Get an existing resource with read_*. Update with patch_*. Delete with delete_*. Delete a collection with delete_collection_*. Get a list of resources with list_*. Watch with watch_*.
_namespaced_ in the function name is just a convention for resources that are namespaced. (Are there resources that have both _namespaced_ and non-_namespaced_ functions to compare with?)
The text was updated successfully, but these errors were encountered:
These are common to spec-generated clients of all languages, but it helps Rust devs who haven't used the other languages' clients before.
Resource types are under
api
, etc, then under modules corresponding to the API group and version, likecore/v1/Pod
->core::v1::Pod
Functions are associated with the relevant resource type. Eg functions dealing with pods are found in
api::core::v1::Pod
's docs.Exceptions: Subresources like
Status
or pod logs are returned by functions of the base resource, eqFoo::read_*_status
orPod::read_namespaced_pod_log
.Exceptions to the exceptions: Some subresources like
api::authentication::v1::TokenRequest
andapi::core::v1::Binding
are created from functions associated with their own type (TokenRequest::create_namespaced_service_account_token
andBinding::create_namespaced_pod_binding
respectively) instead of the parent resource's type.Create a resource with
create_*
. Get an existing resource withread_*
. Update withpatch_*
. Delete withdelete_*
. Delete a collection withdelete_collection_*
. Get a list of resources withlist_*
. Watch withwatch_*
._namespaced_
in the function name is just a convention for resources that are namespaced. (Are there resources that have both_namespaced_
and non-_namespaced_
functions to compare with?)The text was updated successfully, but these errors were encountered: