Available on crate feature
client
only.Expand description
API helpers for structured interaction with the Kubernetes API
Modules§
- admission
admission
- Contains types for implementing admission controllers.
- entry
- API helpers for get-or-create and get-and-modify patterns
Structs§
- Api
- The generic Api abstraction
- ApiResource
- Information about a Kubernetes API resource
- Attach
Params ws
- Parameters for attaching to a container in a Pod.
- Attached
Process - Represents an attached process in a container for
attach
andexec
. - Delete
Params - Common query parameters for delete calls
- Dynamic
Object - A dynamic representation of a kubernetes object
- Evict
Params - Params for evictable objects
- GetParams
- Common query parameters used in get calls
- Group
Version Kind - Core information about an API Resource.
- Group
Version Resource - Represents a type-erased object resource.
- List
Meta - ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- List
Params - Common query parameters used in list/delete calls on collections
- LogParams
- Params for logging
- NotUsed
- Empty struct for when data should be discarded
- Object
- A standard Kubernetes object with
.spec
and.status
. - Object
List - A generic Kubernetes object list
- Object
Meta - ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- Partial
Object Meta - A generic representation of any object with
ObjectMeta
. - Patch
Params - Common query parameters for patch calls
- Portforwarder
- Manages port-forwarded streams.
- Post
Params - Common query parameters for put/post calls
- Preconditions
- Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
- Request
- A Kubernetes request builder
- Scale
Spec - ScaleSpec describes the attributes of a scale subresource.
- Scale
Status - ScaleStatus represents the current status of a scale subresource.
- Terminal
Size - TerminalSize define the size of a terminal
- Type
Meta - Type information that is flattened into every kubernetes object
- Watch
Params - Common query parameters used in watch calls on collections
Enums§
- Patch
- Describes changes that should be applied to a resource
- Propagation
Policy - Propagation policy when deleting single objects
- Validation
Directive - The validation directive to use for
fieldValidation
when using server-side apply. - Version
Match - Controls how the resource version parameter is applied for list calls
- Watch
Event - A raw event returned from a watch query
Traits§
- Attach
ws
- Marker trait for objects that has attach
- Ephemeral
ws
- Marker trait for objects that support the ephemeral containers sub resource.
- Evict
- Marker trait for objects that can be evicted
- Execute
ws
- Marker trait for objects that has exec
- Log
- Marker trait for objects that has logs
- Partial
Object Meta Ext - Helper trait for converting
ObjectMeta
into usefulPartialObjectMeta
variants - Portforward
ws
- Marker trait for objects that has portforward
- Resource
- An accessor trait for a kubernetes Resource.
- Resource
Ext - Helper methods for resources.