Struct CacheKeyPolicy 

#[non_exhaustive]
pub struct CacheKeyPolicy {
    pub include_host: Option<bool>,
    pub include_http_headers: Vec<String>,
    pub include_named_cookies: Vec<String>,
    pub include_protocol: Option<bool>,
    pub include_query_string: Option<bool>,
    pub query_string_blacklist: Vec<String>,
    pub query_string_whitelist: Vec<String>,
    /* private fields */
}

Available on crate features backend-services or region-backend-services only.

Message containing what to include in the cache key for a request for Cloud CDN.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include_host: Option<bool>

If true, requests to different hosts will be cached separately.

include_http_headers: Vec<String>

Allows HTTP request headers (by name) to be used in the cache key.

include_named_cookies: Vec<String>

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

include_protocol: Option<bool>

If true, http and https requests will be cached separately.

include_query_string: Option<bool>

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

query_string_blacklist: Vec<String>

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. ‘&’ and ‘=’ will be percent encoded and not treated as delimiters.

query_string_whitelist: Vec<String>

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. ‘&’ and ‘=’ will be percent encoded and not treated as delimiters.

Implementations

impl CacheKeyPolicy

pub fn new() -> Self

Creates a new default instance.

pub fn set_include_host<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of include_host.

Example

let x = CacheKeyPolicy::new().set_include_host(true);

pub fn set_or_clear_include_host<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of include_host.

Example

let x = CacheKeyPolicy::new().set_or_clear_include_host(Some(false));
let x = CacheKeyPolicy::new().set_or_clear_include_host(None::<bool>);

pub fn set_include_http_headers<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of include_http_headers.

Example

let x = CacheKeyPolicy::new().set_include_http_headers(["a", "b", "c"]);

pub fn set_include_named_cookies<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of include_named_cookies.

Example

let x = CacheKeyPolicy::new().set_include_named_cookies(["a", "b", "c"]);

pub fn set_include_protocol<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of include_protocol.

Example

let x = CacheKeyPolicy::new().set_include_protocol(true);

pub fn set_or_clear_include_protocol<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of include_protocol.

Example

let x = CacheKeyPolicy::new().set_or_clear_include_protocol(Some(false));
let x = CacheKeyPolicy::new().set_or_clear_include_protocol(None::<bool>);

pub fn set_include_query_string<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of include_query_string.

Example

let x = CacheKeyPolicy::new().set_include_query_string(true);

pub fn set_or_clear_include_query_string<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of include_query_string.

Example

let x = CacheKeyPolicy::new().set_or_clear_include_query_string(Some(false));
let x = CacheKeyPolicy::new().set_or_clear_include_query_string(None::<bool>);

pub fn set_query_string_blacklist<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of query_string_blacklist.

Example

let x = CacheKeyPolicy::new().set_query_string_blacklist(["a", "b", "c"]);

pub fn set_query_string_whitelist<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of query_string_whitelist.

Example

let x = CacheKeyPolicy::new().set_query_string_whitelist(["a", "b", "c"]);

Trait Implementations

impl Clone for CacheKeyPolicy

fn clone(&self) -> CacheKeyPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheKeyPolicy

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

Formats the value using the given formatter.

impl Default for CacheKeyPolicy

fn default() -> CacheKeyPolicy

Returns the “default value” for a type.

impl Message for CacheKeyPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CacheKeyPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CacheKeyPolicy