Class BackendBucketCdnPolicy.Builder (1.7.2)

public static final class BackendBucketCdnPolicy.Builder extends GeneratedMessageV3.Builder<BackendBucketCdnPolicy.Builder> implements BackendBucketCdnPolicyOrBuilder

Message containing Cloud CDN configuration for a backend bucket.

Protobuf type google.cloud.compute.v1.BackendBucketCdnPolicy

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BackendBucketCdnPolicy.Builder

Implements

BackendBucketCdnPolicyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllBypassCacheOnRequestHeaders(Iterable<? extends BackendBucketCdnPolicyBypassCacheOnRequestHeader> values)

public BackendBucketCdnPolicy.Builder addAllBypassCacheOnRequestHeaders(Iterable<? extends BackendBucketCdnPolicyBypassCacheOnRequestHeader> values)

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;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloud.compute.v1.BackendBucketCdnPolicyBypassCacheOnRequestHeader>`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addAllNegativeCachingPolicy(Iterable<? extends BackendBucketCdnPolicyNegativeCachingPolicy> values)

public BackendBucketCdnPolicy.Builder addAllNegativeCachingPolicy(Iterable<? extends BackendBucketCdnPolicyNegativeCachingPolicy> values)

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;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy>`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addAllSignedUrlKeyNames(Iterable<String> values)

public BackendBucketCdnPolicy.Builder addAllSignedUrlKeyNames(Iterable<String> values)

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

repeated string signed_url_key_names = 371848885;

Parameter

Name	Description
values	`Iterable<String>` The signedUrlKeyNames to add.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

addBypassCacheOnRequestHeaders(BackendBucketCdnPolicyBypassCacheOnRequestHeader value)

public BackendBucketCdnPolicy.Builder addBypassCacheOnRequestHeaders(BackendBucketCdnPolicyBypassCacheOnRequestHeader value)

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;

Parameter

Name	Description
value	`BackendBucketCdnPolicyBypassCacheOnRequestHeader`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addBypassCacheOnRequestHeaders(BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

public BackendBucketCdnPolicy.Builder addBypassCacheOnRequestHeaders(BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	`BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader value)

public BackendBucketCdnPolicy.Builder addBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader value)

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;

Parameters

Name	Description
index	`int`
value	`BackendBucketCdnPolicyBypassCacheOnRequestHeader`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

public BackendBucketCdnPolicy.Builder addBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

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;

Parameters

Name	Description
index	`int`
builderForValue	`BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addBypassCacheOnRequestHeadersBuilder()

public BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder addBypassCacheOnRequestHeadersBuilder()

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;

Returns

Type	Description
BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder

addBypassCacheOnRequestHeadersBuilder(int index)

public BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder addBypassCacheOnRequestHeadersBuilder(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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder

addNegativeCachingPolicy(BackendBucketCdnPolicyNegativeCachingPolicy value)

public BackendBucketCdnPolicy.Builder addNegativeCachingPolicy(BackendBucketCdnPolicyNegativeCachingPolicy value)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
value	`BackendBucketCdnPolicyNegativeCachingPolicy`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addNegativeCachingPolicy(BackendBucketCdnPolicyNegativeCachingPolicy.Builder builderForValue)

public BackendBucketCdnPolicy.Builder addNegativeCachingPolicy(BackendBucketCdnPolicyNegativeCachingPolicy.Builder builderForValue)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
builderForValue	`BackendBucketCdnPolicyNegativeCachingPolicy.Builder`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy value)

public BackendBucketCdnPolicy.Builder addNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy value)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameters

Name	Description
index	`int`
value	`BackendBucketCdnPolicyNegativeCachingPolicy`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy.Builder builderForValue)

public BackendBucketCdnPolicy.Builder addNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy.Builder builderForValue)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameters

Name	Description
index	`int`
builderForValue	`BackendBucketCdnPolicyNegativeCachingPolicy.Builder`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

addNegativeCachingPolicyBuilder()

public BackendBucketCdnPolicyNegativeCachingPolicy.Builder addNegativeCachingPolicyBuilder()

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns

Type	Description
BackendBucketCdnPolicyNegativeCachingPolicy.Builder

addNegativeCachingPolicyBuilder(int index)

