Compute V1 Client - Class CacheKeyPolicy (1.14.0)

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 message google.cloud.compute.v1.CacheKeyPolicy

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
bool

hasIncludeHost

clearIncludeHost

setIncludeHost

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIncludeHttpHeaders

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIncludeHttpHeaders

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getIncludeNamedCookies

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIncludeNamedCookies

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
NameDescription
var string[]
Returns
TypeDescription
$this

getIncludeProtocol

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

Returns
TypeDescription
bool

hasIncludeProtocol

clearIncludeProtocol

setIncludeProtocol

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setQueryStringBlacklist

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
NameDescription
var string[]
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setQueryStringWhitelist

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this