Class BackendServiceCdnPolicy.Builder (1.56.0) 

public static final class BackendServiceCdnPolicy.Builder extends GeneratedMessageV3.Builder<BackendServiceCdnPolicy.Builder> implements BackendServiceCdnPolicyOrBuilder

Message containing Cloud CDN configuration for a backend service.

Protobuf type google.cloud.compute.v1.BackendServiceCdnPolicy

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BackendServiceCdnPolicy.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllBypassCacheOnRequestHeaders(Iterable<? extends BackendServiceCdnPolicyBypassCacheOnRequestHeader> values)

public BackendServiceCdnPolicy.Builder addAllBypassCacheOnRequestHeaders(Iterable<? extends BackendServiceCdnPolicyBypassCacheOnRequestHeader> values)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader>
Returns
Type Description
BackendServiceCdnPolicy.Builder

addAllNegativeCachingPolicy(Iterable<? extends BackendServiceCdnPolicyNegativeCachingPolicy> values)

public BackendServiceCdnPolicy.Builder addAllNegativeCachingPolicy(Iterable<? extends BackendServiceCdnPolicyNegativeCachingPolicy> values)

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.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.BackendServiceCdnPolicyNegativeCachingPolicy>
Returns
Type Description
BackendServiceCdnPolicy.Builder

addAllSignedUrlKeyNames(Iterable<String> values)

public BackendServiceCdnPolicy.Builder addAllSignedUrlKeyNames(Iterable<String> values)

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

repeated string signed_url_key_names = 371848885;

Parameter
Name Description
values Iterable<String>

The signedUrlKeyNames to add.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

addBypassCacheOnRequestHeaders(BackendServiceCdnPolicyBypassCacheOnRequestHeader value)

public BackendServiceCdnPolicy.Builder addBypassCacheOnRequestHeaders(BackendServiceCdnPolicyBypassCacheOnRequestHeader value)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
value BackendServiceCdnPolicyBypassCacheOnRequestHeader
Returns
Type Description
BackendServiceCdnPolicy.Builder

addBypassCacheOnRequestHeaders(BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

public BackendServiceCdnPolicy.Builder addBypassCacheOnRequestHeaders(BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
builderForValue BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

addBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader value)

public BackendServiceCdnPolicy.Builder addBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader value)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameters
Name Description
index int
value BackendServiceCdnPolicyBypassCacheOnRequestHeader
Returns
Type Description
BackendServiceCdnPolicy.Builder

addBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

public BackendServiceCdnPolicy.Builder addBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameters
Name Description
index int
builderForValue BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

addBypassCacheOnRequestHeadersBuilder()

public BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder addBypassCacheOnRequestHeadersBuilder()

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder

addBypassCacheOnRequestHeadersBuilder(int index)

public BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder addBypassCacheOnRequestHeadersBuilder(int index)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder

addNegativeCachingPolicy(BackendServiceCdnPolicyNegativeCachingPolicy value)

public BackendServiceCdnPolicy.Builder addNegativeCachingPolicy(BackendServiceCdnPolicyNegativeCachingPolicy value)

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.

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

Parameter
Name Description
value BackendServiceCdnPolicyNegativeCachingPolicy
Returns
Type Description
BackendServiceCdnPolicy.Builder

addNegativeCachingPolicy(BackendServiceCdnPolicyNegativeCachingPolicy.Builder builderForValue)

public BackendServiceCdnPolicy.Builder addNegativeCachingPolicy(BackendServiceCdnPolicyNegativeCachingPolicy.Builder builderForValue)

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.

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

Parameter
Name Description
builderForValue BackendServiceCdnPolicyNegativeCachingPolicy.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

addNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy value)

public BackendServiceCdnPolicy.Builder addNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy value)

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.

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

Parameters
Name Description
index int
value BackendServiceCdnPolicyNegativeCachingPolicy
Returns
Type Description
BackendServiceCdnPolicy.Builder

addNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy.Builder builderForValue)

public BackendServiceCdnPolicy.Builder addNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy.Builder builderForValue)

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.

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

