Show / Hide Table of Contents

Class CachePolicyCacheKeyPolicy

Message containing what to include in the cache key for a request for Cache Policy defined on Route Action.

Inheritance
object
CachePolicyCacheKeyPolicy
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class CachePolicyCacheKeyPolicy : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExcludedQueryParameters

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify excluded_query_parameters or included_query_parameters, 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 a part of the cache key.

Declaration
[JsonProperty("excludedQueryParameters")]
public virtual IList<string> ExcludedQueryParameters { get; set; }
Property Value
Type Description
IList<string>

IncludeHost

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.

Declaration
[JsonProperty("includeHost")]
public virtual bool? IncludeHost { get; set; }
Property Value
Type Description
bool?

IncludeProtocol

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.

Declaration
[JsonProperty("includeProtocol")]
public virtual bool? IncludeProtocol { get; set; }
Property Value
Type Description
bool?

IncludeQueryString

If true, include query string parameters in the cache key according to included_query_parameters and excluded_query_parameters. 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 a part of the cache key.

Declaration
[JsonProperty("includeQueryString")]
public virtual bool? IncludeQueryString { get; set; }
Property Value
Type Description
bool?

IncludedCookieNames

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.

Declaration
[JsonProperty("includedCookieNames")]
public virtual IList<string> IncludedCookieNames { get; set; }
Property Value
Type Description
IList<string>

IncludedHeaderNames

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

Declaration
[JsonProperty("includedHeaderNames")]
public virtual IList<string> IncludedHeaderNames { get; set; }
Property Value
Type Description
IList<string>

IncludedQueryParameters

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify included_query_parameters or excluded_query_parameters, not both. '&amp;' and '=' will be percent encoded and not treated as delimiters.

Declaration
[JsonProperty("includedQueryParameters")]
public virtual IList<string> IncludedQueryParameters { get; set; }
Property Value
Type Description
IList<string>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX