Package com.google.cloud.compute.v1

Interface CachePolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CachePolicy, CachePolicy.Builder
@Generated public interface CachePolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCacheBypassRequestHeaderNamesList

      List<String> getCacheBypassRequestHeaderNamesList()
       Bypass the cache when the specified request headers are matched by name,
 e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
 header names can be specified. The cache is bypassed for all `cacheMode`
 values.
      repeated string cache_bypass_request_header_names = 197581440;
      Returns:
      A list containing the cacheBypassRequestHeaderNames.

    • getCacheBypassRequestHeaderNamesCount

      int getCacheBypassRequestHeaderNamesCount()
       Bypass the cache when the specified request headers are matched by name,
 e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
 header names can be specified. The cache is bypassed for all `cacheMode`
 values.
      repeated string cache_bypass_request_header_names = 197581440;
      Returns:
      The count of cacheBypassRequestHeaderNames.

    • getCacheBypassRequestHeaderNames

      String getCacheBypassRequestHeaderNames(int index)
       Bypass the cache when the specified request headers are matched by name,
 e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
 header names can be specified. The cache is bypassed for all `cacheMode`
 values.
      repeated string cache_bypass_request_header_names = 197581440;
      Parameters:
      index - The index of the element to return.
      Returns:
      The cacheBypassRequestHeaderNames at the given index.

    • getCacheBypassRequestHeaderNamesBytes

      com.google.protobuf.ByteString getCacheBypassRequestHeaderNamesBytes(int index)
       Bypass the cache when the specified request headers are matched by name,
 e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
 header names can be specified. The cache is bypassed for all `cacheMode`
 values.
      repeated string cache_bypass_request_header_names = 197581440;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the cacheBypassRequestHeaderNames at the given index.

    • hasCacheKeyPolicy

      boolean hasCacheKeyPolicy()
       The cache key configuration. If not specified, the default behavior depends
 on the backend type: for Backend Services, the complete request URI is
 used; for Backend Buckets, the request URI is used without the protocol or
 host, and only query parameters known to Cloud Storage are included.
      optional .google.cloud.compute.v1.CachePolicyCacheKeyPolicy cache_key_policy = 159263727;
      Returns:
      Whether the cacheKeyPolicy field is set.

    • getCacheKeyPolicy

      CachePolicyCacheKeyPolicy getCacheKeyPolicy()
       The cache key configuration. If not specified, the default behavior depends
 on the backend type: for Backend Services, the complete request URI is
 used; for Backend Buckets, the request URI is used without the protocol or
 host, and only query parameters known to Cloud Storage are included.
      optional .google.cloud.compute.v1.CachePolicyCacheKeyPolicy cache_key_policy = 159263727;
      Returns:
      The cacheKeyPolicy.

    • getCacheKeyPolicyOrBuilder

      CachePolicyCacheKeyPolicyOrBuilder getCacheKeyPolicyOrBuilder()
       The cache key configuration. If not specified, the default behavior depends
 on the backend type: for Backend Services, the complete request URI is
 used; for Backend Buckets, the request URI is used without the protocol or
 host, and only query parameters known to Cloud Storage are included.
      optional .google.cloud.compute.v1.CachePolicyCacheKeyPolicy cache_key_policy = 159263727;

    • hasCacheMode

      boolean hasCacheMode()
       Specifies the cache setting for all responses from this route. If not
 specified, Cloud CDN uses `CACHE_ALL_STATIC` mode.
 Check the CacheMode enum for the list of possible values.
      optional string cache_mode = 28877888;
      Returns:
      Whether the cacheMode field is set.

    • getCacheMode

      String getCacheMode()
       Specifies the cache setting for all responses from this route. If not
 specified, Cloud CDN uses `CACHE_ALL_STATIC` mode.
 Check the CacheMode enum for the list of possible values.
      optional string cache_mode = 28877888;
      Returns:
      The cacheMode.

    • getCacheModeBytes

      com.google.protobuf.ByteString getCacheModeBytes()
       Specifies the cache setting for all responses from this route. If not
 specified, Cloud CDN uses `CACHE_ALL_STATIC` mode.
 Check the CacheMode enum for the list of possible values.
      optional string cache_mode = 28877888;
      Returns:
      The bytes for cacheMode.

    • hasClientTtl

      boolean hasClientTtl()
       Specifies a separate client (e.g. browser client) maximum TTL for cached
 content. This is used to clamp the max-age (or Expires) value sent to the
 client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`
 is used for the response max-age directive, along with a "public"
 directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`
 clamps the max-age from the origin (if specified), or else sets the
 response max-age directive to the lesser of the `clientTtl` and
 `defaultTtl`, and also ensures a "public" cache-control directive is
 present. The maximum allowed value is 31,622,400s (1 year). If not
 specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.
 Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is
 `USE_ORIGIN_HEADERS`.
      optional .google.cloud.compute.v1.Duration client_ttl = 29034360;
      Returns:
      Whether the clientTtl field is set.

    • getClientTtl

      Duration getClientTtl()
       Specifies a separate client (e.g. browser client) maximum TTL for cached
 content. This is used to clamp the max-age (or Expires) value sent to the
 client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`
 is used for the response max-age directive, along with a "public"
 directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`
 clamps the max-age from the origin (if specified), or else sets the
 response max-age directive to the lesser of the `clientTtl` and
 `defaultTtl`, and also ensures a "public" cache-control directive is
 present. The maximum allowed value is 31,622,400s (1 year). If not
 specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.
 Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is
 `USE_ORIGIN_HEADERS`.
      optional .google.cloud.compute.v1.Duration client_ttl = 29034360;
      Returns:
      The clientTtl.

    • getClientTtlOrBuilder

      DurationOrBuilder getClientTtlOrBuilder()
       Specifies a separate client (e.g. browser client) maximum TTL for cached
 content. This is used to clamp the max-age (or Expires) value sent to the
 client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`
 is used for the response max-age directive, along with a "public"
 directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`
 clamps the max-age from the origin (if specified), or else sets the
 response max-age directive to the lesser of the `clientTtl` and
 `defaultTtl`, and also ensures a "public" cache-control directive is
 present. The maximum allowed value is 31,622,400s (1 year). If not
 specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.
 Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is
 `USE_ORIGIN_HEADERS`.
      optional .google.cloud.compute.v1.Duration client_ttl = 29034360;

    • hasDefaultTtl

      boolean hasDefaultTtl()
       Specifies the default TTL for cached content for responses that do not have
 an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means
 "always revalidate". The value of `defaultTtl` cannot be set to a value
 greater than that of `maxTtl`. When the `cacheMode` is set to
 `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all
 responses. The maximum allowed value is 31,622,400s (1 year). Infrequently
 accessed objects may be evicted from the cache before the defined TTL. If
 not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and
 `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is
 `USE_ORIGIN_HEADERS`.
      optional .google.cloud.compute.v1.Duration default_ttl = 100253422;
      Returns:
      Whether the defaultTtl field is set.

    • getDefaultTtl

      Duration getDefaultTtl()
       Specifies the default TTL for cached content for responses that do not have
 an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means
 "always revalidate". The value of `defaultTtl` cannot be set to a value
 greater than that of `maxTtl`. When the `cacheMode` is set to
 `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all
 responses. The maximum allowed value is 31,622,400s (1 year). Infrequently
 accessed objects may be evicted from the cache before the defined TTL. If
 not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and
 `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is
 `USE_ORIGIN_HEADERS`.
      optional .google.cloud.compute.v1.Duration default_ttl = 100253422;
      Returns:
      The defaultTtl.

    • getDefaultTtlOrBuilder

      DurationOrBuilder getDefaultTtlOrBuilder()
       Specifies the default TTL for cached content for responses that do not have
 an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means
 "always revalidate". The value of `defaultTtl` cannot be set to a value
 greater than that of `maxTtl`. When the `cacheMode` is set to
 `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all
 responses. The maximum allowed value is 31,622,400s (1 year). Infrequently
 accessed objects may be evicted from the cache before the defined TTL. If
 not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and
 `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is
 `USE_ORIGIN_HEADERS`.
      optional .google.cloud.compute.v1.Duration default_ttl = 100253422;

    • hasMaxTtl

      boolean hasMaxTtl()
       Specifies the maximum allowed TTL for cached content. Cache directives that
 attempt to set a max-age or s-maxage higher than this, or an Expires header
 more than `maxTtl` seconds in the future will be capped at the value of
 `maxTtl`, as if it were the value of an s-maxage Cache-Control directive.
 Headers sent to the client will not be modified. Setting a TTL of "0" means
 "always revalidate". The maximum allowed value is 31,622,400s (1 year).
 Infrequently accessed objects may be evicted from the cache before the
 defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for
 `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache
 mode.
      optional .google.cloud.compute.v1.Duration max_ttl = 307578001;
      Returns:
      Whether the maxTtl field is set.

    • getMaxTtl

      Duration getMaxTtl()
       Specifies the maximum allowed TTL for cached content. Cache directives that
 attempt to set a max-age or s-maxage higher than this, or an Expires header
 more than `maxTtl` seconds in the future will be capped at the value of
 `maxTtl`, as if it were the value of an s-maxage Cache-Control directive.
 Headers sent to the client will not be modified. Setting a TTL of "0" means
 "always revalidate". The maximum allowed value is 31,622,400s (1 year).
 Infrequently accessed objects may be evicted from the cache before the
 defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for
 `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache
 mode.
      optional .google.cloud.compute.v1.Duration max_ttl = 307578001;
      Returns:
      The maxTtl.

    • getMaxTtlOrBuilder

      DurationOrBuilder getMaxTtlOrBuilder()
       Specifies the maximum allowed TTL for cached content. Cache directives that
 attempt to set a max-age or s-maxage higher than this, or an Expires header
 more than `maxTtl` seconds in the future will be capped at the value of
 `maxTtl`, as if it were the value of an s-maxage Cache-Control directive.
 Headers sent to the client will not be modified. Setting a TTL of "0" means
 "always revalidate". The maximum allowed value is 31,622,400s (1 year).
 Infrequently accessed objects may be evicted from the cache before the
 defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for
 `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache
 mode.
      optional .google.cloud.compute.v1.Duration max_ttl = 307578001;

    • hasNegativeCaching

      boolean hasNegativeCaching()
       Negative caching allows per-status code TTLs to be set, in order
 to apply fine-grained caching for common errors or redirects.
 This can reduce the load on your origin and improve end-user
 experience by reducing response latency.
 When the `cacheMode` is set to `CACHE_ALL_STATIC` or
 `USE_ORIGIN_HEADERS`, negative caching applies to responses with
 the specified response code that lack any Cache-Control, Expires, or
 Pragma: no-cache directives. When the `cacheMode` is set to
 `FORCE_CACHE_ALL`, negative caching applies to all responses
 with the specified response code, and overrides any caching headers. By
 default, Cloud CDN applies the following TTLs to these HTTP status codes:

 * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
 * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s
 * 405 (Method Not Found), 501 (Not Implemented): 60s

 These defaults can be overridden in `negativeCachingPolicy`.
 If not specified, Cloud CDN applies negative caching by default.
      optional bool negative_caching = 336110005;
      Returns:
      Whether the negativeCaching field is set.

    • getNegativeCaching

      boolean getNegativeCaching()
       Negative caching allows per-status code TTLs to be set, in order
 to apply fine-grained caching for common errors or redirects.
 This can reduce the load on your origin and improve end-user
 experience by reducing response latency.
 When the `cacheMode` is set to `CACHE_ALL_STATIC` or
 `USE_ORIGIN_HEADERS`, negative caching applies to responses with
 the specified response code that lack any Cache-Control, Expires, or
 Pragma: no-cache directives. When the `cacheMode` is set to
 `FORCE_CACHE_ALL`, negative caching applies to all responses
 with the specified response code, and overrides any caching headers. By
 default, Cloud CDN applies the following TTLs to these HTTP status codes:

 * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
 * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s
 * 405 (Method Not Found), 501 (Not Implemented): 60s

 These defaults can be overridden in `negativeCachingPolicy`.
 If not specified, Cloud CDN applies negative caching by default.
      optional bool negative_caching = 336110005;
      Returns:
      The negativeCaching.

    • getNegativeCachingPolicyList

      List<CachePolicyNegativeCachingPolicy> getNegativeCachingPolicyList()
       Sets a cache TTL for the specified HTTP status code.
 `negativeCaching` must be enabled to configure `negativeCachingPolicy`.
 Omitting the policy and leaving `negativeCaching` enabled will use Cloud
 CDN's default cache TTLs. Note that when specifying an explicit
 `negativeCachingPolicy`, you should take care to specify a cache TTL for
 all response codes that you wish to cache. Cloud CDN will not apply any
 default negative caching when a policy exists.
      repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

    • getNegativeCachingPolicy

      CachePolicyNegativeCachingPolicy getNegativeCachingPolicy(int index)
       Sets a cache TTL for the specified HTTP status code.
 `negativeCaching` must be enabled to configure `negativeCachingPolicy`.
 Omitting the policy and leaving `negativeCaching` enabled will use Cloud
 CDN's default cache TTLs. Note that when specifying an explicit
 `negativeCachingPolicy`, you should take care to specify a cache TTL for
 all response codes that you wish to cache. Cloud CDN will not apply any
 default negative caching when a policy exists.
      repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

    • getNegativeCachingPolicyCount

      int getNegativeCachingPolicyCount()
       Sets a cache TTL for the specified HTTP status code.
 `negativeCaching` must be enabled to configure `negativeCachingPolicy`.
 Omitting the policy and leaving `negativeCaching` enabled will use Cloud
 CDN's default cache TTLs. Note that when specifying an explicit
 `negativeCachingPolicy`, you should take care to specify a cache TTL for
 all response codes that you wish to cache. Cloud CDN will not apply any
 default negative caching when a policy exists.
      repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

    • getNegativeCachingPolicyOrBuilderList

      List<? extends CachePolicyNegativeCachingPolicyOrBuilder> getNegativeCachingPolicyOrBuilderList()
       Sets a cache TTL for the specified HTTP status code.
 `negativeCaching` must be enabled to configure `negativeCachingPolicy`.
 Omitting the policy and leaving `negativeCaching` enabled will use Cloud
 CDN's default cache TTLs. Note that when specifying an explicit
 `negativeCachingPolicy`, you should take care to specify a cache TTL for
 all response codes that you wish to cache. Cloud CDN will not apply any
 default negative caching when a policy exists.
      repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

    • getNegativeCachingPolicyOrBuilder

      CachePolicyNegativeCachingPolicyOrBuilder getNegativeCachingPolicyOrBuilder(int index)
       Sets a cache TTL for the specified HTTP status code.
 `negativeCaching` must be enabled to configure `negativeCachingPolicy`.
 Omitting the policy and leaving `negativeCaching` enabled will use Cloud
 CDN's default cache TTLs. Note that when specifying an explicit
 `negativeCachingPolicy`, you should take care to specify a cache TTL for
 all response codes that you wish to cache. Cloud CDN will not apply any
 default negative caching when a policy exists.
      repeated .google.cloud.compute.v1.CachePolicyNegativeCachingPolicy negative_caching_policy = 155359996;

    • hasRequestCoalescing

      boolean hasRequestCoalescing()
       If true then Cloud CDN will combine multiple concurrent cache fill
 requests into a small number of requests to the origin. If not specified,
 Cloud CDN applies request coalescing by default.
      optional bool request_coalescing = 532808276;
      Returns:
      Whether the requestCoalescing field is set.

    • getRequestCoalescing

      boolean getRequestCoalescing()
       If true then Cloud CDN will combine multiple concurrent cache fill
 requests into a small number of requests to the origin. If not specified,
 Cloud CDN applies request coalescing by default.
      optional bool request_coalescing = 532808276;
      Returns:
      The requestCoalescing.

    • hasServeWhileStale

      boolean hasServeWhileStale()
       Serve existing content from the cache (if available) when revalidating
 content with the origin, or when an error is encountered when refreshing
 the cache.
 This setting defines the default "max-stale" duration for any cached
 responses that do not specify a max-stale directive. Stale responses that
 exceed the TTL configured here will not be served. The default limit
 (max-stale) is 86400s (1 day), which will allow stale content to be
 served up to this limit beyond the max-age (or s-maxage) of a cached
 response.
 The maximum allowed value is 604800 (1 week).
 Set this to zero (0) to disable serve-while-stale.
      optional .google.cloud.compute.v1.Duration serve_while_stale = 236682203;
      Returns:
      Whether the serveWhileStale field is set.

    • getServeWhileStale

      Duration getServeWhileStale()
       Serve existing content from the cache (if available) when revalidating
 content with the origin, or when an error is encountered when refreshing
 the cache.
 This setting defines the default "max-stale" duration for any cached
 responses that do not specify a max-stale directive. Stale responses that
 exceed the TTL configured here will not be served. The default limit
 (max-stale) is 86400s (1 day), which will allow stale content to be
 served up to this limit beyond the max-age (or s-maxage) of a cached
 response.
 The maximum allowed value is 604800 (1 week).
 Set this to zero (0) to disable serve-while-stale.
      optional .google.cloud.compute.v1.Duration serve_while_stale = 236682203;
      Returns:
      The serveWhileStale.

    • getServeWhileStaleOrBuilder

      DurationOrBuilder getServeWhileStaleOrBuilder()
       Serve existing content from the cache (if available) when revalidating
 content with the origin, or when an error is encountered when refreshing
 the cache.
 This setting defines the default "max-stale" duration for any cached
 responses that do not specify a max-stale directive. Stale responses that
 exceed the TTL configured here will not be served. The default limit
 (max-stale) is 86400s (1 day), which will allow stale content to be
 served up to this limit beyond the max-age (or s-maxage) of a cached
 response.
 The maximum allowed value is 604800 (1 week).
 Set this to zero (0) to disable serve-while-stale.
      optional .google.cloud.compute.v1.Duration serve_while_stale = 236682203;