Interface CacheKeyPolicyOrBuilder (1.23.0)

Version 1.23.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface CacheKeyPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIncludeHost()

public abstract boolean getIncludeHost()

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

optional bool include_host = 486867679;

Returns
Type	Description
boolean	The includeHost.

getIncludeHttpHeaders(int index)

public abstract String getIncludeHttpHeaders(int index)

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

repeated string include_http_headers = 2489606;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The includeHttpHeaders at the given index.

getIncludeHttpHeadersBytes(int index)

public abstract ByteString getIncludeHttpHeadersBytes(int index)

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

repeated string include_http_headers = 2489606;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the includeHttpHeaders at the given index.

getIncludeHttpHeadersCount()

public abstract int getIncludeHttpHeadersCount()

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

repeated string include_http_headers = 2489606;

Returns
Type	Description
int	The count of includeHttpHeaders.

getIncludeHttpHeadersList()

public abstract List<String> getIncludeHttpHeadersList()

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

repeated string include_http_headers = 2489606;

Returns
Type	Description
List<String>	A list containing the includeHttpHeaders.

getIncludeNamedCookies(int index)

public abstract String getIncludeNamedCookies(int index)

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.

repeated string include_named_cookies = 87316530;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The includeNamedCookies at the given index.

getIncludeNamedCookiesBytes(int index)

public abstract ByteString getIncludeNamedCookiesBytes(int index)

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.

repeated string include_named_cookies = 87316530;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the includeNamedCookies at the given index.

getIncludeNamedCookiesCount()

public abstract int getIncludeNamedCookiesCount()

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.

repeated string include_named_cookies = 87316530;

Returns
Type	Description
int	The count of includeNamedCookies.

getIncludeNamedCookiesList()

public abstract List<String> getIncludeNamedCookiesList()

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.

repeated string include_named_cookies = 87316530;

Returns
Type	Description
List<String>	A list containing the includeNamedCookies.

getIncludeProtocol()

public abstract boolean getIncludeProtocol()

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

optional bool include_protocol = 303507535;

Returns
Type	Description
boolean	The includeProtocol.

getIncludeQueryString()

public abstract boolean 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.

optional bool include_query_string = 474036639;

Returns
Type	Description
boolean	The includeQueryString.

getQueryStringBlacklist(int index)

public abstract String getQueryStringBlacklist(int index)

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.

repeated string query_string_blacklist = 354964742;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The queryStringBlacklist at the given index.

getQueryStringBlacklistBytes(int index)

public abstract ByteString getQueryStringBlacklistBytes(int index)

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.

repeated string query_string_blacklist = 354964742;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the queryStringBlacklist at the given index.

getQueryStringBlacklistCount()

public abstract int getQueryStringBlacklistCount()

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.

repeated string query_string_blacklist = 354964742;

Returns
Type	Description
int	The count of queryStringBlacklist.

getQueryStringBlacklistList()

public abstract List<String> getQueryStringBlacklistList()

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.

repeated string query_string_blacklist = 354964742;

Returns
Type	Description
List<String>	A list containing the queryStringBlacklist.

getQueryStringWhitelist(int index)

public abstract String getQueryStringWhitelist(int index)

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.

repeated string query_string_whitelist = 52456496;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The queryStringWhitelist at the given index.

getQueryStringWhitelistBytes(int index)

public abstract ByteString getQueryStringWhitelistBytes(int index)

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.

repeated string query_string_whitelist = 52456496;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the queryStringWhitelist at the given index.

getQueryStringWhitelistCount()

public abstract int getQueryStringWhitelistCount()

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.

repeated string query_string_whitelist = 52456496;

Returns
Type	Description
int	The count of queryStringWhitelist.

getQueryStringWhitelistList()

public abstract List<String> getQueryStringWhitelistList()

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.

repeated string query_string_whitelist = 52456496;

Returns
Type	Description
List<String>	A list containing the queryStringWhitelist.

hasIncludeHost()

public abstract boolean hasIncludeHost()

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

optional bool include_host = 486867679;

Returns
Type	Description
boolean	Whether the includeHost field is set.

hasIncludeProtocol()

public abstract boolean hasIncludeProtocol()

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

optional bool include_protocol = 303507535;

Returns
Type	Description
boolean	Whether the includeProtocol field is set.

hasIncludeQueryString()

public abstract boolean hasIncludeQueryString()

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.

optional bool include_query_string = 474036639;

Returns
Type	Description
boolean	Whether the includeQueryString field is set.