Reference documentation and code samples for the Compute V1 Client class CacheKeyPolicy.
Message containing what to include in the cache key for a request for Cloud CDN.
Generated from protobuf messagegoogle.cloud.compute.v1.CacheKeyPolicy
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ include_host
bool
If true, requests to different hosts will be cached separately.
↳ include_http_headers
array
Allows HTTP request headers (by name) to be used in the cache key.
↳ include_named_cookies
array
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
bool
If true, http and https requests will be cached separately.
↳ include_query_string
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
array
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
array
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.
getIncludeHost
If true, requests to different hosts will be cached separately.
Returns
Type
Description
bool
hasIncludeHost
clearIncludeHost
setIncludeHost
If true, requests to different hosts will be cached separately.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getIncludeHttpHeaders
Allows HTTP request headers (by name) to be used in the cache key.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getIncludeProtocol
If true, http and https requests will be cached separately.
Returns
Type
Description
bool
hasIncludeProtocol
clearIncludeProtocol
setIncludeProtocol
If true, http and https requests will be cached separately.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getIncludeQueryString
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
Type
Description
bool
hasIncludeQueryString
clearIncludeQueryString
setIncludeQueryString
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getQueryStringBlacklist
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.
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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getQueryStringWhitelist
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class CacheKeyPolicy (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.CacheKeyPolicy)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.CacheKeyPolicy)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.CacheKeyPolicy)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.CacheKeyPolicy)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.CacheKeyPolicy)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.CacheKeyPolicy)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.CacheKeyPolicy)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.CacheKeyPolicy)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.CacheKeyPolicy)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.CacheKeyPolicy)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.CacheKeyPolicy)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.CacheKeyPolicy)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.CacheKeyPolicy)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.CacheKeyPolicy)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.CacheKeyPolicy)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.CacheKeyPolicy)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.CacheKeyPolicy)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.CacheKeyPolicy)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.CacheKeyPolicy)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.CacheKeyPolicy)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.CacheKeyPolicy)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.CacheKeyPolicy)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.CacheKeyPolicy)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.CacheKeyPolicy)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.CacheKeyPolicy)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.CacheKeyPolicy)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.CacheKeyPolicy)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.CacheKeyPolicy)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.CacheKeyPolicy)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.CacheKeyPolicy) \nReference documentation and code samples for the Compute V1 Client class CacheKeyPolicy.\n\nMessage containing what to include in the cache key for a request for Cloud CDN.\n\nGenerated from protobuf message `google.cloud.compute.v1.CacheKeyPolicy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIncludeHost\n\nIf true, requests to different hosts will be cached separately.\n\n### hasIncludeHost\n\n### clearIncludeHost\n\n### setIncludeHost\n\nIf true, requests to different hosts will be cached separately.\n\n### getIncludeHttpHeaders\n\nAllows HTTP request headers (by name) to be used in the cache key.\n\n### setIncludeHttpHeaders\n\nAllows HTTP request headers (by name) to be used in the cache key.\n\n### getIncludeNamedCookies\n\nAllows 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.\n\n### setIncludeNamedCookies\n\nAllows 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.\n\n### getIncludeProtocol\n\nIf true, http and https requests will be cached separately.\n\n### hasIncludeProtocol\n\n### clearIncludeProtocol\n\n### setIncludeProtocol\n\nIf true, http and https requests will be cached separately.\n\n### getIncludeQueryString\n\nIf 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.\n\n### hasIncludeQueryString\n\n### clearIncludeQueryString\n\n### setIncludeQueryString\n\nIf 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.\n\n### getQueryStringBlacklist\n\nNames 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.\n\n### setQueryStringBlacklist\n\nNames 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.\n\n### getQueryStringWhitelist\n\nNames 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.\n\n### setQueryStringWhitelist\n\nNames 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."]]
