com.google.cloud.compute.v1

Class BackendBucketCdnPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.compute.v1.BackendBucketCdnPolicy

All Implemented Interfaces:

BackendBucketCdnPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BackendBucketCdnPolicy
extends com.google.protobuf.GeneratedMessageV3
implements BackendBucketCdnPolicyOrBuilder

 Message containing Cloud CDN configuration for a backend bucket.
 

Protobuf type google.cloud.compute.v1.BackendBucketCdnPolicy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackendBucketCdnPolicy.Builder Message containing Cloud CDN configuration for a backend bucket.
static class	BackendBucketCdnPolicy.CacheMode Specifies the cache setting for all responses from this backend.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYPASS_CACHE_ON_REQUEST_HEADERS_FIELD_NUMBER
static int	CACHE_KEY_POLICY_FIELD_NUMBER
static int	CACHE_MODE_FIELD_NUMBER
static int	CLIENT_TTL_FIELD_NUMBER
static int	DEFAULT_TTL_FIELD_NUMBER
static int	MAX_TTL_FIELD_NUMBER
static int	NEGATIVE_CACHING_FIELD_NUMBER
static int	NEGATIVE_CACHING_POLICY_FIELD_NUMBER
static int	REQUEST_COALESCING_FIELD_NUMBER
static int	SERVE_WHILE_STALE_FIELD_NUMBER
static int	SIGNED_URL_CACHE_MAX_AGE_SEC_FIELD_NUMBER
static int	SIGNED_URL_KEY_NAMES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BackendBucketCdnPolicyBypassCacheOnRequestHeader	getBypassCacheOnRequestHeaders(int index) Bypass the cache when the specified request headers are matched - e.g.
int	getBypassCacheOnRequestHeadersCount() Bypass the cache when the specified request headers are matched - e.g.
List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>	getBypassCacheOnRequestHeadersList() Bypass the cache when the specified request headers are matched - e.g.
BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder	getBypassCacheOnRequestHeadersOrBuilder(int index) Bypass the cache when the specified request headers are matched - e.g.
List<? extends BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder>	getBypassCacheOnRequestHeadersOrBuilderList() Bypass the cache when the specified request headers are matched - e.g.
BackendBucketCdnPolicyCacheKeyPolicy	getCacheKeyPolicy() The CacheKeyPolicy for this CdnPolicy.
BackendBucketCdnPolicyCacheKeyPolicyOrBuilder	getCacheKeyPolicyOrBuilder() The CacheKeyPolicy for this CdnPolicy.
String	getCacheMode() Specifies the cache setting for all responses from this backend.
com.google.protobuf.ByteString	getCacheModeBytes() Specifies the cache setting for all responses from this backend.
int	getClientTtl() Specifies a separate client (e.g.
static BackendBucketCdnPolicy	getDefaultInstance()
BackendBucketCdnPolicy	getDefaultInstanceForType()
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).
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getMaxTtl() Specifies the maximum allowed TTL for cached content served by this origin.
boolean	getNegativeCaching() Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
BackendBucketCdnPolicyNegativeCachingPolicy	getNegativeCachingPolicy(int index) Sets a cache TTL for the specified HTTP status code.
int	getNegativeCachingPolicyCount() Sets a cache TTL for the specified HTTP status code.
List<BackendBucketCdnPolicyNegativeCachingPolicy>	getNegativeCachingPolicyList() Sets a cache TTL for the specified HTTP status code.
BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder	getNegativeCachingPolicyOrBuilder(int index) Sets a cache TTL for the specified HTTP status code.
List<? extends BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder>	getNegativeCachingPolicyOrBuilderList() Sets a cache TTL for the specified HTTP status code.
com.google.protobuf.Parser<BackendBucketCdnPolicy>	getParserForType()
boolean	getRequestCoalescing() If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
int	getSerializedSize()
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.
long	getSignedUrlCacheMaxAgeSec() Maximum number of seconds the response to a signed URL request will be considered fresh.
String	getSignedUrlKeyNames(int index) [Output Only] Names of the keys for signing request URLs.
com.google.protobuf.ByteString	getSignedUrlKeyNamesBytes(int index) [Output Only] Names of the keys for signing request URLs.
int	getSignedUrlKeyNamesCount() [Output Only] Names of the keys for signing request URLs.
com.google.protobuf.ProtocolStringList	getSignedUrlKeyNamesList() [Output Only] Names of the keys for signing request URLs.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCacheKeyPolicy() The CacheKeyPolicy for this CdnPolicy.
boolean	hasCacheMode() Specifies the cache setting for all responses from this backend.
boolean	hasClientTtl() Specifies a separate client (e.g.
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).
int	hashCode()
boolean	hasMaxTtl() Specifies the maximum allowed TTL for cached content served by this origin.
boolean	hasNegativeCaching() Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
boolean	hasRequestCoalescing() If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
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.
boolean	hasSignedUrlCacheMaxAgeSec() Maximum number of seconds the response to a signed URL request will be considered fresh.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BackendBucketCdnPolicy.Builder	newBuilder()
static BackendBucketCdnPolicy.Builder	newBuilder(BackendBucketCdnPolicy prototype)
BackendBucketCdnPolicy.Builder	newBuilderForType()
protected BackendBucketCdnPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BackendBucketCdnPolicy	parseDelimitedFrom(InputStream input)
static BackendBucketCdnPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendBucketCdnPolicy	parseFrom(byte[] data)
static BackendBucketCdnPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendBucketCdnPolicy	parseFrom(ByteBuffer data)
static BackendBucketCdnPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendBucketCdnPolicy	parseFrom(com.google.protobuf.ByteString data)
static BackendBucketCdnPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendBucketCdnPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static BackendBucketCdnPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendBucketCdnPolicy	parseFrom(InputStream input)
static BackendBucketCdnPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BackendBucketCdnPolicy>	parser()
BackendBucketCdnPolicy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BYPASS_CACHE_ON_REQUEST_HEADERS_FIELD_NUMBER

