com.google.api.services.compute.model

Class CacheKeyPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.CacheKeyPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CacheKeyPolicy
extends GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CacheKeyPolicy()

Method Summary

Modifier and Type	Method and Description
CacheKeyPolicy	clone()
Boolean	getIncludeHost() If true, requests to different hosts will be cached separately.
List<String>	getIncludeHttpHeaders() Allows HTTP request headers (by name) to be used in the cache key.
List<String>	getIncludeNamedCookies() Allows HTTP cookies (by name) to be used in the cache key.
Boolean	getIncludeProtocol() If true, http and https requests will be cached separately.
Boolean	getIncludeQueryString() If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.
List<String>	getQueryStringBlacklist() Names of query string parameters to exclude in cache keys.
List<String>	getQueryStringWhitelist() Names of query string parameters to include in cache keys.
CacheKeyPolicy	set(String fieldName, Object value)
CacheKeyPolicy	setIncludeHost(Boolean includeHost) If true, requests to different hosts will be cached separately.
CacheKeyPolicy	setIncludeHttpHeaders(List<String> includeHttpHeaders) Allows HTTP request headers (by name) to be used in the cache key.
CacheKeyPolicy	setIncludeNamedCookies(List<String> includeNamedCookies) Allows HTTP cookies (by name) to be used in the cache key.
CacheKeyPolicy	setIncludeProtocol(Boolean includeProtocol) If true, http and https requests will be cached separately.
CacheKeyPolicy	setIncludeQueryString(Boolean includeQueryString) If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.
CacheKeyPolicy	setQueryStringBlacklist(List<String> queryStringBlacklist) Names of query string parameters to exclude in cache keys.
CacheKeyPolicy	setQueryStringWhitelist(List<String> queryStringWhitelist) Names of query string parameters to include in cache keys.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CacheKeyPolicy

public CacheKeyPolicy()

Method Detail

getIncludeHost

public Boolean getIncludeHost()

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

Returns:

value or null for none

setIncludeHost

public CacheKeyPolicy setIncludeHost(Boolean includeHost)

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

Parameters:

includeHost - includeHost or null for none

getIncludeHttpHeaders

public List<String> getIncludeHttpHeaders()

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

Returns:

value or null for none

setIncludeHttpHeaders

public CacheKeyPolicy setIncludeHttpHeaders(List<String> includeHttpHeaders)

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

Parameters:

includeHttpHeaders - includeHttpHeaders or null for none

getIncludeNamedCookies

public List<String> getIncludeNamedCookies()

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.

Returns:

value or null for none

setIncludeNamedCookies

public CacheKeyPolicy setIncludeNamedCookies(List<String> includeNamedCookies)

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.

Parameters:

includeNamedCookies - includeNamedCookies or null for none

getIncludeProtocol

public Boolean getIncludeProtocol()

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

Returns:

value or null for none

setIncludeProtocol

public CacheKeyPolicy setIncludeProtocol(Boolean includeProtocol)

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

Parameters:

includeProtocol - includeProtocol or null for none

getIncludeQueryString

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

Returns:

value or null for none

setIncludeQueryString

public CacheKeyPolicy setIncludeQueryString(Boolean includeQueryString)

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.

Parameters:

includeQueryString - includeQueryString or null for none

getQueryStringBlacklist

public List<String> getQueryStringBlacklist()

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.

Returns:

value or null for none

setQueryStringBlacklist

public CacheKeyPolicy setQueryStringBlacklist(List<String> queryStringBlacklist)

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.

Parameters:

queryStringBlacklist - queryStringBlacklist or null for none

getQueryStringWhitelist

public List<String> getQueryStringWhitelist()

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.

Returns:

value or null for none

setQueryStringWhitelist

public CacheKeyPolicy setQueryStringWhitelist(List<String> queryStringWhitelist)

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.

Parameters:

queryStringWhitelist - queryStringWhitelist or null for none

set

public CacheKeyPolicy set(String fieldName,
                          Object value)

Overrides:

set in class GenericJson

clone

public CacheKeyPolicy clone()

Overrides:

clone in class GenericJson