Struct kumo_api_types::SuspendV1Request

pub struct SuspendV1Request {
    pub campaign: Option<String>,
    pub tenant: Option<String>,
    pub domain: Option<String>,
    pub reason: String,
    pub duration: Option<Duration>,
    pub expires: Option<DateTime<Utc>>,
}

Fields

campaign: Option<String>

The campaign name to match. If omitted, any campaign will match.

tenant: Option<String>

The tenant name to match. If omitted, any tenant will match.

domain: Option<String>

The domain name to match. If omitted, any domain will match.

reason: String

The reason for the suspension

duration: Option<Duration>

Specifies how long this suspension remains active.

expires: Option<DateTime<Utc>>

instead of specifying the duration, you can set an explicit expiration timestamp

Implementations

impl SuspendV1Request

pub fn duration(&self) -> Duration

Trait Implementations

impl Debug for SuspendV1Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SuspendV1Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SuspendV1Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for SuspendV1Request

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the [ToSchema::schema].