Struct kube_core::params::DeleteParams

source ·
pub struct DeleteParams {
    pub dry_run: bool,
    pub grace_period_seconds: Option<u32>,
    pub propagation_policy: Option<PropagationPolicy>,
    pub preconditions: Option<Preconditions>,
}
Expand description

Common query parameters for delete calls

Fields§

§dry_run: bool

When present, indicates that modifications should not be persisted.

§grace_period_seconds: Option<u32>

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 None, the default grace period for the specified type will be used. Defaults to a per object value if not specified. Zero means delete immediately.

§propagation_policy: Option<PropagationPolicy>

Whether or how garbage collection is performed.

The default policy is decided by the existing finalizer set in metadata.finalizers, and the resource-specific default policy.

§preconditions: Option<Preconditions>

Condtions that must be fulfilled before a deletion is carried out

If not possible, a 409 Conflict status will be returned.

Implementations§

source§

impl DeleteParams

source

pub fn background() -> Self

Construct DeleteParams with PropagationPolicy::Background.

This allows the garbage collector to delete the dependents in the background.

source

pub fn foreground() -> Self

Construct DeleteParams with PropagationPolicy::Foreground.

This is a cascading policy that deletes all dependents in the foreground.

source

pub fn orphan() -> Self

Construct DeleteParams with PropagationPolicy::Orphan.

This orpans the dependents.

source

pub fn dry_run(self) -> Self

Perform a dryRun only

source

pub fn grace_period(self, secs: u32) -> Self

Set the duration in seconds before the object should be deleted.

source

pub fn preconditions(self, preconditions: Preconditions) -> Self

Set the condtions that must be fulfilled before a deletion is carried out.

Trait Implementations§

source§

impl Clone for DeleteParams

source§

fn clone(&self) -> DeleteParams

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for DeleteParams

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for DeleteParams

source§

fn default() -> DeleteParams

Returns the “default value” for a type. Read more
source§

impl PartialEq for DeleteParams

source§

fn eq(&self, other: &DeleteParams) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for DeleteParams

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for DeleteParams

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.