Parameters
Name Description
index int
builderForValue BackendServiceCdnPolicyNegativeCachingPolicy.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

addNegativeCachingPolicyBuilder()

public BackendServiceCdnPolicyNegativeCachingPolicy.Builder addNegativeCachingPolicyBuilder()

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.

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

Returns
Type Description
BackendServiceCdnPolicyNegativeCachingPolicy.Builder

addNegativeCachingPolicyBuilder(int index)

public BackendServiceCdnPolicyNegativeCachingPolicy.Builder addNegativeCachingPolicyBuilder(int index)

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.

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

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyNegativeCachingPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceCdnPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

addSignedUrlKeyNames(String value)

public BackendServiceCdnPolicy.Builder addSignedUrlKeyNames(String value)

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

repeated string signed_url_key_names = 371848885;

Parameter
Name Description
value String

The signedUrlKeyNames to add.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

addSignedUrlKeyNamesBytes(ByteString value)

public BackendServiceCdnPolicy.Builder addSignedUrlKeyNamesBytes(ByteString value)

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

repeated string signed_url_key_names = 371848885;

Parameter
Name Description
value ByteString

The bytes of the signedUrlKeyNames to add.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

build()

public BackendServiceCdnPolicy build()
Returns
Type Description
BackendServiceCdnPolicy

buildPartial()

public BackendServiceCdnPolicy buildPartial()
Returns
Type Description
BackendServiceCdnPolicy

clear()

public BackendServiceCdnPolicy.Builder clear()
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

clearBypassCacheOnRequestHeaders()

public BackendServiceCdnPolicy.Builder clearBypassCacheOnRequestHeaders()

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
BackendServiceCdnPolicy.Builder

clearCacheKeyPolicy()

public BackendServiceCdnPolicy.Builder clearCacheKeyPolicy()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
BackendServiceCdnPolicy.Builder

clearCacheMode()

public BackendServiceCdnPolicy.Builder clearCacheMode()

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. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearClientTtl()

public BackendServiceCdnPolicy.Builder clearClientTtl()

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

optional int32 client_ttl = 29034360;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearDefaultTtl()

public BackendServiceCdnPolicy.Builder clearDefaultTtl()

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.

optional int32 default_ttl = 100253422;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackendServiceCdnPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

clearMaxTtl()

public BackendServiceCdnPolicy.Builder clearMaxTtl()

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.

optional int32 max_ttl = 307578001;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearNegativeCaching()

public BackendServiceCdnPolicy.Builder clearNegativeCaching()

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.

optional bool negative_caching = 336110005;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearNegativeCachingPolicy()

public BackendServiceCdnPolicy.Builder clearNegativeCachingPolicy()

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.

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

Returns
Type Description
BackendServiceCdnPolicy.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendServiceCdnPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

clearRequestCoalescing()

public BackendServiceCdnPolicy.Builder clearRequestCoalescing()

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

optional bool request_coalescing = 532808276;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearServeWhileStale()

public BackendServiceCdnPolicy.Builder clearServeWhileStale()

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.

optional int32 serve_while_stale = 236682203;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearSignedUrlCacheMaxAgeSec()

public BackendServiceCdnPolicy.Builder clearSignedUrlCacheMaxAgeSec()

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.

optional int64 signed_url_cache_max_age_sec = 269374534;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clearSignedUrlKeyNames()

public BackendServiceCdnPolicy.Builder clearSignedUrlKeyNames()

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

repeated string signed_url_key_names = 371848885;

Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

clone()

public BackendServiceCdnPolicy.Builder clone()
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

getBypassCacheOnRequestHeaders(int index)

public BackendServiceCdnPolicyBypassCacheOnRequestHeader getBypassCacheOnRequestHeaders(int index)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyBypassCacheOnRequestHeader

getBypassCacheOnRequestHeadersBuilder(int index)

public BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder getBypassCacheOnRequestHeadersBuilder(int index)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder

getBypassCacheOnRequestHeadersBuilderList()

