Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::CacheKeyPolicy (v2.8.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::CacheKeyPolicy.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#include_host

def include_host() -> ::Boolean
Returns
  • (::Boolean) — If true, requests to different hosts will be cached separately.

#include_host=

def include_host=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, requests to different hosts will be cached separately.
Returns
  • (::Boolean) — If true, requests to different hosts will be cached separately.

#include_http_headers

def include_http_headers() -> ::Array<::String>
Returns
  • (::Array<::String>) — Allows HTTP request headers (by name) to be used in the cache key.

#include_http_headers=

def include_http_headers=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Allows HTTP request headers (by name) to be used in the cache key.
Returns
  • (::Array<::String>) — Allows HTTP request headers (by name) to be used in the cache key.

#include_named_cookies

def include_named_cookies() -> ::Array<::String>
Returns
  • (::Array<::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_named_cookies=

def include_named_cookies=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.
Returns
  • (::Array<::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

def include_protocol() -> ::Boolean
Returns
  • (::Boolean) — If true, http and https requests will be cached separately.

#include_protocol=

def include_protocol=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, http and https requests will be cached separately.
Returns
  • (::Boolean) — If true, http and https requests will be cached separately.

#include_query_string

def include_query_string() -> ::Boolean
Returns
  • (::Boolean) — 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.

#include_query_string=

def include_query_string=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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

def query_string_blacklist() -> ::Array<::String>
Returns
  • (::Array<::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_blacklist=

def query_string_blacklist=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.
Returns
  • (::Array<::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

def query_string_whitelist() -> ::Array<::String>
Returns
  • (::Array<::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.

#query_string_whitelist=

def query_string_whitelist=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.
Returns
  • (::Array<::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.