Package com.google.cloud.compute.v1
Class CachePolicy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.CachePolicy
- All Implemented Interfaces:
CachePolicyOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class CachePolicy
extends com.google.protobuf.GeneratedMessage
implements CachePolicyOrBuilder
Message containing CachePolicy configuration for URL Map's Route Action.Protobuf type
google.cloud.compute.v1.CachePolicy- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classMessage containing CachePolicy configuration for URL Map's Route Action.static enumSpecifies the cache setting for all responses from this route.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetCacheBypassRequestHeaderNames(int index) Bypass the cache when the specified request headers are matched by name, e.g.com.google.protobuf.ByteStringgetCacheBypassRequestHeaderNamesBytes(int index) Bypass the cache when the specified request headers are matched by name, e.g.intBypass the cache when the specified request headers are matched by name, e.g.com.google.protobuf.ProtocolStringListBypass the cache when the specified request headers are matched by name, e.g.The cache key configuration.The cache key configuration.Specifies the cache setting for all responses from this route.com.google.protobuf.ByteStringSpecifies the cache setting for all responses from this route.Specifies a separate client (e.g. browser client) maximum TTL for cached content.Specifies a separate client (e.g. browser client) maximum TTL for cached content.static CachePolicySpecifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage).Specifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage).static final com.google.protobuf.Descriptors.DescriptorSpecifies the maximum allowed TTL for cached content.Specifies the maximum allowed TTL for cached content.booleanNegative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.getNegativeCachingPolicy(int index) Sets a cache TTL for the specified HTTP status code.intSets a cache TTL for the specified HTTP status code.Sets a cache TTL for the specified HTTP status code.getNegativeCachingPolicyOrBuilder(int index) Sets a cache TTL for the specified HTTP status code.List<? extends CachePolicyNegativeCachingPolicyOrBuilder>Sets a cache TTL for the specified HTTP status code.com.google.protobuf.Parser<CachePolicy>booleanIf true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.intServe existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.booleanThe cache key configuration.booleanSpecifies the cache setting for all responses from this route.booleanSpecifies a separate client (e.g. browser client) maximum TTL for cached content.booleanSpecifies the default TTL for cached content for responses that do not have an existing valid TTL (max-age or s-maxage).inthashCode()booleanSpecifies the maximum allowed TTL for cached content.booleanNegative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.booleanIf true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.booleanServe existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic CachePolicy.Builderstatic CachePolicy.BuildernewBuilder(CachePolicy prototype) protected CachePolicy.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static CachePolicyparseDelimitedFrom(InputStream input) static CachePolicyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CachePolicyparseFrom(byte[] data) static CachePolicyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CachePolicyparseFrom(com.google.protobuf.ByteString data) static CachePolicyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CachePolicyparseFrom(com.google.protobuf.CodedInputStream input) static CachePolicyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CachePolicyparseFrom(InputStream input) static CachePolicyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CachePolicyparseFrom(ByteBuffer data) static CachePolicyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<CachePolicy>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
CACHE_BYPASS_REQUEST_HEADER_NAMES_FIELD_NUMBER
public static final int CACHE_BYPASS_REQUEST_HEADER_NAMES_FIELD_NUMBER- See Also:
-
CACHE_KEY_POLICY_FIELD_NUMBER
public static final int CACHE_KEY_POLICY_FIELD_NUMBER- See Also:
-
CACHE_MODE_FIELD_NUMBER
public static final int CACHE_MODE_FIELD_NUMBER- See Also:
-
CLIENT_TTL_FIELD_NUMBER
public static final int CLIENT_TTL_FIELD_NUMBER- See Also:
-
DEFAULT_TTL_FIELD_NUMBER
public static final int DEFAULT_TTL_FIELD_NUMBER- See Also:
-
MAX_TTL_FIELD_NUMBER
public static final int MAX_TTL_FIELD_NUMBER- See Also:
-
NEGATIVE_CACHING_FIELD_NUMBER
public static final int NEGATIVE_CACHING_FIELD_NUMBER- See Also:
-
NEGATIVE_CACHING_POLICY_FIELD_NUMBER
public static final int NEGATIVE_CACHING_POLICY_FIELD_NUMBER- See Also:
-
REQUEST_COALESCING_FIELD_NUMBER
public static final int REQUEST_COALESCING_FIELD_NUMBER- See Also:
-
SERVE_WHILE_STALE_FIELD_NUMBER
public static final int SERVE_WHILE_STALE_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getCacheBypassRequestHeaderNamesList
public com.google.protobuf.ProtocolStringList 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;- Specified by:
getCacheBypassRequestHeaderNamesListin interfaceCachePolicyOrBuilder- Returns:
- A list containing the cacheBypassRequestHeaderNames.
-
getCacheBypassRequestHeaderNamesCount
public 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;- Specified by:
getCacheBypassRequestHeaderNamesCountin interfaceCachePolicyOrBuilder- Returns:
- The count of cacheBypassRequestHeaderNames.
-
getCacheBypassRequestHeaderNames
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;- Specified by:
getCacheBypassRequestHeaderNamesin interfaceCachePolicyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The cacheBypassRequestHeaderNames at the given index.
-
getCacheBypassRequestHeaderNamesBytes
public 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;- Specified by:
getCacheBypassRequestHeaderNamesBytesin interfaceCachePolicyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the cacheBypassRequestHeaderNames at the given index.
-
hasCacheKeyPolicy
public 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;- Specified by:
hasCacheKeyPolicyin interfaceCachePolicyOrBuilder- Returns:
- Whether the cacheKeyPolicy field is set.
-
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;- Specified by:
getCacheKeyPolicyin interfaceCachePolicyOrBuilder- Returns:
- The cacheKeyPolicy.
-
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;- Specified by:
getCacheKeyPolicyOrBuilderin interfaceCachePolicyOrBuilder
-
hasCacheMode
public 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;- Specified by:
hasCacheModein interfaceCachePolicyOrBuilder- Returns:
- Whether the cacheMode field is set.
-
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;- Specified by:
getCacheModein interfaceCachePolicyOrBuilder- Returns:
- The cacheMode.
-
getCacheModeBytes
public 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;- Specified by:
getCacheModeBytesin interfaceCachePolicyOrBuilder- Returns:
- The bytes for cacheMode.
-
hasClientTtl
public 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;- Specified by:
hasClientTtlin interfaceCachePolicyOrBuilder- Returns:
- Whether the clientTtl field is set.
-
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;- Specified by:
getClientTtlin interfaceCachePolicyOrBuilder- Returns:
- The clientTtl.
-
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;- Specified by:
getClientTtlOrBuilderin interfaceCachePolicyOrBuilder
-
hasDefaultTtl
public 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;- Specified by:
hasDefaultTtlin interfaceCachePolicyOrBuilder- Returns:
- Whether the defaultTtl field is set.
-
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;- Specified by:
getDefaultTtlin interfaceCachePolicyOrBuilder- Returns:
- The defaultTtl.
-
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;- Specified by:
getDefaultTtlOrBuilderin interfaceCachePolicyOrBuilder
-
hasMaxTtl
public 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;- Specified by:
hasMaxTtlin interfaceCachePolicyOrBuilder- Returns:
- Whether the maxTtl field is set.
-
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;- Specified by:
getMaxTtlin interfaceCachePolicyOrBuilder- Returns:
- The maxTtl.
-
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;- Specified by:
getMaxTtlOrBuilderin interfaceCachePolicyOrBuilder
-
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 `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;- Specified by:
hasNegativeCachingin interfaceCachePolicyOrBuilder- Returns:
- Whether the negativeCaching field is set.
-
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 `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;- Specified by:
getNegativeCachingin interfaceCachePolicyOrBuilder- Returns:
- The negativeCaching.
-
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;- Specified by:
getNegativeCachingPolicyListin interfaceCachePolicyOrBuilder
-
getNegativeCachingPolicyOrBuilderList
public 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;- Specified by:
getNegativeCachingPolicyOrBuilderListin interfaceCachePolicyOrBuilder
-
getNegativeCachingPolicyCount
public 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;- Specified by:
getNegativeCachingPolicyCountin interfaceCachePolicyOrBuilder
-
getNegativeCachingPolicy
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;- Specified by:
getNegativeCachingPolicyin interfaceCachePolicyOrBuilder
-
getNegativeCachingPolicyOrBuilder
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;- Specified by:
getNegativeCachingPolicyOrBuilderin interfaceCachePolicyOrBuilder
-
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. If not specified, Cloud CDN applies request coalescing by default.
optional bool request_coalescing = 532808276;- Specified by:
hasRequestCoalescingin interfaceCachePolicyOrBuilder- Returns:
- Whether the requestCoalescing field is set.
-
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. If not specified, Cloud CDN applies request coalescing by default.
optional bool request_coalescing = 532808276;- Specified by:
getRequestCoalescingin interfaceCachePolicyOrBuilder- Returns:
- The requestCoalescing.
-
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-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;- Specified by:
hasServeWhileStalein interfaceCachePolicyOrBuilder- Returns:
- Whether the serveWhileStale field is set.
-
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;- Specified by:
getServeWhileStalein interfaceCachePolicyOrBuilder- Returns:
- The serveWhileStale.
-
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;- Specified by:
getServeWhileStaleOrBuilderin interfaceCachePolicyOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CachePolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CachePolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CachePolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CachePolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CachePolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CachePolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static CachePolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static CachePolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static CachePolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CachePolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-