target.apidocs.com.google.api.services.compute.model.BackendBucketCdnPolicy.html Maven / Gradle / Ivy

Go to download







BackendBucketCdnPolicy (Compute Engine API beta-rev20220312-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class BackendBucketCdnPolicy



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class BackendBucketCdnPolicy
extends GenericJson
Message containing Cloud CDN configuration for a backend bucket.

  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


BackendBucketCdnPolicy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BackendBucketCdnPolicy
clone() 


List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>
getBypassCacheOnRequestHeaders()
Bypass the cache when the specified request headers are matched - e.g.



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



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



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



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.



BackendBucketCdnPolicy
set(String fieldName,
   Object value) 


BackendBucketCdnPolicy
setBypassCacheOnRequestHeaders(List<BackendBucketCdnPolicyBypassCacheOnRequestHeader> bypassCacheOnRequestHeaders)
Bypass the cache when the specified request headers are matched - e.g.



BackendBucketCdnPolicy
setCacheKeyPolicy(BackendBucketCdnPolicyCacheKeyPolicy cacheKeyPolicy)
The CacheKeyPolicy for this CdnPolicy.



BackendBucketCdnPolicy
setCacheMode(String cacheMode)
Specifies the cache setting for all responses from this backend.



BackendBucketCdnPolicy
setClientTtl(Integer clientTtl)
Specifies a separate client (e.g.



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



BackendBucketCdnPolicy
setMaxTtl(Integer maxTtl)
Specifies the maximum allowed TTL for cached content served by this origin.



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



BackendBucketCdnPolicy
setNegativeCachingPolicy(List<BackendBucketCdnPolicyNegativeCachingPolicy> negativeCachingPolicy)
Sets a cache TTL for the specified HTTP status code.



BackendBucketCdnPolicy
setRequestCoalescing(Boolean requestCoalescing)
If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number
 of requests to the origin.



BackendBucketCdnPolicy
setServeWhileStale(Integer 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.



BackendBucketCdnPolicy
setSignedUrlCacheMaxAgeSec(Long signedUrlCacheMaxAgeSec)
Maximum number of seconds the response to a signed URL request will be considered fresh.



BackendBucketCdnPolicy
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





BackendBucketCdnPolicy
public BackendBucketCdnPolicy()









Method Detail





getBypassCacheOnRequestHeaders
public List<BackendBucketCdnPolicyBypassCacheOnRequestHeader> getBypassCacheOnRequestHeaders()
Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization
 headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode
 settings.

Returns:
value or null for none








setBypassCacheOnRequestHeaders
public BackendBucketCdnPolicy setBypassCacheOnRequestHeaders(List<BackendBucketCdnPolicyBypassCacheOnRequestHeader> bypassCacheOnRequestHeaders)
Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization
 headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode
 settings.

Parameters:
bypassCacheOnRequestHeaders - bypassCacheOnRequestHeaders or null for none








getCacheKeyPolicy
public BackendBucketCdnPolicyCacheKeyPolicy getCacheKeyPolicy()
The CacheKeyPolicy for this CdnPolicy.

Returns:
value or null for none








setCacheKeyPolicy
public BackendBucketCdnPolicy setCacheKeyPolicy(BackendBucketCdnPolicyCacheKeyPolicy 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 BackendBucketCdnPolicy 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) maximum TTL. This is used to clamp the max-
 age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and
 default_ttl is used for the response max-age directive, along with a "public" directive. For
 cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if
 specified), or else sets the response max-age directive to the lesser of the client_ttl and
 default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is
 not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s
 (1 year).

Returns:
value or null for none








setClientTtl
public BackendBucketCdnPolicy setClientTtl(Integer clientTtl)
Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-
 age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and
 default_ttl is used for the response max-age directive, along with a "public" directive. For
 cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if
 specified), or else sets the response max-age directive to the lesser of the client_ttl and
 default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is
 not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s
 (1 year).

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








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 cache mode 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 cache mode is set to
 FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code,
 and override any caching headers. By default, Cloud CDN will apply the following default TTLs
 to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404
 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found),
 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in
 negative_caching_policy.

