BackendBucketCdnPolicy class

Message containing Cloud CDN configuration for a backend bucket.

Constructors

BackendBucketCdnPolicy({List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>? bypassCacheOnRequestHeaders, BackendBucketCdnPolicyCacheKeyPolicy? cacheKeyPolicy, String? cacheMode, int? clientTtl, int? defaultTtl, int? maxTtl, bool? negativeCaching, List<BackendBucketCdnPolicyNegativeCachingPolicy>? negativeCachingPolicy, bool? requestCoalescing, int? serveWhileStale, String? signedUrlCacheMaxAgeSec, List<String>? signedUrlKeyNames})

BackendBucketCdnPolicy.fromJson(Map json_)

Properties

bypassCacheOnRequestHeaders ↔ List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>?

Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers.

getter/setter pair

cacheKeyPolicy ↔ BackendBucketCdnPolicyCacheKeyPolicy?

The CacheKeyPolicy for this CdnPolicy.

getter/setter pair

cacheMode ↔ String?

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.

getter/setter pair

clientTtl ↔ int?

Specifies a separate client (e.g. browser client) maximum TTL.

getter/setter pair

defaultTtl ↔ int?

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

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

maxTtl ↔ int?

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.

getter/setter pair

negativeCaching ↔ bool?

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), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.

getter/setter pair

negativeCachingPolicy ↔ List<BackendBucketCdnPolicyNegativeCachingPolicy>?

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.

getter/setter pair

requestCoalescing ↔ bool?

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serveWhileStale ↔ int?

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.

getter/setter pair

signedUrlCacheMaxAgeSec ↔ String?

Maximum number of seconds the response to a signed URL request will be considered fresh.

getter/setter pair

signedUrlKeyNames ↔ List<String>?

Names of the keys for signing request URLs.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited