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
impl DeleteParams
sourcepub fn background() -> Self
pub fn background() -> Self
Construct DeleteParams
with PropagationPolicy::Background
.
This allows the garbage collector to delete the dependents in the background.
sourcepub fn foreground() -> Self
pub fn foreground() -> Self
Construct DeleteParams
with PropagationPolicy::Foreground
.
This is a cascading policy that deletes all dependents in the foreground.
sourcepub fn orphan() -> Self
pub fn orphan() -> Self
Construct DeleteParams
with PropagationPolicy::Orphan
.
This orpans the dependents.
sourcepub fn grace_period(self, secs: u32) -> Self
pub fn grace_period(self, secs: u32) -> Self
Set the duration in seconds before the object should be deleted.
sourcepub fn preconditions(self, preconditions: Preconditions) -> Self
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
impl Clone for DeleteParams
source§fn clone(&self) -> DeleteParams
fn clone(&self) -> DeleteParams
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DeleteParams
impl Debug for DeleteParams
source§impl Default for DeleteParams
impl Default for DeleteParams
source§fn default() -> DeleteParams
fn default() -> DeleteParams
source§impl PartialEq for DeleteParams
impl PartialEq for DeleteParams
source§impl Serialize for DeleteParams
impl Serialize for DeleteParams
impl StructuralPartialEq for DeleteParams
Auto Trait Implementations§
impl Freeze for DeleteParams
impl RefUnwindSafe for DeleteParams
impl Send for DeleteParams
impl Sync for DeleteParams
impl Unpin for DeleteParams
impl UnwindSafe for DeleteParams
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)