Reference documentation and code samples for the Compute V1 Client class CachePolicyCacheKeyPolicy.
Message containing what to include in the cache key for a request for Cache Policy defined on Route Action.
Generated from protobuf message google.cloud.compute.v1.CachePolicyCacheKeyPolicy
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ excluded_query_parameters
string[]
Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify excludedQueryParameters
or includedQueryParameters
, not both. '&' and '=' will be percent encoded and not treated as delimiters. Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters
to define which parameters should be part of the cache key.
↳ include_host
bool
If true, requests to different hosts will be cached separately. Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the host is never included in a Backend Bucket's cache key. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error.
↳ include_protocol
bool
If true, http and https requests will be cached separately. Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the protocol is never included in a Backend Bucket's cache key. Attempting to set on a route that points exclusively to Backend Buckets will result in a configuration error.
↳ include_query_string
bool
If true, include query string parameters in the cache key according to includedQueryParameters
and excludedQueryParameters
. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters
to define which parameters should be part of the cache key.
↳ included_cookie_names
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. Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.
↳ included_header_names
string[]
Allows HTTP request headers (by name) to be used in the cache key.
↳ included_query_parameters
string[]
Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify includedQueryParameters
or excludedQueryParameters
, not both. '&' and '=' will be percent encoded and not treated as delimiters.
getExcludedQueryParameters
Names of query string parameters to exclude in cache keys. All other
parameters will be included. Either specify excludedQueryParameters
or includedQueryParameters
, not both. '&' and '=' will be percent
encoded and not treated as delimiters.
Note: This field applies to routes that use backend services. Attempting
to set it on a route that points exclusively to Backend Buckets will
result in a configuration error. For routes that point to a Backend
Bucket, use includedQueryParameters
to define which parameters should
be part of the cache key.
setExcludedQueryParameters
Names of query string parameters to exclude in cache keys. All other
parameters will be included. Either specify excludedQueryParameters
or includedQueryParameters
, not both. '&' and '=' will be percent
encoded and not treated as delimiters.
Note: This field applies to routes that use backend services. Attempting
to set it on a route that points exclusively to Backend Buckets will
result in a configuration error. For routes that point to a Backend
Bucket, use includedQueryParameters
to define which parameters should
be part of the cache key.
var
string[]
$this
getIncludeHost
If true, requests to different hosts will be cached separately.
Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the host is never included in a Backend Bucket's cache key. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error.
bool
hasIncludeHost
clearIncludeHost
setIncludeHost
If true, requests to different hosts will be cached separately.
Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the host is never included in a Backend Bucket's cache key. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error.
var
bool
$this
getIncludeProtocol
If true, http and https requests will be cached separately.
Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the protocol is never included in a Backend Bucket's cache key. Attempting to set on a route that points exclusively to Backend Buckets will result in a configuration error.
bool
hasIncludeProtocol
clearIncludeProtocol
setIncludeProtocol
If true, http and https requests will be cached separately.
Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the protocol is never included in a Backend Bucket's cache key. Attempting to set on a route that points exclusively to Backend Buckets will result in a configuration error.
var
bool
$this
getIncludeQueryString
If true, include query string parameters in the cache key according to includedQueryParameters
and excludedQueryParameters
. If neither
is set, the entire query string will be included. If false, the query
string will be excluded from the cache key entirely.
Note: This field applies to routes that use backend services. Attempting
to set it on a route that points exclusively to Backend Buckets will
result in a configuration error. For routes that point to a Backend
Bucket, use includedQueryParameters
to define which parameters should
be part of the cache key.
bool
hasIncludeQueryString
clearIncludeQueryString
setIncludeQueryString
If true, include query string parameters in the cache key according to includedQueryParameters
and excludedQueryParameters
. If neither
is set, the entire query string will be included. If false, the query
string will be excluded from the cache key entirely.
Note: This field applies to routes that use backend services. Attempting
to set it on a route that points exclusively to Backend Buckets will
result in a configuration error. For routes that point to a Backend
Bucket, use includedQueryParameters
to define which parameters should
be part of the cache key.
var
bool
$this
getIncludedCookieNames
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. Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.
setIncludedCookieNames
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. Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.
var
string[]
$this
getIncludedHeaderNames
Allows HTTP request headers (by name) to be used in the cache key.
setIncludedHeaderNames
Allows HTTP request headers (by name) to be used in the cache key.
var
string[]
$this
getIncludedQueryParameters
Names of query string parameters to include in cache keys. All other
parameters will be excluded. Either specify includedQueryParameters
or excludedQueryParameters
, not both. '&' and '=' will be percent
encoded and not treated as delimiters.
setIncludedQueryParameters
Names of query string parameters to include in cache keys. All other
parameters will be excluded. Either specify includedQueryParameters
or excludedQueryParameters
, not both. '&' and '=' will be percent
encoded and not treated as delimiters.
var
string[]
$this