public List<BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder> getBypassCacheOnRequestHeadersBuilderList()

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
List<Builder>

getBypassCacheOnRequestHeadersCount()

public int getBypassCacheOnRequestHeadersCount()

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
int

getBypassCacheOnRequestHeadersList()

public List<BackendServiceCdnPolicyBypassCacheOnRequestHeader> getBypassCacheOnRequestHeadersList()

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
List<BackendServiceCdnPolicyBypassCacheOnRequestHeader>

getBypassCacheOnRequestHeadersOrBuilder(int index)

public BackendServiceCdnPolicyBypassCacheOnRequestHeaderOrBuilder getBypassCacheOnRequestHeadersOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyBypassCacheOnRequestHeaderOrBuilder

getBypassCacheOnRequestHeadersOrBuilderList()

public List<? extends BackendServiceCdnPolicyBypassCacheOnRequestHeaderOrBuilder> getBypassCacheOnRequestHeadersOrBuilderList()

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

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

getCacheKeyPolicy()

public CacheKeyPolicy getCacheKeyPolicy()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
CacheKeyPolicy

The cacheKeyPolicy.

getCacheKeyPolicyBuilder()

public CacheKeyPolicy.Builder getCacheKeyPolicyBuilder()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
CacheKeyPolicy.Builder

getCacheKeyPolicyOrBuilder()

public CacheKeyPolicyOrBuilder getCacheKeyPolicyOrBuilder()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
CacheKeyPolicyOrBuilder

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. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Returns
Type Description
String

The cacheMode.

getCacheModeBytes()

public ByteString getCacheModeBytes()

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

optional int32 client_ttl = 29034360;

Returns
Type Description
int

The clientTtl.

getDefaultInstanceForType()

public BackendServiceCdnPolicy getDefaultInstanceForType()
Returns
Type Description
BackendServiceCdnPolicy

getDefaultTtl()

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

optional int32 default_ttl = 100253422;

Returns
Type Description
int

The defaultTtl.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMaxTtl()

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

optional int32 max_ttl = 307578001;

Returns
Type Description
int

The maxTtl.

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.

optional bool negative_caching = 336110005;

Returns
Type Description
boolean

The negativeCaching.

getNegativeCachingPolicy(int index)

public BackendServiceCdnPolicyNegativeCachingPolicy getNegativeCachingPolicy(int index)

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.

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

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyNegativeCachingPolicy

getNegativeCachingPolicyBuilder(int index)

public BackendServiceCdnPolicyNegativeCachingPolicy.Builder getNegativeCachingPolicyBuilder(int index)

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.

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

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyNegativeCachingPolicy.Builder

getNegativeCachingPolicyBuilderList()

public List<BackendServiceCdnPolicyNegativeCachingPolicy.Builder> getNegativeCachingPolicyBuilderList()

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.

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

Returns
Type Description
List<Builder>

getNegativeCachingPolicyCount()

public int getNegativeCachingPolicyCount()

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.

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

Returns
Type Description
int

getNegativeCachingPolicyList()

public List<BackendServiceCdnPolicyNegativeCachingPolicy> getNegativeCachingPolicyList()

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.

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

Returns
Type Description
List<BackendServiceCdnPolicyNegativeCachingPolicy>

getNegativeCachingPolicyOrBuilder(int index)

public BackendServiceCdnPolicyNegativeCachingPolicyOrBuilder getNegativeCachingPolicyOrBuilder(int index)

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.

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

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicyNegativeCachingPolicyOrBuilder

getNegativeCachingPolicyOrBuilderList()

public List<? extends BackendServiceCdnPolicyNegativeCachingPolicyOrBuilder> getNegativeCachingPolicyOrBuilderList()

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.

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

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

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.

optional bool request_coalescing = 532808276;

Returns
Type Description
boolean

The requestCoalescing.

getServeWhileStale()

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

optional int32 serve_while_stale = 236682203;

Returns
Type Description
int

The serveWhileStale.

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.

optional int64 signed_url_cache_max_age_sec = 269374534;

