Interface CachePolicyCacheKeyPolicyOrBuilder (1.105.0)

1.105.0 (latest) 1.104.0 1.103.0 1.101.0 1.98.0 1.97.0 1.95.0 1.93.0 1.92.0 1.91.0 1.90.0 1.88.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.80.0 1.78.0 1.77.0 1.74.0 1.73.0 1.72.0 1.70.0 1.69.0 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.0 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 CachePolicyCacheKeyPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExcludedQueryParameters(int index)

public abstract String getExcludedQueryParameters(int index)

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.

repeated string excluded_query_parameters = 124896150;

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

Returns
Type	Description
String	The excludedQueryParameters at the given index.

getExcludedQueryParametersBytes(int index)

public abstract ByteString getExcludedQueryParametersBytes(int index)

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.

repeated string excluded_query_parameters = 124896150;

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

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

getExcludedQueryParametersCount()

public abstract int getExcludedQueryParametersCount()

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.

repeated string excluded_query_parameters = 124896150;

Returns
Type	Description
int	The count of excludedQueryParameters.

getExcludedQueryParametersList()

public abstract List<String> getExcludedQueryParametersList()

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.

repeated string excluded_query_parameters = 124896150;

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

getIncludeHost()

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

optional bool include_host = 486867679;

Returns
Type	Description
boolean	The includeHost.

getIncludeProtocol()

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

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 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.

optional bool include_query_string = 474036639;

Returns
Type	Description
boolean	The includeQueryString.

getIncludedCookieNames(int index)

public abstract String getIncludedCookieNames(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.

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.

repeated string included_cookie_names = 66987088;

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

Returns
Type	Description
String	The includedCookieNames at the given index.

getIncludedCookieNamesBytes(int index)

public abstract ByteString getIncludedCookieNamesBytes(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.

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.

repeated string included_cookie_names = 66987088;

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

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

getIncludedCookieNamesCount()

public abstract int getIncludedCookieNamesCount()

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.

repeated string included_cookie_names = 66987088;

Returns
Type	Description
int	The count of includedCookieNames.

getIncludedCookieNamesList()

public abstract List<String> getIncludedCookieNamesList()

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.

repeated string included_cookie_names = 66987088;

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

getIncludedHeaderNames(int index)

public abstract String getIncludedHeaderNames(int index)

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

repeated string included_header_names = 533756345;

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

Returns
Type	Description
String	The includedHeaderNames at the given index.

getIncludedHeaderNamesBytes(int index)

public abstract ByteString getIncludedHeaderNamesBytes(int index)

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

repeated string included_header_names = 533756345;

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

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

getIncludedHeaderNamesCount()

public abstract int getIncludedHeaderNamesCount()

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

repeated string included_header_names = 533756345;

Returns
Type	Description
int	The count of includedHeaderNames.

getIncludedHeaderNamesList()

public abstract List<String> getIncludedHeaderNamesList()

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

repeated string included_header_names = 533756345;

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

getIncludedQueryParameters(int index)

public abstract String getIncludedQueryParameters(int index)

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.

repeated string included_query_parameters = 2319076;

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

Returns
Type	Description
String	The includedQueryParameters at the given index.

getIncludedQueryParametersBytes(int index)

public abstract ByteString getIncludedQueryParametersBytes(int index)

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.

repeated string included_query_parameters = 2319076;

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

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

getIncludedQueryParametersCount()

public abstract int getIncludedQueryParametersCount()

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.

repeated string included_query_parameters = 2319076;

Returns
Type	Description
int	The count of includedQueryParameters.

getIncludedQueryParametersList()

public abstract List<String> getIncludedQueryParametersList()

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.

repeated string included_query_parameters = 2319076;

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

hasIncludeHost()

public abstract boolean hasIncludeHost()

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.

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.

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.

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 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.

optional bool include_query_string = 474036639;

Returns
Type	Description
boolean	Whether the includeQueryString field is set.