com.google.api.services.compute.model

Class CachePolicy

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Message containing CachePolicy configuration for URL Map's 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
CachePolicy()

Method Summary

Modifier and Type	Method and Description
CachePolicy	clone()
List<String>	getCacheBypassRequestHeaderNames() Bypass the cache when the specified request headers are matched by name, e.g.
CachePolicyCacheKeyPolicy	getCacheKeyPolicy() The cache key configuration.
String	getCacheMode() Specifies the cache setting for all responses from this route.
Duration	getClientTtl() Specifies a separate client (e.g.
Duration	getDefaultTtl() Specifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage).
Duration	getMaxTtl() Specifies the maximum allowed TTL for cached content.
Boolean	getNegativeCaching() Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
List<CachePolicyNegativeCachingPolicy>	getNegativeCachingPolicy() Sets a cache TTL for the specified HTTP status code.
Boolean	getRequestCoalescing() If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
Duration	getServeWhileStale() Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.
CachePolicy	set(String fieldName, Object value)
CachePolicy	setCacheBypassRequestHeaderNames(List<String> cacheBypassRequestHeaderNames) Bypass the cache when the specified request headers are matched by name, e.g.
CachePolicy	setCacheKeyPolicy(CachePolicyCacheKeyPolicy cacheKeyPolicy) The cache key configuration.
CachePolicy	setCacheMode(String cacheMode) Specifies the cache setting for all responses from this route.
CachePolicy	setClientTtl(Duration clientTtl) Specifies a separate client (e.g.
CachePolicy	setDefaultTtl(Duration defaultTtl) Specifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage).
CachePolicy	setMaxTtl(Duration maxTtl) Specifies the maximum allowed TTL for cached content.
CachePolicy	setNegativeCaching(Boolean negativeCaching) Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
CachePolicy	setNegativeCachingPolicy(List<CachePolicyNegativeCachingPolicy> negativeCachingPolicy) Sets a cache TTL for the specified HTTP status code.
CachePolicy	setRequestCoalescing(Boolean requestCoalescing) If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
CachePolicy	setServeWhileStale(Duration serveWhileStale) Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

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

CachePolicy

public CachePolicy()

Method Detail

getCacheBypassRequestHeaderNames

public List<String> getCacheBypassRequestHeaderNames()

Bypass the cache when the specified request headers are matched by name, e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 header names can be specified. The cache is bypassed for all `cacheMode` values.

Returns:

value or null for none

setCacheBypassRequestHeaderNames

public CachePolicy setCacheBypassRequestHeaderNames(List<String> cacheBypassRequestHeaderNames)

Bypass the cache when the specified request headers are matched by name, e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 header names can be specified. The cache is bypassed for all `cacheMode` values.

Parameters:

cacheBypassRequestHeaderNames - cacheBypassRequestHeaderNames or null for none

getCacheKeyPolicy

public CachePolicyCacheKeyPolicy getCacheKeyPolicy()

The cache key configuration. If not specified, the default behavior depends on the backend type: for Backend Services, the complete request URI is used; for Backend Buckets, the request URI is used without the protocol or host, and only query parameters known to Cloud Storage are included.

Returns:

value or null for none

setCacheKeyPolicy

public CachePolicy setCacheKeyPolicy(CachePolicyCacheKeyPolicy cacheKeyPolicy)

The cache key configuration. If not specified, the default behavior depends on the backend type: for Backend Services, the complete request URI is used; for Backend Buckets, the request URI is used without the protocol or host, and only query parameters known to Cloud Storage are included.

Parameters:

cacheKeyPolicy - cacheKeyPolicy or null for none

getCacheMode

public String getCacheMode()

Specifies the cache setting for all responses from this route. If not specified, Cloud CDN uses `CACHE_ALL_STATIC` mode.

Returns:

value or null for none

setCacheMode

public CachePolicy setCacheMode(String cacheMode)

Specifies the cache setting for all responses from this route. If not specified, Cloud CDN uses `CACHE_ALL_STATIC` mode.

Parameters:

cacheMode - cacheMode or null for none

getClientTtl

public Duration getClientTtl()

Specifies a separate client (e.g. browser client) maximum TTL for cached content. This is used to clamp the max-age (or Expires) value sent to the client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` is used for the response max-age directive, along with a "public" directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the `clientTtl` and `defaultTtl`, and also ensures a "public" cache-control directive is present. The maximum allowed value is 31,622,400s (1 year). If not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is `USE_ORIGIN_HEADERS`.

Returns:

value or null for none

setClientTtl

public CachePolicy setClientTtl(Duration clientTtl)

Specifies a separate client (e.g. browser client) maximum TTL for cached content. This is used to clamp the max-age (or Expires) value sent to the client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` is used for the response max-age directive, along with a "public" directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the `clientTtl` and `defaultTtl`, and also ensures a "public" cache-control directive is present. The maximum allowed value is 31,622,400s (1 year). If not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is `USE_ORIGIN_HEADERS`.

