Class BackendBucketCdnPolicy (1.52.0)

public final class BackendBucketCdnPolicy extends GeneratedMessageV3 implements BackendBucketCdnPolicyOrBuilder

Message containing Cloud CDN configuration for a backend bucket.

Protobuf type google.cloud.compute.v1.BackendBucketCdnPolicy

Static Fields

BYPASS_CACHE_ON_REQUEST_HEADERS_FIELD_NUMBER

public static final int BYPASS_CACHE_ON_REQUEST_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

CACHE_KEY_POLICY_FIELD_NUMBER

public static final int CACHE_KEY_POLICY_FIELD_NUMBER
Field Value
Type Description
int

CACHE_MODE_FIELD_NUMBER

public static final int CACHE_MODE_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_TTL_FIELD_NUMBER

public static final int CLIENT_TTL_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_TTL_FIELD_NUMBER

public static final int DEFAULT_TTL_FIELD_NUMBER
Field Value
Type Description
int

MAX_TTL_FIELD_NUMBER

public static final int MAX_TTL_FIELD_NUMBER
Field Value
Type Description
int

NEGATIVE_CACHING_FIELD_NUMBER

public static final int NEGATIVE_CACHING_FIELD_NUMBER
Field Value
Type Description
int

NEGATIVE_CACHING_POLICY_FIELD_NUMBER

public static final int NEGATIVE_CACHING_POLICY_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_COALESCING_FIELD_NUMBER

public static final int REQUEST_COALESCING_FIELD_NUMBER
Field Value
Type Description
int

SERVE_WHILE_STALE_FIELD_NUMBER

public static final int SERVE_WHILE_STALE_FIELD_NUMBER
Field Value
Type Description
int

SIGNED_URL_CACHE_MAX_AGE_SEC_FIELD_NUMBER

public static final int SIGNED_URL_CACHE_MAX_AGE_SEC_FIELD_NUMBER
Field Value
Type Description
int

SIGNED_URL_KEY_NAMES_FIELD_NUMBER

public static final int SIGNED_URL_KEY_NAMES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackendBucketCdnPolicy getDefaultInstance()
Returns
Type Description
BackendBucketCdnPolicy

getDescriptor()

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

newBuilder()

public static BackendBucketCdnPolicy.Builder newBuilder()
Returns
Type Description
BackendBucketCdnPolicy.Builder

newBuilder(BackendBucketCdnPolicy prototype)

public static BackendBucketCdnPolicy.Builder newBuilder(BackendBucketCdnPolicy prototype)
Parameter
Name Description
prototype BackendBucketCdnPolicy
Returns
Type Description
BackendBucketCdnPolicy.Builder

parseDelimitedFrom(InputStream input)

public static BackendBucketCdnPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendBucketCdnPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BackendBucketCdnPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackendBucketCdnPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackendBucketCdnPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackendBucketCdnPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackendBucketCdnPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendBucketCdnPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BackendBucketCdnPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendBucketCdnPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BackendBucketCdnPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackendBucketCdnPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BackendBucketCdnPolicy> parser()
Returns
Type Description
Parser<BackendBucketCdnPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBypassCacheOnRequestHeaders(int index)

public BackendBucketCdnPolicyBypassCacheOnRequestHeader 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.BackendBucketCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendBucketCdnPolicyBypassCacheOnRequestHeader

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.BackendBucketCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
int

getBypassCacheOnRequestHeadersList()

public List<BackendBucketCdnPolicyBypassCacheOnRequestHeader> 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.BackendBucketCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Returns
Type Description
List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>

getBypassCacheOnRequestHeadersOrBuilder(int index)

public BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder 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.BackendBucketCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

Parameter
Name Description
index int
Returns
Type Description
BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder

getBypassCacheOnRequestHeadersOrBuilderList()

public List<? extends BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder> 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.BackendBucketCdnPolicyBypassCacheOnRequestHeader bypass_cache_on_request_headers = 486203082;

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

getCacheKeyPolicy()

public BackendBucketCdnPolicyCacheKeyPolicy getCacheKeyPolicy()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy

The cacheKeyPolicy.

getCacheKeyPolicyOrBuilder()

public BackendBucketCdnPolicyCacheKeyPolicyOrBuilder getCacheKeyPolicyOrBuilder()

The CacheKeyPolicy for this CdnPolicy.

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

Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicyOrBuilder

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 BackendBucketCdnPolicy getDefaultInstanceForType()
Returns
Type Description
BackendBucketCdnPolicy

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.

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 BackendBucketCdnPolicyNegativeCachingPolicy 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.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter
Name Description
index int
Returns
Type Description
BackendBucketCdnPolicyNegativeCachingPolicy

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.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns
Type Description
int

getNegativeCachingPolicyList()

public List<BackendBucketCdnPolicyNegativeCachingPolicy> 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.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns
Type Description
List<BackendBucketCdnPolicyNegativeCachingPolicy>

getNegativeCachingPolicyOrBuilder(int index)

public BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder 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.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter
Name Description
index int
Returns
Type Description
BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder

getNegativeCachingPolicyOrBuilderList()

public List<? extends BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder> 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.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

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

getParserForType()

public Parser<BackendBucketCdnPolicy> getParserForType()
Returns
Type Description
Parser<BackendBucketCdnPolicy>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BackendBucketCdnPolicy.Builder newBuilderForType()
Returns
Type Description
BackendBucketCdnPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackendBucketCdnPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackendBucketCdnPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BackendBucketCdnPolicy.Builder toBuilder()
Returns
Type Description
BackendBucketCdnPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException