Struct google_api_proto::google::cloud::compute::v1::CacheKeyPolicy

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>,
}

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

Fields

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 include_protocol(&self) -> bool

Returns the value of include_protocol, or the default value if include_protocol is unset.

pub fn include_query_string(&self) -> bool

Returns the value of include_query_string, or the default value if include_query_string is unset.

pub fn include_host(&self) -> bool

Returns the value of include_host, or the default value if include_host is unset.

Trait Implementations

impl Clone for CacheKeyPolicy

fn clone(&self) -> CacheKeyPolicy

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for CacheKeyPolicy

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CacheKeyPolicy

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CacheKeyPolicy