Parameters:

clientTtl - clientTtl or null for none

getDefaultTtl

public Duration getDefaultTtl()

Specifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of `defaultTtl` cannot be set to a value greater than that of `maxTtl`. When the `cacheMode` is set to `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year). Infrequently accessed objects may be evicted from the cache before the defined TTL. If not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is `USE_ORIGIN_HEADERS`.

Returns:

value or null for none

setDefaultTtl

public CachePolicy setDefaultTtl(Duration defaultTtl)

Specifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means "always revalidate". The value of `defaultTtl` cannot be set to a value greater than that of `maxTtl`. When the `cacheMode` is set to `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year). Infrequently accessed objects may be evicted from the cache before the defined TTL. If not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is `USE_ORIGIN_HEADERS`.

Parameters:

defaultTtl - defaultTtl or null for none

getMaxTtl

public Duration getMaxTtl()

Specifies the maximum allowed TTL for cached content. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than `maxTtl` seconds in the future will be capped at the value of `maxTtl`, as if it were the value of an s-maxage Cache- Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year). Infrequently accessed objects may be evicted from the cache before the defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache mode.

Returns:

value or null for none

setMaxTtl

public CachePolicy setMaxTtl(Duration maxTtl)

Specifies the maximum allowed TTL for cached content. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than `maxTtl` seconds in the future will be capped at the value of `maxTtl`, as if it were the value of an s-maxage Cache- Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year). Infrequently accessed objects may be evicted from the cache before the defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache mode.

Parameters:

maxTtl - maxTtl or null for none

getNegativeCaching

public Boolean getNegativeCaching()

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the `cacheMode` is set to `CACHE_ALL_STATIC` or `USE_ORIGIN_HEADERS`, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the `cacheMode` is set to `FORCE_CACHE_ALL`, negative caching applies to all responses with the specified response code, and overrides any caching headers. By default, Cloud CDN applies the following TTLs to these HTTP status codes: * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s * 405 (Method Not Found), 501 (Not Implemented): 60s These defaults can be overridden in `negativeCachingPolicy`. If not specified, Cloud CDN applies negative caching by default.

Returns:

value or null for none

setNegativeCaching

public CachePolicy setNegativeCaching(Boolean negativeCaching)

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the `cacheMode` is set to `CACHE_ALL_STATIC` or `USE_ORIGIN_HEADERS`, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the `cacheMode` is set to `FORCE_CACHE_ALL`, negative caching applies to all responses with the specified response code, and overrides any caching headers. By default, Cloud CDN applies the following TTLs to these HTTP status codes: * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s * 405 (Method Not Found), 501 (Not Implemented): 60s These defaults can be overridden in `negativeCachingPolicy`. If not specified, Cloud CDN applies negative caching by default.

Parameters:

negativeCaching - negativeCaching or null for none

getNegativeCachingPolicy

public List<CachePolicyNegativeCachingPolicy> getNegativeCachingPolicy()

Sets a cache TTL for the specified HTTP status code. `negativeCaching` must be enabled to configure `negativeCachingPolicy`. Omitting the policy and leaving `negativeCaching` enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit `negativeCachingPolicy`, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

Returns:

value or null for none

setNegativeCachingPolicy

public CachePolicy setNegativeCachingPolicy(List<CachePolicyNegativeCachingPolicy> negativeCachingPolicy)

Sets a cache TTL for the specified HTTP status code. `negativeCaching` must be enabled to configure `negativeCachingPolicy`. Omitting the policy and leaving `negativeCaching` enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit `negativeCachingPolicy`, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.

Parameters:

negativeCachingPolicy - negativeCachingPolicy or null for none

getRequestCoalescing

public Boolean getRequestCoalescing()

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. If not specified, Cloud CDN applies request coalescing by default.

Returns:

value or null for none

setRequestCoalescing

public CachePolicy setRequestCoalescing(Boolean requestCoalescing)

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. If not specified, Cloud CDN applies request coalescing by default.

Parameters:

requestCoalescing - requestCoalescing or null for none

getServeWhileStale

public Duration getServeWhileStale()

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max- age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

Returns:

value or null for none

setServeWhileStale

public CachePolicy setServeWhileStale(Duration serveWhileStale)

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max- age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

Parameters:

serveWhileStale - serveWhileStale or null for none

set

public CachePolicy set(String fieldName,
                       Object value)

Overrides:

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

clone

public CachePolicy clone()

Overrides:

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