Package com.google.cloud.compute.v1

Interface BackendServiceCdnPolicyOrBuilder

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

  • Method Details

    • getBypassCacheOnRequestHeadersList

      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;

    • getBypassCacheOnRequestHeaders

      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;

    • getBypassCacheOnRequestHeadersCount

      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;

    • getBypassCacheOnRequestHeadersOrBuilderList

      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;

    • getBypassCacheOnRequestHeadersOrBuilder

      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;

    • hasCacheKeyPolicy

      boolean hasCacheKeyPolicy()
       The CacheKeyPolicy for this CdnPolicy.
      optional .google.cloud.compute.v1.CacheKeyPolicy cache_key_policy = 159263727;
      Returns:
      Whether the cacheKeyPolicy field is set.

    • getCacheKeyPolicy

      CacheKeyPolicy getCacheKeyPolicy()
       The CacheKeyPolicy for this CdnPolicy.
      optional .google.cloud.compute.v1.CacheKeyPolicy cache_key_policy = 159263727;
      Returns:
      The cacheKeyPolicy.

    • getCacheKeyPolicyOrBuilder

      CacheKeyPolicyOrBuilder getCacheKeyPolicyOrBuilder()
       The CacheKeyPolicy for this CdnPolicy.
      optional .google.cloud.compute.v1.CacheKeyPolicy cache_key_policy = 159263727;

    • hasCacheMode

      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.

 If no value is provided for cdnPolicy.cacheMode, it defaults
 to CACHE_ALL_STATIC.
 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 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.

 If no value is provided for cdnPolicy.cacheMode, it defaults
 to CACHE_ALL_STATIC.
 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 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.

 If no value is provided for cdnPolicy.cacheMode, it defaults
 to CACHE_ALL_STATIC.
 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. 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:
      Whether the clientTtl field is set.

    • getClientTtl

      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:
      The clientTtl.

    • hasDefaultTtl

      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-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. 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:
      Whether the defaultTtl field is set.

    • getDefaultTtl

      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-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. 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:
      The defaultTtl.

    • hasMaxTtl

      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:
      Whether the maxTtl field is set.

    • getMaxTtl

      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:
      The maxTtl.

    • 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 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.
      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 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.
      optional bool negative_caching = 336110005;
      Returns:
      The negativeCaching.

    • getNegativeCachingPolicyList

      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;

    • getNegativeCachingPolicy

      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;

    • getNegativeCachingPolicyCount

      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;

    • getNegativeCachingPolicyOrBuilderList

      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;

    • getNegativeCachingPolicyOrBuilder

      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;

    • hasRequestCoalescing

      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:
      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.
      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 int32 serve_while_stale = 236682203;
      Returns:
      Whether the serveWhileStale field is set.

    • getServeWhileStale

      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-maxage) 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:
      The serveWhileStale.

    • hasSignedUrlCacheMaxAgeSec

      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:
      Whether the signedUrlCacheMaxAgeSec field is set.

    • getSignedUrlCacheMaxAgeSec

      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:
      The signedUrlCacheMaxAgeSec.

    • getSignedUrlKeyNamesList

      List<String> getSignedUrlKeyNamesList()
       [Output Only] Names of the keys for signing request URLs.
      repeated string signed_url_key_names = 371848885;
      Returns:
      A list containing the signedUrlKeyNames.

    • getSignedUrlKeyNamesCount

      int getSignedUrlKeyNamesCount()
       [Output Only] Names of the keys for signing request URLs.
      repeated string signed_url_key_names = 371848885;
      Returns:
      The count of signedUrlKeyNames.

    • getSignedUrlKeyNames

      String getSignedUrlKeyNames(int index)
       [Output Only] Names of the keys for signing request URLs.
      repeated string signed_url_key_names = 371848885;
      Parameters:
      index - The index of the element to return.
      Returns:
      The signedUrlKeyNames at the given index.

    • getSignedUrlKeyNamesBytes

      com.google.protobuf.ByteString getSignedUrlKeyNamesBytes(int index)
       [Output Only] Names of the keys for signing request URLs.
      repeated string signed_url_key_names = 371848885;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the signedUrlKeyNames at the given index.