Compute Engine v1 API - Class CachePolicyCacheKeyPolicy (3.27.0) 

public sealed class CachePolicyCacheKeyPolicy : IMessage<CachePolicyCacheKeyPolicy>, IEquatable<CachePolicyCacheKeyPolicy>, IDeepCloneable<CachePolicyCacheKeyPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class CachePolicyCacheKeyPolicy.

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

Inheritance

object > CachePolicyCacheKeyPolicy

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

CachePolicyCacheKeyPolicy()

public CachePolicyCacheKeyPolicy()

CachePolicyCacheKeyPolicy(CachePolicyCacheKeyPolicy)

public CachePolicyCacheKeyPolicy(CachePolicyCacheKeyPolicy other)
Parameter
Name Description
other CachePolicyCacheKeyPolicy

Properties

ExcludedQueryParameters

public RepeatedField<string> ExcludedQueryParameters { get; }

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.

Property Value
Type Description
RepeatedFieldstring

HasIncludeHost

public bool HasIncludeHost { get; }

Gets whether the "include_host" field is set

Property Value
Type Description
bool

HasIncludeProtocol

public bool HasIncludeProtocol { get; }

Gets whether the "include_protocol" field is set

Property Value
Type Description
bool

HasIncludeQueryString

public bool HasIncludeQueryString { get; }

Gets whether the "include_query_string" field is set

Property Value
Type Description
bool

IncludeHost

public bool IncludeHost { get; set; }

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.

Property Value
Type Description
bool

IncludeProtocol

public bool IncludeProtocol { get; set; }

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.

Property Value
Type Description
bool

IncludeQueryString

public bool IncludeQueryString { get; set; }

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.

Property Value
Type Description
bool

IncludedCookieNames

public RepeatedField<string> IncludedCookieNames { get; }

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.

Property Value
Type Description
RepeatedFieldstring

IncludedHeaderNames

public RepeatedField<string> IncludedHeaderNames { get; }

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

Property Value
Type Description
RepeatedFieldstring

IncludedQueryParameters

public RepeatedField<string> IncludedQueryParameters { get; }

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.

Property Value
Type Description
RepeatedFieldstring