Returns
Type Description
long

The signedUrlCacheMaxAgeSec.

getSignedUrlKeyNames(int index)

public String getSignedUrlKeyNames(int index)

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

repeated string signed_url_key_names = 371848885;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The signedUrlKeyNames at the given index.

getSignedUrlKeyNamesBytes(int index)

public ByteString getSignedUrlKeyNamesBytes(int index)

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

repeated string signed_url_key_names = 371848885;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the signedUrlKeyNames at the given index.

getSignedUrlKeyNamesCount()

public int getSignedUrlKeyNamesCount()

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

repeated string signed_url_key_names = 371848885;

Returns
Type Description
int

The count of signedUrlKeyNames.

getSignedUrlKeyNamesList()

public ProtocolStringList getSignedUrlKeyNamesList()

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

repeated string signed_url_key_names = 371848885;

Returns
Type Description
ProtocolStringList

A list containing the signedUrlKeyNames.

hasCacheKeyPolicy()

public boolean hasCacheKeyPolicy()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
boolean

Whether the cacheKeyPolicy field is set.

hasCacheMode()

public boolean hasCacheMode()

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. 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 boolean hasClientTtl()

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

optional int32 client_ttl = 29034360;

Returns
Type Description
boolean

Whether the clientTtl field is set.

hasDefaultTtl()

public boolean hasDefaultTtl()

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.

optional int32 default_ttl = 100253422;

Returns
Type Description
boolean

Whether the defaultTtl field is set.

hasMaxTtl()

public boolean hasMaxTtl()

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.

optional int32 max_ttl = 307578001;

Returns
Type Description
boolean

Whether the maxTtl field is set.

hasNegativeCaching()

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

optional bool negative_caching = 336110005;

Returns
Type Description
boolean

Whether the negativeCaching field is set.

hasRequestCoalescing()

public boolean hasRequestCoalescing()

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

optional bool request_coalescing = 532808276;

Returns
Type Description
boolean

Whether the requestCoalescing field is set.

hasServeWhileStale()

public 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-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.

optional int32 serve_while_stale = 236682203;

Returns
Type Description
boolean

Whether the serveWhileStale field is set.

hasSignedUrlCacheMaxAgeSec()

public boolean hasSignedUrlCacheMaxAgeSec()

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.

optional int64 signed_url_cache_max_age_sec = 269374534;

Returns
Type Description
boolean

Whether the signedUrlCacheMaxAgeSec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCacheKeyPolicy(CacheKeyPolicy value)

public BackendServiceCdnPolicy.Builder mergeCacheKeyPolicy(CacheKeyPolicy value)

The CacheKeyPolicy for this CdnPolicy.

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

Parameter
Name Description
value CacheKeyPolicy
Returns
Type Description
BackendServiceCdnPolicy.Builder

mergeFrom(BackendServiceCdnPolicy other)

public BackendServiceCdnPolicy.Builder mergeFrom(BackendServiceCdnPolicy other)
Parameter
Name Description
other BackendServiceCdnPolicy
Returns
Type Description
BackendServiceCdnPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendServiceCdnPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BackendServiceCdnPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceCdnPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

removeBypassCacheOnRequestHeaders(int index)

public BackendServiceCdnPolicy.Builder removeBypassCacheOnRequestHeaders(int index)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicy.Builder

removeNegativeCachingPolicy(int index)

public BackendServiceCdnPolicy.Builder removeNegativeCachingPolicy(int index)

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.

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

Parameter
Name Description
index int
Returns
Type Description
BackendServiceCdnPolicy.Builder

setBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader value)

public BackendServiceCdnPolicy.Builder setBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader value)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameters
Name Description
index int
value BackendServiceCdnPolicyBypassCacheOnRequestHeader
Returns
Type Description
BackendServiceCdnPolicy.Builder

setBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