public static final int BYPASS_CACHE_ON_REQUEST_HEADERS_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_KEY_POLICY_FIELD_NUMBER

public static final int CACHE_KEY_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_MODE_FIELD_NUMBER

public static final int CACHE_MODE_FIELD_NUMBER

See Also:

Constant Field Values

CLIENT_TTL_FIELD_NUMBER

public static final int CLIENT_TTL_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_TTL_FIELD_NUMBER

public static final int DEFAULT_TTL_FIELD_NUMBER

See Also:

Constant Field Values

MAX_TTL_FIELD_NUMBER

public static final int MAX_TTL_FIELD_NUMBER

See Also:

Constant Field Values

NEGATIVE_CACHING_FIELD_NUMBER

public static final int NEGATIVE_CACHING_FIELD_NUMBER

See Also:

Constant Field Values

NEGATIVE_CACHING_POLICY_FIELD_NUMBER

public static final int NEGATIVE_CACHING_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_COALESCING_FIELD_NUMBER

public static final int REQUEST_COALESCING_FIELD_NUMBER

See Also:

Constant Field Values

SERVE_WHILE_STALE_FIELD_NUMBER

public static final int SERVE_WHILE_STALE_FIELD_NUMBER

See Also:

Constant Field Values

SIGNED_URL_CACHE_MAX_AGE_SEC_FIELD_NUMBER

public static final int SIGNED_URL_CACHE_MAX_AGE_SEC_FIELD_NUMBER

See Also:

Constant Field Values

SIGNED_URL_KEY_NAMES_FIELD_NUMBER

public static final int SIGNED_URL_KEY_NAMES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getBypassCacheOnRequestHeadersList in interface BackendBucketCdnPolicyOrBuilder

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;

Specified by:

getBypassCacheOnRequestHeadersOrBuilderList in interface BackendBucketCdnPolicyOrBuilder

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;

Specified by:

getBypassCacheOnRequestHeadersCount in interface BackendBucketCdnPolicyOrBuilder

getBypassCacheOnRequestHeaders

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;

Specified by:

getBypassCacheOnRequestHeaders in interface BackendBucketCdnPolicyOrBuilder

getBypassCacheOnRequestHeadersOrBuilder

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;

Specified by:

getBypassCacheOnRequestHeadersOrBuilder in interface BackendBucketCdnPolicyOrBuilder

hasCacheKeyPolicy

public boolean hasCacheKeyPolicy()

 The CacheKeyPolicy for this CdnPolicy.
 

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

Specified by:

hasCacheKeyPolicy in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the cacheKeyPolicy field is set.

getCacheKeyPolicy

public BackendBucketCdnPolicyCacheKeyPolicy getCacheKeyPolicy()

 The CacheKeyPolicy for this CdnPolicy.
 

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

Specified by:

getCacheKeyPolicy in interface BackendBucketCdnPolicyOrBuilder

Returns:

The cacheKeyPolicy.

getCacheKeyPolicyOrBuilder

public BackendBucketCdnPolicyCacheKeyPolicyOrBuilder getCacheKeyPolicyOrBuilder()

 The CacheKeyPolicy for this CdnPolicy.
 

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

Specified by:

getCacheKeyPolicyOrBuilder in interface BackendBucketCdnPolicyOrBuilder

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;

Specified by:

hasCacheMode in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the cacheMode field is set.

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;

Specified by:

getCacheMode in interface BackendBucketCdnPolicyOrBuilder

Returns:

The cacheMode.

getCacheModeBytes

public 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.
 Check the CacheMode enum for the list of possible values.
 

optional string cache_mode = 28877888;

Specified by:

getCacheModeBytes in interface BackendBucketCdnPolicyOrBuilder

Returns:

The bytes for cacheMode.

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;