public BackendBucketCdnPolicyNegativeCachingPolicy.Builder addNegativeCachingPolicyBuilder(int index)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyNegativeCachingPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendBucketCdnPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSignedUrlKeyNames(String value)

public BackendBucketCdnPolicy.Builder addSignedUrlKeyNames(String value)

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

repeated string signed_url_key_names = 371848885;

Parameter

Name	Description
value	`String` The signedUrlKeyNames to add.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

addSignedUrlKeyNamesBytes(ByteString value)

public BackendBucketCdnPolicy.Builder addSignedUrlKeyNamesBytes(ByteString value)

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

repeated string signed_url_key_names = 371848885;

Parameter

Name	Description
value	`ByteString` The bytes of the signedUrlKeyNames to add.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

build()

public BackendBucketCdnPolicy build()

Returns

Type	Description
BackendBucketCdnPolicy

buildPartial()

public BackendBucketCdnPolicy buildPartial()

Returns

Type	Description
BackendBucketCdnPolicy

clear()

public BackendBucketCdnPolicy.Builder clear()

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBypassCacheOnRequestHeaders()

public BackendBucketCdnPolicy.Builder clearBypassCacheOnRequestHeaders()

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;

Returns

Type	Description
BackendBucketCdnPolicy.Builder

clearCacheMode()

public BackendBucketCdnPolicy.Builder clearCacheMode()

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;

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearClientTtl()

public BackendBucketCdnPolicy.Builder clearClientTtl()

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 86400s (1 day).

optional int32 client_ttl = 29034360;

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearDefaultTtl()

public BackendBucketCdnPolicy.Builder clearDefaultTtl()

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;

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackendBucketCdnPolicy.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMaxTtl()

public BackendBucketCdnPolicy.Builder clearMaxTtl()

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

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearNegativeCaching()

public BackendBucketCdnPolicy.Builder clearNegativeCaching()

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;

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearNegativeCachingPolicy()

public BackendBucketCdnPolicy.Builder clearNegativeCachingPolicy()

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns

Type	Description
BackendBucketCdnPolicy.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendBucketCdnPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRequestCoalescing()

public BackendBucketCdnPolicy.Builder clearRequestCoalescing()

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

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearServeWhileStale()

public BackendBucketCdnPolicy.Builder clearServeWhileStale()

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;

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearSignedUrlCacheMaxAgeSec()

public BackendBucketCdnPolicy.Builder clearSignedUrlCacheMaxAgeSec()

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

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clearSignedUrlKeyNames()

public BackendBucketCdnPolicy.Builder clearSignedUrlKeyNames()

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

repeated string signed_url_key_names = 371848885;

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

clone()

public BackendBucketCdnPolicy.Builder clone()

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBypassCacheOnRequestHeaders(int index)

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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyBypassCacheOnRequestHeader

getBypassCacheOnRequestHeadersBuilder(int index)

public BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder getBypassCacheOnRequestHeadersBuilder(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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder

getBypassCacheOnRequestHeadersBuilderList()

public List<BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder> getBypassCacheOnRequestHeadersBuilderList()

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;

Returns

Type	Description
List<Builder>

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;

Returns

Type	Description
int

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;

Returns

Type	Description
List<BackendBucketCdnPolicyBypassCacheOnRequestHeader>

getBypassCacheOnRequestHeadersOrBuilder(int index)

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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder

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;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.BackendBucketCdnPolicyBypassCacheOnRequestHeaderOrBuilder>

getCacheMode()

public String getCacheMode()

optional string cache_mode = 28877888;

Returns

Type	Description
String	The cacheMode.

getCacheModeBytes()

public ByteString getCacheModeBytes()

optional string cache_mode = 28877888;

Returns

Type	Description
ByteString	The bytes for cacheMode.

getClientTtl()

public int getClientTtl()

optional int32 client_ttl = 29034360;

Returns

Type	Description
int	The clientTtl.

getDefaultInstanceForType()

public BackendBucketCdnPolicy getDefaultInstanceForType()

Returns

Type	Description
BackendBucketCdnPolicy

getDefaultTtl()

public int getDefaultTtl()

optional int32 default_ttl = 100253422;

Returns

Type	Description
int	The defaultTtl.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMaxTtl()

public int getMaxTtl()

optional int32 max_ttl = 307578001;

Returns

Type	Description
int	The maxTtl.

getNegativeCaching()

public boolean getNegativeCaching()

optional bool negative_caching = 336110005;

Returns

Type	Description
boolean	The negativeCaching.

getNegativeCachingPolicy(int index)

public BackendBucketCdnPolicyNegativeCachingPolicy getNegativeCachingPolicy(int index)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyNegativeCachingPolicy

getNegativeCachingPolicyBuilder(int index)

public BackendBucketCdnPolicyNegativeCachingPolicy.Builder getNegativeCachingPolicyBuilder(int index)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyNegativeCachingPolicy.Builder

getNegativeCachingPolicyBuilderList()

public List<BackendBucketCdnPolicyNegativeCachingPolicy.Builder> getNegativeCachingPolicyBuilderList()

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns

Type	Description
List<Builder>

getNegativeCachingPolicyCount()

public int getNegativeCachingPolicyCount()

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns

Type	Description
int

getNegativeCachingPolicyList()

public List<BackendBucketCdnPolicyNegativeCachingPolicy> getNegativeCachingPolicyList()

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns

Type	Description
List<BackendBucketCdnPolicyNegativeCachingPolicy>

getNegativeCachingPolicyOrBuilder(int index)

public BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder getNegativeCachingPolicyOrBuilder(int index)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder

getNegativeCachingPolicyOrBuilderList()

public List<? extends BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder> getNegativeCachingPolicyOrBuilderList()

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicyOrBuilder>

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;

Returns

Type	Description
boolean	The requestCoalescing.

getServeWhileStale()

public int getServeWhileStale()

optional int32 serve_while_stale = 236682203;

Returns

Type	Description
int	The serveWhileStale.

getSignedUrlCacheMaxAgeSec()

public long getSignedUrlCacheMaxAgeSec()

optional int64 signed_url_cache_max_age_sec = 269374534;

Returns

Type	Description
long	The signedUrlCacheMaxAgeSec.

getSignedUrlKeyNames(int index)

public String getSignedUrlKeyNames(int index)

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

repeated string signed_url_key_names = 371848885;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The signedUrlKeyNames at the given index.

getSignedUrlKeyNamesBytes(int index)

public ByteString getSignedUrlKeyNamesBytes(int index)

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

repeated string signed_url_key_names = 371848885;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the signedUrlKeyNames at the given index.

getSignedUrlKeyNamesCount()

public int getSignedUrlKeyNamesCount()

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

repeated string signed_url_key_names = 371848885;

Returns

Type	Description
int	The count of signedUrlKeyNames.

getSignedUrlKeyNamesList()

public ProtocolStringList getSignedUrlKeyNamesList()

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

repeated string signed_url_key_names = 371848885;

Returns

Type	Description
ProtocolStringList	A list containing the signedUrlKeyNames.

hasCacheMode()

public boolean hasCacheMode()

optional string cache_mode = 28877888;

Returns

Type	Description
boolean	Whether the cacheMode field is set.

hasClientTtl()

public boolean hasClientTtl()

optional int32 client_ttl = 29034360;

Returns

Type	Description
boolean	Whether the clientTtl field is set.

hasDefaultTtl()

public boolean hasDefaultTtl()

optional int32 default_ttl = 100253422;

Returns

Type	Description
boolean	Whether the defaultTtl field is set.

hasMaxTtl()

public boolean hasMaxTtl()

optional int32 max_ttl = 307578001;

Returns

Type	Description
boolean	Whether the maxTtl field is set.

hasNegativeCaching()

public boolean hasNegativeCaching()

optional bool negative_caching = 336110005;

Returns

Type	Description
boolean	Whether the negativeCaching field is set.

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;

Returns

Type	Description
boolean	Whether the requestCoalescing field is set.

hasServeWhileStale()

public boolean hasServeWhileStale()

optional int32 serve_while_stale = 236682203;

Returns

Type	Description
boolean	Whether the serveWhileStale field is set.

hasSignedUrlCacheMaxAgeSec()

public boolean hasSignedUrlCacheMaxAgeSec()

optional int64 signed_url_cache_max_age_sec = 269374534;

Returns

Type	Description
boolean	Whether the signedUrlCacheMaxAgeSec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(BackendBucketCdnPolicy other)

public BackendBucketCdnPolicy.Builder mergeFrom(BackendBucketCdnPolicy other)

Parameter

Name	Description
other	`BackendBucketCdnPolicy`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendBucketCdnPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public BackendBucketCdnPolicy.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendBucketCdnPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeBypassCacheOnRequestHeaders(int index)

public BackendBucketCdnPolicy.Builder removeBypassCacheOnRequestHeaders(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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

removeNegativeCachingPolicy(int index)

public BackendBucketCdnPolicy.Builder removeNegativeCachingPolicy(int index)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

setBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader value)

public BackendBucketCdnPolicy.Builder setBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader value)

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;