public BackendServiceCdnPolicy.Builder setBypassCacheOnRequestHeaders(int index, BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

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.

repeated .google.cloud.compute.v1.BackendServiceCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameters
Name Description
index int
builderForValue BackendServiceCdnPolicyBypassCacheOnRequestHeader.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

setCacheKeyPolicy(CacheKeyPolicy value)

public BackendServiceCdnPolicy.Builder setCacheKeyPolicy(CacheKeyPolicy value)

The CacheKeyPolicy for this CdnPolicy.

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

Parameter
Name Description
value CacheKeyPolicy
Returns
Type Description
BackendServiceCdnPolicy.Builder

setCacheKeyPolicy(CacheKeyPolicy.Builder builderForValue)

public BackendServiceCdnPolicy.Builder setCacheKeyPolicy(CacheKeyPolicy.Builder builderForValue)

The CacheKeyPolicy for this CdnPolicy.

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

Parameter
Name Description
builderForValue CacheKeyPolicy.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

setCacheMode(String value)

public BackendServiceCdnPolicy.Builder setCacheMode(String value)

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. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Parameter
Name Description
value String

The cacheMode to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setCacheModeBytes(ByteString value)

public BackendServiceCdnPolicy.Builder setCacheModeBytes(ByteString value)

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. Check the CacheMode enum for the list of possible values.

optional string cache_mode = 28877888;

Parameter
Name Description
value ByteString

The bytes for cacheMode to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setClientTtl(int value)

public BackendServiceCdnPolicy.Builder setClientTtl(int value)

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

optional int32 client_ttl = 29034360;

Parameter
Name Description
value int

The clientTtl to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setDefaultTtl(int value)

public BackendServiceCdnPolicy.Builder setDefaultTtl(int value)

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.

optional int32 default_ttl = 100253422;

Parameter
Name Description
value int

The defaultTtl to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceCdnPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

setMaxTtl(int value)

public BackendServiceCdnPolicy.Builder setMaxTtl(int value)

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.

optional int32 max_ttl = 307578001;

Parameter
Name Description
value int

The maxTtl to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setNegativeCaching(boolean value)

public BackendServiceCdnPolicy.Builder setNegativeCaching(boolean value)

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.

optional bool negative_caching = 336110005;

Parameter
Name Description
value boolean

The negativeCaching to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy value)

public BackendServiceCdnPolicy.Builder setNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy value)

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.

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

Parameters
Name Description
index int
value BackendServiceCdnPolicyNegativeCachingPolicy
Returns
Type Description
BackendServiceCdnPolicy.Builder

setNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy.Builder builderForValue)

public BackendServiceCdnPolicy.Builder setNegativeCachingPolicy(int index, BackendServiceCdnPolicyNegativeCachingPolicy.Builder builderForValue)

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.

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

Parameters
Name Description
index int
builderForValue BackendServiceCdnPolicyNegativeCachingPolicy.Builder
Returns
Type Description
BackendServiceCdnPolicy.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackendServiceCdnPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides

setRequestCoalescing(boolean value)

public BackendServiceCdnPolicy.Builder setRequestCoalescing(boolean value)

If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.

optional bool request_coalescing = 532808276;

Parameter
Name Description
value boolean

The requestCoalescing to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setServeWhileStale(int value)

public BackendServiceCdnPolicy.Builder setServeWhileStale(int value)

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.

optional int32 serve_while_stale = 236682203;

Parameter
Name Description
value int

The serveWhileStale to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setSignedUrlCacheMaxAgeSec(long value)

public BackendServiceCdnPolicy.Builder setSignedUrlCacheMaxAgeSec(long value)

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.

optional int64 signed_url_cache_max_age_sec = 269374534;

Parameter
Name Description
value long

The signedUrlCacheMaxAgeSec to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setSignedUrlKeyNames(int index, String value)

public BackendServiceCdnPolicy.Builder setSignedUrlKeyNames(int index, String value)

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

repeated string signed_url_key_names = 371848885;

Parameters
Name Description
index int

The index to set the value at.
value String

The signedUrlKeyNames to set.
Returns
Type Description
BackendServiceCdnPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceCdnPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackendServiceCdnPolicy.Builder
Overrides