Returns:
value or null for none








setNegativeCaching
public BackendBucketCdnPolicy 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 cache mode 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 cache mode is set to
 FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code,
 and override any caching headers. By default, Cloud CDN will apply the following default TTLs
 to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404
 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found),
 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in
 negative_caching_policy.

Parameters:
negativeCaching - negativeCaching or null for none








getNegativeCachingPolicy
public List<BackendBucketCdnPolicyNegativeCachingPolicy> getNegativeCachingPolicy()
Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to
 configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled
 will use Cloud CDN's default cache TTLs. Note that when specifying an explicit
 negative_caching_policy, 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 BackendBucketCdnPolicy setNegativeCachingPolicy(List<BackendBucketCdnPolicyNegativeCachingPolicy> negativeCachingPolicy)
Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to
 configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled
 will use Cloud CDN's default cache TTLs. Note that when specifying an explicit
 negative_caching_policy, 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.

Returns:
value or null for none








setRequestCoalescing
public BackendBucketCdnPolicy setRequestCoalescing(Boolean requestCoalescing)
If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number
 of requests to the origin.

Parameters:
requestCoalescing - requestCoalescing or null for none








getServeWhileStale
public Integer 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-max-age) 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 BackendBucketCdnPolicy setServeWhileStale(Integer 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-max-age) 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








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 BackendBucketCdnPolicy 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 BackendBucketCdnPolicy setSignedUrlKeyNames(List<String> signedUrlKeyNames)
[Output Only] Names of the keys for signing request URLs.

Parameters:
signedUrlKeyNames - signedUrlKeyNames or null for none








set
public BackendBucketCdnPolicy set(String fieldName,
                                  Object value)

Overrides:
set in class GenericJson








clone
public BackendBucketCdnPolicy clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`BackendBucketCdnPolicy`	`clone()`
`List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>`	`getBypassCacheOnRequestHeaders()` Bypass the cache when the specified request headers are matched - e.g.
`BackendBucketCdnPolicyCacheKeyPolicy`	`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.
`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<BackendBucketCdnPolicyNegativeCachingPolicy>`	`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.
`Integer`	`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.
`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.
`BackendBucketCdnPolicy`	`set(String fieldName, Object value)`
`BackendBucketCdnPolicy`	`setBypassCacheOnRequestHeaders(List<BackendBucketCdnPolicyBypassCacheOnRequestHeader> bypassCacheOnRequestHeaders)` Bypass the cache when the specified request headers are matched - e.g.
`BackendBucketCdnPolicy`	`setCacheKeyPolicy(BackendBucketCdnPolicyCacheKeyPolicy cacheKeyPolicy)` The CacheKeyPolicy for this CdnPolicy.
`BackendBucketCdnPolicy`	`setCacheMode(String cacheMode)` Specifies the cache setting for all responses from this backend.
`BackendBucketCdnPolicy`	`setClientTtl(Integer clientTtl)` Specifies a separate client (e.g.
`BackendBucketCdnPolicy`	`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).
`BackendBucketCdnPolicy`	`setMaxTtl(Integer maxTtl)` Specifies the maximum allowed TTL for cached content served by this origin.
`BackendBucketCdnPolicy`	`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.
`BackendBucketCdnPolicy`	`setNegativeCachingPolicy(List<BackendBucketCdnPolicyNegativeCachingPolicy> negativeCachingPolicy)` Sets a cache TTL for the specified HTTP status code.
`BackendBucketCdnPolicy`	`setRequestCoalescing(Boolean requestCoalescing)` If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
`BackendBucketCdnPolicy`	`setServeWhileStale(Integer 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.
`BackendBucketCdnPolicy`	`setSignedUrlCacheMaxAgeSec(Long signedUrlCacheMaxAgeSec)` Maximum number of seconds the response to a signed URL request will be considered fresh.
`BackendBucketCdnPolicy`	`setSignedUrlKeyNames(List<String> signedUrlKeyNames)` [Output Only] Names of the keys for signing request URLs.