Interface CachePolicyOrBuilder (1.105.0)

1.105.0 (latest) 1.104.0 1.103.0 1.101.0 1.98.0 1.97.0 1.95.0 1.93.0 1.92.0 1.91.0 1.90.0 1.88.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.80.0 1.78.0 1.77.0 1.74.0 1.73.0 1.72.0 1.70.0 1.69.0 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.0 1.62.0 1.61.0 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.9.1 1.8.1 1.7.2 1.6.0-beta

public interface CachePolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCacheBypassRequestHeaderNames(int index)

public abstract String getCacheBypassRequestHeaderNames(int index)

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.

repeated string cache_bypass_request_header_names = 197581440;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The cacheBypassRequestHeaderNames at the given index.

getCacheBypassRequestHeaderNamesBytes(int index)

public abstract ByteString getCacheBypassRequestHeaderNamesBytes(int index)

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.

repeated string cache_bypass_request_header_names = 197581440;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the cacheBypassRequestHeaderNames at the given index.

getCacheBypassRequestHeaderNamesCount()

public abstract int getCacheBypassRequestHeaderNamesCount()

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.

repeated string cache_bypass_request_header_names = 197581440;

Returns
Type	Description
int	The count of cacheBypassRequestHeaderNames.

getCacheBypassRequestHeaderNamesList()

public abstract List<String> getCacheBypassRequestHeaderNamesList()

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.

repeated string cache_bypass_request_header_names = 197581440;

Returns
Type	Description
List<String>	A list containing the cacheBypassRequestHeaderNames.

getCacheKeyPolicy()

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

optional .google.cloud.compute.v1.CachePolicyCacheKeyPolicy cache_key_policy = 159263727;

Returns
Type	Description
CachePolicyCacheKeyPolicy	The cacheKeyPolicy.

getCacheKeyPolicyOrBuilder()

public abstract CachePolicyCacheKeyPolicyOrBuilder getCacheKeyPolicyOrBuilder()

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.

optional .google.cloud.compute.v1.CachePolicyCacheKeyPolicy cache_key_policy = 159263727;

Returns
Type	Description
CachePolicyCacheKeyPolicyOrBuilder

getCacheMode()

public abstract String getCacheMode()

Specifies the cache setting for all responses from this route. If not specified, Cloud CDN uses CACHE_ALL_STATIC mode. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Returns
Type	Description
String	The cacheMode.

getCacheModeBytes()

public abstract ByteString getCacheModeBytes()

Specifies the cache setting for all responses from this route. If not specified, Cloud CDN uses CACHE_ALL_STATIC mode. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Returns
Type	Description
ByteString	The bytes for cacheMode.

getClientTtl()

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

optional .google.cloud.compute.v1.Duration client_ttl = 29034360;

Returns
Type	Description
Duration	The clientTtl.

getClientTtlOrBuilder()

public abstract DurationOrBuilder getClientTtlOrBuilder()

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.

optional .google.cloud.compute.v1.Duration client_ttl = 29034360;

Returns
Type	Description
DurationOrBuilder

getDefaultTtl()

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

optional .google.cloud.compute.v1.Duration default_ttl = 100253422;

Returns
Type	Description
Duration	The defaultTtl.

getDefaultTtlOrBuilder()

public abstract DurationOrBuilder getDefaultTtlOrBuilder()

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.

optional .google.cloud.compute.v1.Duration default_ttl = 100253422;

Returns
Type	Description
DurationOrBuilder

getMaxTtl()

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

optional .google.cloud.compute.v1.Duration max_ttl = 307578001;

Returns
Type	Description
Duration	The maxTtl.

getMaxTtlOrBuilder()

public abstract DurationOrBuilder getMaxTtlOrBuilder()

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.

optional .google.cloud.compute.v1.Duration max_ttl = 307578001;

Returns
Type	Description
DurationOrBuilder

getNegativeCaching()

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

optional bool negative_caching = 336110005;

Returns
Type	Description
boolean	The negativeCaching.

getNegativeCachingPolicy(int index)

public abstract CachePolicyNegativeCachingPolicy getNegativeCachingPolicy(int index)

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.

repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter
Name	Description
index	int

Returns
Type	Description
CachePolicyNegativeCachingPolicy

getNegativeCachingPolicyCount()

public abstract int getNegativeCachingPolicyCount()

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.

repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns
Type	Description
int

getNegativeCachingPolicyList()

public abstract List<CachePolicyNegativeCachingPolicy> getNegativeCachingPolicyList()

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.

repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns
Type	Description
List<CachePolicyNegativeCachingPolicy>

getNegativeCachingPolicyOrBuilder(int index)

public abstract CachePolicyNegativeCachingPolicyOrBuilder getNegativeCachingPolicyOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter
Name	Description
index	int

Returns
Type	Description
CachePolicyNegativeCachingPolicyOrBuilder

getNegativeCachingPolicyOrBuilderList()

public abstract List<? extends CachePolicyNegativeCachingPolicyOrBuilder> getNegativeCachingPolicyOrBuilderList()

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.

repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.CachePolicyNegativeCachingPolicyOrBuilder>

getRequestCoalescing()

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

optional bool request_coalescing = 532808276;

Returns
Type	Description
boolean	The requestCoalescing.

getServeWhileStale()

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

optional .google.cloud.compute.v1.Duration serve_while_stale = 236682203;

Returns
Type	Description
Duration	The serveWhileStale.

getServeWhileStaleOrBuilder()

public abstract DurationOrBuilder getServeWhileStaleOrBuilder()

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.

optional .google.cloud.compute.v1.Duration serve_while_stale = 236682203;

Returns
Type	Description
DurationOrBuilder

hasCacheKeyPolicy()

public abstract boolean hasCacheKeyPolicy()

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.

optional .google.cloud.compute.v1.CachePolicyCacheKeyPolicy cache_key_policy = 159263727;

Returns
Type	Description
boolean	Whether the cacheKeyPolicy field is set.

hasCacheMode()

public abstract boolean hasCacheMode()

Specifies the cache setting for all responses from this route. If not specified, Cloud CDN uses CACHE_ALL_STATIC mode. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Returns
Type	Description
boolean	Whether the cacheMode field is set.

hasClientTtl()

public abstract boolean hasClientTtl()

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.

optional .google.cloud.compute.v1.Duration client_ttl = 29034360;

Returns
Type	Description
boolean	Whether the clientTtl field is set.

hasDefaultTtl()

public abstract boolean hasDefaultTtl()

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.

optional .google.cloud.compute.v1.Duration default_ttl = 100253422;

Returns
Type	Description
boolean	Whether the defaultTtl field is set.

hasMaxTtl()

public abstract boolean hasMaxTtl()

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.

optional .google.cloud.compute.v1.Duration max_ttl = 307578001;

Returns
Type	Description
boolean	Whether the maxTtl field is set.

hasNegativeCaching()

public abstract boolean hasNegativeCaching()

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.

optional bool negative_caching = 336110005;

Returns
Type	Description
boolean	Whether the negativeCaching field is set.

hasRequestCoalescing()

public abstract boolean hasRequestCoalescing()

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.

optional bool request_coalescing = 532808276;

Returns
Type	Description
boolean	Whether the requestCoalescing field is set.

hasServeWhileStale()

public abstract boolean hasServeWhileStale()

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.

optional .google.cloud.compute.v1.Duration serve_while_stale = 236682203;

Returns
Type	Description
boolean	Whether the serveWhileStale field is set.