Compute V1 Client - Class CacheKeyPolicy (1.5.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

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.

Generated from protobuf field optional bool include_host = 486867679;

Returns
TypeDescription
bool

hasIncludeHost

clearIncludeHost

setIncludeHost

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

Generated from protobuf field optional bool include_host = 486867679;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIncludeHttpHeaders

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

Generated from protobuf field repeated string include_http_headers = 2489606;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIncludeHttpHeaders

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

Generated from protobuf field repeated string include_http_headers = 2489606;

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.

Generated from protobuf field repeated string include_named_cookies = 87316530;

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.

Generated from protobuf field repeated string include_named_cookies = 87316530;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getIncludeProtocol

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

Generated from protobuf field optional bool include_protocol = 303507535;

Returns
TypeDescription
bool

hasIncludeProtocol

clearIncludeProtocol

setIncludeProtocol

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

Generated from protobuf field optional bool include_protocol = 303507535;

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.

Generated from protobuf field optional bool include_query_string = 474036639;

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.

Generated from protobuf field optional bool include_query_string = 474036639;

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.

Generated from protobuf field repeated string query_string_blacklist = 354964742;

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.

Generated from protobuf field repeated string query_string_blacklist = 354964742;

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.

Generated from protobuf field repeated string query_string_whitelist = 52456496;

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.

Generated from protobuf field repeated string query_string_whitelist = 52456496;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this