Struct PurgeCacheInput

pub struct PurgeCacheInput {
    pub id: Uuid,
    pub override_cache: bool,
    pub path: Option<String>,
}

Input parameters for purging cache

JSON schema

{
 "description": "Input parameters for purging cache",
 "type": "object",
 "required": [
   "id"
 ],
 "properties": {
   "id": {
     "description": "The project ID (required, must be a valid UUID)",
     "type": "string",
     "format": "uuid"
   },
   "override_cache": {
     "description": "Whether to purge override cache instead of main cache. Defaults to false.",
     "default": false,
     "type": "boolean"
   },
   "path": {
     "description": "Optional path to purge cache for. If not provided, all cache will be purged. Query strings are automatically removed from the path.",
     "examples": [
       "/api/v1/users"
     ],
     "type": "string"
   }
 }
}

Fields

id: Uuid

The project ID (required, must be a valid UUID)

override_cache: bool

Whether to purge override cache instead of main cache. Defaults to false.

path: Option<String>

Optional path to purge cache for. If not provided, all cache will be purged. Query strings are automatically removed from the path.

Implementations

impl PurgeCacheInput

pub fn builder() -> PurgeCacheInput

Trait Implementations

impl Clone for PurgeCacheInput

fn clone(&self) -> PurgeCacheInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PurgeCacheInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PurgeCacheInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PurgeCacheInput> for PurgeCacheInput

fn from(value: &PurgeCacheInput) -> Self

Converts to this type from the input type.

impl From<PurgeCacheInput> for PurgeCacheInput

fn from(value: PurgeCacheInput) -> Self

Converts to this type from the input type.

impl JsonSchema for PurgeCacheInput

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for PurgeCacheInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PurgeCacheInput> for PurgeCacheInput

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: PurgeCacheInput) -> Result<Self, ConversionError>

Performs the conversion.