Parameters

Name	Description
index	`int`
value	`BackendBucketCdnPolicyBypassCacheOnRequestHeader`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

setBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

public BackendBucketCdnPolicy.Builder setBypassCacheOnRequestHeaders(int index, BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder builderForValue)

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;

Parameters

Name	Description
index	`int`
builderForValue	`BackendBucketCdnPolicyBypassCacheOnRequestHeader.Builder`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

setCacheMode(String value)

public BackendBucketCdnPolicy.Builder setCacheMode(String value)

optional string cache_mode = 28877888;

Parameter

Name	Description
value	`String` The cacheMode to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setCacheModeBytes(ByteString value)

public BackendBucketCdnPolicy.Builder setCacheModeBytes(ByteString value)

optional string cache_mode = 28877888;

Parameter

Name	Description
value	`ByteString` The bytes for cacheMode to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setClientTtl(int value)

public BackendBucketCdnPolicy.Builder setClientTtl(int value)

optional int32 client_ttl = 29034360;

Parameter

Name	Description
value	`int` The clientTtl to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setDefaultTtl(int value)

public BackendBucketCdnPolicy.Builder setDefaultTtl(int value)

optional int32 default_ttl = 100253422;

Parameter

Name	Description
value	`int` The defaultTtl to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackendBucketCdnPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxTtl(int value)

public BackendBucketCdnPolicy.Builder setMaxTtl(int value)

optional int32 max_ttl = 307578001;

Parameter

Name	Description
value	`int` The maxTtl to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setNegativeCaching(boolean value)

public BackendBucketCdnPolicy.Builder setNegativeCaching(boolean value)

optional bool negative_caching = 336110005;

Parameter

Name	Description
value	`boolean` The negativeCaching to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy value)

public BackendBucketCdnPolicy.Builder setNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy value)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameters

Name	Description
index	`int`
value	`BackendBucketCdnPolicyNegativeCachingPolicy`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

setNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy.Builder builderForValue)

public BackendBucketCdnPolicy.Builder setNegativeCachingPolicy(int index, BackendBucketCdnPolicyNegativeCachingPolicy.Builder builderForValue)

repeated .google.cloud.compute.v1.BackendBucketCdnPolicyNegativeCachingPolicy negative_caching_policy = 155359996;

Parameters

Name	Description
index	`int`
builderForValue	`BackendBucketCdnPolicyNegativeCachingPolicy.Builder`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackendBucketCdnPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequestCoalescing(boolean value)

public BackendBucketCdnPolicy.Builder setRequestCoalescing(boolean value)

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;

Parameter

Name	Description
value	`boolean` The requestCoalescing to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setServeWhileStale(int value)

public BackendBucketCdnPolicy.Builder setServeWhileStale(int value)

optional int32 serve_while_stale = 236682203;

Parameter

Name	Description
value	`int` The serveWhileStale to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setSignedUrlCacheMaxAgeSec(long value)

public BackendBucketCdnPolicy.Builder setSignedUrlCacheMaxAgeSec(long value)

optional int64 signed_url_cache_max_age_sec = 269374534;

Parameter

Name	Description
value	`long` The signedUrlCacheMaxAgeSec to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setSignedUrlKeyNames(int index, String value)

public BackendBucketCdnPolicy.Builder setSignedUrlKeyNames(int index, String value)

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

repeated string signed_url_key_names = 371848885;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The signedUrlKeyNames to set.

Returns

Type	Description
BackendBucketCdnPolicy.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendBucketCdnPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BackendBucketCdnPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)