Compute Engine v1 API - Class CacheKeyPolicy (2.11.0)

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

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

Message containing what to include in the cache key for a request for Cloud CDN.

Inheritance

object > CacheKeyPolicy

Implements

IMessage CacheKeyPolicy, IEquatable CacheKeyPolicy, IDeepCloneable CacheKeyPolicy, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

CacheKeyPolicy()

public CacheKeyPolicy()

CacheKeyPolicy(CacheKeyPolicy)

public CacheKeyPolicy(CacheKeyPolicy other)

Parameter
Name	Description
`other`	`CacheKeyPolicy`

Properties

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.

Property Value
Type	Description
`bool`

IncludeHttpHeaders

public RepeatedField<string> IncludeHttpHeaders { get; }

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

Property Value
Type	Description
`RepeatedFieldstring`

IncludeNamedCookies

public RepeatedField<string> IncludeNamedCookies { 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.

Property Value
Type	Description
`RepeatedFieldstring`

IncludeProtocol

public bool IncludeProtocol { get; set; }

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

Property Value
Type	Description
`bool`

IncludeQueryString

public bool IncludeQueryString { get; set; }

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.

Property Value
Type	Description
`bool`

QueryStringBlacklist

public RepeatedField<string> QueryStringBlacklist { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

QueryStringWhitelist

public RepeatedField<string> QueryStringWhitelist { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`