Specified by:

hasClientTtl in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the clientTtl field is set.

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;

Specified by:

getClientTtl in interface BackendBucketCdnPolicyOrBuilder

Returns:

The clientTtl.

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;

Specified by:

hasDefaultTtl in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the defaultTtl field is set.

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;

Specified by:

getDefaultTtl in interface BackendBucketCdnPolicyOrBuilder

Returns:

The defaultTtl.

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;

Specified by:

hasMaxTtl in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the maxTtl field is set.

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;

Specified by:

getMaxTtl in interface BackendBucketCdnPolicyOrBuilder

Returns:

The maxTtl.

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;

Specified by:

hasNegativeCaching in interface BackendBucketCdnPolicyOrBuilder

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 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;

Specified by:

getNegativeCaching in interface BackendBucketCdnPolicyOrBuilder

Returns:

The negativeCaching.

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;

Specified by:

getNegativeCachingPolicyList in interface BackendBucketCdnPolicyOrBuilder

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;

Specified by:

getNegativeCachingPolicyOrBuilderList in interface BackendBucketCdnPolicyOrBuilder

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;

Specified by:

getNegativeCachingPolicyCount in interface BackendBucketCdnPolicyOrBuilder

getNegativeCachingPolicy

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;

Specified by:

getNegativeCachingPolicy in interface BackendBucketCdnPolicyOrBuilder

getNegativeCachingPolicyOrBuilder

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;

Specified by:

getNegativeCachingPolicyOrBuilder in interface BackendBucketCdnPolicyOrBuilder

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;

Specified by:

hasRequestCoalescing in interface BackendBucketCdnPolicyOrBuilder

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.
 

optional bool request_coalescing = 532808276;

Specified by:

getRequestCoalescing in interface BackendBucketCdnPolicyOrBuilder

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-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;

Specified by:

hasServeWhileStale in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the serveWhileStale field is set.

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;

Specified by:

getServeWhileStale in interface BackendBucketCdnPolicyOrBuilder

Returns:

The serveWhileStale.

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;

Specified by:

hasSignedUrlCacheMaxAgeSec in interface BackendBucketCdnPolicyOrBuilder

Returns:

Whether the signedUrlCacheMaxAgeSec field is set.

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;

Specified by:

getSignedUrlCacheMaxAgeSec in interface BackendBucketCdnPolicyOrBuilder

Returns:

The signedUrlCacheMaxAgeSec.

getSignedUrlKeyNamesList

public com.google.protobuf.ProtocolStringList getSignedUrlKeyNamesList()

 [Output Only] Names of the keys for signing request URLs.
 

repeated string signed_url_key_names = 371848885;

Specified by:

getSignedUrlKeyNamesList in interface BackendBucketCdnPolicyOrBuilder

Returns:

A list containing the signedUrlKeyNames.

getSignedUrlKeyNamesCount

public int getSignedUrlKeyNamesCount()

 [Output Only] Names of the keys for signing request URLs.
 

repeated string signed_url_key_names = 371848885;

Specified by:

getSignedUrlKeyNamesCount in interface BackendBucketCdnPolicyOrBuilder

Returns:

The count of signedUrlKeyNames.

getSignedUrlKeyNames

public String getSignedUrlKeyNames(int index)

 [Output Only] Names of the keys for signing request URLs.
 

repeated string signed_url_key_names = 371848885;

Specified by:

getSignedUrlKeyNames in interface BackendBucketCdnPolicyOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The signedUrlKeyNames at the given index.

getSignedUrlKeyNamesBytes

public com.google.protobuf.ByteString getSignedUrlKeyNamesBytes(int index)

 [Output Only] Names of the keys for signing request URLs.
 

repeated string signed_url_key_names = 371848885;

Specified by:

getSignedUrlKeyNamesBytes in interface BackendBucketCdnPolicyOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the signedUrlKeyNames at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BackendBucketCdnPolicy parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BackendBucketCdnPolicy parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BackendBucketCdnPolicy parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BackendBucketCdnPolicy parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BackendBucketCdnPolicy parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BackendBucketCdnPolicy parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BackendBucketCdnPolicy parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static BackendBucketCdnPolicy parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static BackendBucketCdnPolicy parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static BackendBucketCdnPolicy parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static BackendBucketCdnPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static BackendBucketCdnPolicy parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public BackendBucketCdnPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BackendBucketCdnPolicy.Builder newBuilder()

newBuilder

public static BackendBucketCdnPolicy.Builder newBuilder(BackendBucketCdnPolicy prototype)

toBuilder

public BackendBucketCdnPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BackendBucketCdnPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BackendBucketCdnPolicy getDefaultInstance()

parser

public static com.google.protobuf.Parser<BackendBucketCdnPolicy> parser()

getParserForType

public com.google.protobuf.Parser<BackendBucketCdnPolicy> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BackendBucketCdnPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder