com.google.api.services.compute.model

Class BackendServiceCdnPolicy

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BackendServiceCdnPolicy
extends GenericJson

Message containing Cloud CDN configuration for a backend service.

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
BackendServiceCdnPolicy()

Method Summary

Modifier and Type	Method and Description
BackendServiceCdnPolicy	clone()
CacheKeyPolicy	getCacheKeyPolicy() The CacheKeyPolicy for this CdnPolicy.
String	getCacheMode() Specifies the cache setting for all responses from this backend.
Integer	getClientTtl() Specifies a separate client (e.g.
Integer	getDefaultTtl() Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
Integer	getMaxTtl() Specifies the maximum allowed TTL for cached content served by this origin.
Long	getSignedUrlCacheMaxAgeSec() Maximum number of seconds the response to a signed URL request will be considered fresh.
List<String>	getSignedUrlKeyNames() [Output Only] Names of the keys for signing request URLs.
BackendServiceCdnPolicy	set(String fieldName, Object value)
BackendServiceCdnPolicy	setCacheKeyPolicy(CacheKeyPolicy cacheKeyPolicy) The CacheKeyPolicy for this CdnPolicy.
BackendServiceCdnPolicy	setCacheMode(String cacheMode) Specifies the cache setting for all responses from this backend.
BackendServiceCdnPolicy	setClientTtl(Integer clientTtl) Specifies a separate client (e.g.
BackendServiceCdnPolicy	setDefaultTtl(Integer defaultTtl) Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).
BackendServiceCdnPolicy	setMaxTtl(Integer maxTtl) Specifies the maximum allowed TTL for cached content served by this origin.
BackendServiceCdnPolicy	setSignedUrlCacheMaxAgeSec(Long signedUrlCacheMaxAgeSec) Maximum number of seconds the response to a signed URL request will be considered fresh.
BackendServiceCdnPolicy	setSignedUrlKeyNames(List<String> signedUrlKeyNames) [Output Only] Names of the keys for signing request URLs.

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

BackendServiceCdnPolicy

public BackendServiceCdnPolicy()

Method Detail

getCacheKeyPolicy

public CacheKeyPolicy getCacheKeyPolicy()

The CacheKeyPolicy for this CdnPolicy.

Returns:

value or null for none

setCacheKeyPolicy

public BackendServiceCdnPolicy setCacheKeyPolicy(CacheKeyPolicy cacheKeyPolicy)

The CacheKeyPolicy for this CdnPolicy.

Parameters:

cacheKeyPolicy - cacheKeyPolicy or null for none

getCacheMode

public String getCacheMode()

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per- user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

Returns:

value or null for none

setCacheMode

public BackendServiceCdnPolicy setCacheMode(String cacheMode)

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per- user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.

Parameters:

cacheMode - cacheMode or null for none

getClientTtl

public Integer getClientTtl()

Specifies a separate client (e.g. browser client) TTL, separate from the TTL for Cloud CDN's edge caches. Leaving this empty will use the same cache TTL for both Cloud CDN and the client- facing response. The maximum allowed value is 86400s (1 day).

Returns:

value or null for none

setClientTtl

public BackendServiceCdnPolicy setClientTtl(Integer clientTtl)

Specifies a separate client (e.g. browser client) TTL, separate from the TTL for Cloud CDN's edge caches. Leaving this empty will use the same cache TTL for both Cloud CDN and the client- facing response. The maximum allowed value is 86400s (1 day).

Parameters:

clientTtl - clientTtl or null for none

getDefaultTtl

public Integer getDefaultTtl()

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. 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), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Returns:

value or null for none

setDefaultTtl

public BackendServiceCdnPolicy setDefaultTtl(Integer defaultTtl)

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. 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), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Parameters:

defaultTtl - defaultTtl or null for none

getMaxTtl

public Integer getMaxTtl()

Specifies the maximum allowed TTL for cached content served by this origin. 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), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Returns:

value or null for none

setMaxTtl

public BackendServiceCdnPolicy setMaxTtl(Integer maxTtl)

Specifies the maximum allowed TTL for cached content served by this origin. 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), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Parameters:

maxTtl - maxTtl or null for none

getSignedUrlCacheMaxAgeSec

public Long getSignedUrlCacheMaxAgeSec()

Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

Returns:

value or null for none

setSignedUrlCacheMaxAgeSec

public BackendServiceCdnPolicy setSignedUrlCacheMaxAgeSec(Long signedUrlCacheMaxAgeSec)

Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

Parameters:

signedUrlCacheMaxAgeSec - signedUrlCacheMaxAgeSec or null for none

getSignedUrlKeyNames

public List<String> getSignedUrlKeyNames()

[Output Only] Names of the keys for signing request URLs.

Returns:

value or null for none

setSignedUrlKeyNames

public BackendServiceCdnPolicy setSignedUrlKeyNames(List<String> signedUrlKeyNames)

[Output Only] Names of the keys for signing request URLs.

Parameters:

signedUrlKeyNames - signedUrlKeyNames or null for none

set

public BackendServiceCdnPolicy set(String fieldName,
                                   Object value)

Overrides:

set in class GenericJson

clone

public BackendServiceCdnPolicy clone()

Overrides:

clone in class GenericJson