com.google.api.services.compute.model

Class CachePolicyCacheKeyPolicy

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CachePolicyCacheKeyPolicy
extends com.google.api.client.json.GenericJson

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

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

com.google.api.client.util.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
CachePolicyCacheKeyPolicy()

Method Summary

Modifier and Type	Method and Description
CachePolicyCacheKeyPolicy	clone()
List<String>	getExcludedQueryParameters() Names of query string parameters to exclude in cache keys.
List<String>	getIncludedCookieNames() Allows HTTP cookies (by name) to be used in the cache key.
List<String>	getIncludedHeaderNames() Allows HTTP request headers (by name) to be used in the cache key.
List<String>	getIncludedQueryParameters() Names of query string parameters to include in cache keys.
Boolean	getIncludeHost() If true, requests to different hosts will be cached separately.
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 `includedQueryParameters` and `excludedQueryParameters`.
CachePolicyCacheKeyPolicy	set(String fieldName, Object value)
CachePolicyCacheKeyPolicy	setExcludedQueryParameters(List<String> excludedQueryParameters) Names of query string parameters to exclude in cache keys.
CachePolicyCacheKeyPolicy	setIncludedCookieNames(List<String> includedCookieNames) Allows HTTP cookies (by name) to be used in the cache key.
CachePolicyCacheKeyPolicy	setIncludedHeaderNames(List<String> includedHeaderNames) Allows HTTP request headers (by name) to be used in the cache key.
CachePolicyCacheKeyPolicy	setIncludedQueryParameters(List<String> includedQueryParameters) Names of query string parameters to include in cache keys.
CachePolicyCacheKeyPolicy	setIncludeHost(Boolean includeHost) If true, requests to different hosts will be cached separately.
CachePolicyCacheKeyPolicy	setIncludeProtocol(Boolean includeProtocol) If true, http and https requests will be cached separately.
CachePolicyCacheKeyPolicy	setIncludeQueryString(Boolean includeQueryString) If true, include query string parameters in the cache key according to `includedQueryParameters` and `excludedQueryParameters`.

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

CachePolicyCacheKeyPolicy

public CachePolicyCacheKeyPolicy()

Method Detail

getExcludedQueryParameters

public List<String> getExcludedQueryParameters()

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.

Returns:

value or null for none

setExcludedQueryParameters

public CachePolicyCacheKeyPolicy setExcludedQueryParameters(List<String> excludedQueryParameters)

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.

Parameters:

excludedQueryParameters - excludedQueryParameters or null for none

getIncludeHost

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

Returns:

value or null for none

setIncludeHost

public CachePolicyCacheKeyPolicy setIncludeHost(Boolean includeHost)

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.

Parameters:

includeHost - includeHost or null for none

getIncludeProtocol

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

Returns:

value or null for none

setIncludeProtocol

public CachePolicyCacheKeyPolicy setIncludeProtocol(Boolean includeProtocol)

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.

Parameters:

includeProtocol - includeProtocol or null for none

getIncludeQueryString

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

Returns:

value or null for none

setIncludeQueryString

public CachePolicyCacheKeyPolicy setIncludeQueryString(Boolean includeQueryString)

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.

Parameters:

includeQueryString - includeQueryString or null for none

getIncludedCookieNames

public List<String> getIncludedCookieNames()

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.

Returns:

value or null for none

setIncludedCookieNames

public CachePolicyCacheKeyPolicy setIncludedCookieNames(List<String> includedCookieNames)

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.

Parameters:

includedCookieNames - includedCookieNames or null for none

getIncludedHeaderNames

public List<String> getIncludedHeaderNames()

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

Returns:

value or null for none

setIncludedHeaderNames

public CachePolicyCacheKeyPolicy setIncludedHeaderNames(List<String> includedHeaderNames)

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

Parameters:

includedHeaderNames - includedHeaderNames or null for none

getIncludedQueryParameters

public List<String> getIncludedQueryParameters()

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.

Returns:

value or null for none

setIncludedQueryParameters

public CachePolicyCacheKeyPolicy setIncludedQueryParameters(List<String> includedQueryParameters)

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.

Parameters:

includedQueryParameters - includedQueryParameters or null for none

set

public CachePolicyCacheKeyPolicy set(String fieldName,
                                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CachePolicyCacheKeyPolicy clone()

Overrides:

clone in class com.google.api.client.json.GenericJson