Class CacheKeyPolicy.Builder (1.11.0)

Version 1.11.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public static final class CacheKeyPolicy.Builder extends GeneratedMessageV3.Builder<CacheKeyPolicy.Builder> implements CacheKeyPolicyOrBuilder

Message containing what to include in the cache key for a request for Cloud CDN.

Protobuf type google.cloud.compute.v1.CacheKeyPolicy

Inheritance

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

Implements

CacheKeyPolicyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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

addAllIncludeHttpHeaders(Iterable<String> values)

public CacheKeyPolicy.Builder addAllIncludeHttpHeaders(Iterable<String> values)

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Parameter

Name	Description
values	Iterable<String> The includeHttpHeaders to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addAllIncludeNamedCookies(Iterable<String> values)

public CacheKeyPolicy.Builder addAllIncludeNamedCookies(Iterable<String> values)

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Parameter

Name	Description
values	Iterable<String> The includeNamedCookies to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addAllQueryStringBlacklist(Iterable<String> values)

public CacheKeyPolicy.Builder addAllQueryStringBlacklist(Iterable<String> values)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Parameter

Name	Description
values	Iterable<String> The queryStringBlacklist to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addAllQueryStringWhitelist(Iterable<String> values)

public CacheKeyPolicy.Builder addAllQueryStringWhitelist(Iterable<String> values)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Parameter

Name	Description
values	Iterable<String> The queryStringWhitelist to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addIncludeHttpHeaders(String value)

public CacheKeyPolicy.Builder addIncludeHttpHeaders(String value)

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Parameter

Name	Description
value	String The includeHttpHeaders to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addIncludeHttpHeadersBytes(ByteString value)

public CacheKeyPolicy.Builder addIncludeHttpHeadersBytes(ByteString value)

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Parameter

Name	Description
value	ByteString The bytes of the includeHttpHeaders to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addIncludeNamedCookies(String value)

public CacheKeyPolicy.Builder addIncludeNamedCookies(String value)

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Parameter

Name	Description
value	String The includeNamedCookies to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addIncludeNamedCookiesBytes(ByteString value)

public CacheKeyPolicy.Builder addIncludeNamedCookiesBytes(ByteString value)

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Parameter

Name	Description
value	ByteString The bytes of the includeNamedCookies to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addQueryStringBlacklist(String value)

public CacheKeyPolicy.Builder addQueryStringBlacklist(String value)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Parameter

Name	Description
value	String The queryStringBlacklist to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addQueryStringBlacklistBytes(ByteString value)

public CacheKeyPolicy.Builder addQueryStringBlacklistBytes(ByteString value)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Parameter

Name	Description
value	ByteString The bytes of the queryStringBlacklist to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addQueryStringWhitelist(String value)

public CacheKeyPolicy.Builder addQueryStringWhitelist(String value)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Parameter

Name	Description
value	String The queryStringWhitelist to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addQueryStringWhitelistBytes(ByteString value)

public CacheKeyPolicy.Builder addQueryStringWhitelistBytes(ByteString value)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Parameter

Name	Description
value	ByteString The bytes of the queryStringWhitelist to add.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

build()

public CacheKeyPolicy build()

Returns

Type	Description
CacheKeyPolicy

buildPartial()

public CacheKeyPolicy buildPartial()

Returns

Type	Description
CacheKeyPolicy

clear()

public CacheKeyPolicy.Builder clear()

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public CacheKeyPolicy.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

clearIncludeHost()

public CacheKeyPolicy.Builder clearIncludeHost()

If true, requests to different hosts will be cached separately.

optional bool include_host = 486867679;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clearIncludeHttpHeaders()

public CacheKeyPolicy.Builder clearIncludeHttpHeaders()

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clearIncludeNamedCookies()

public CacheKeyPolicy.Builder clearIncludeNamedCookies()

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clearIncludeProtocol()

public CacheKeyPolicy.Builder clearIncludeProtocol()

If true, http and https requests will be cached separately.

optional bool include_protocol = 303507535;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clearIncludeQueryString()

public CacheKeyPolicy.Builder clearIncludeQueryString()

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

optional bool include_query_string = 474036639;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CacheKeyPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

clearQueryStringBlacklist()

public CacheKeyPolicy.Builder clearQueryStringBlacklist()

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clearQueryStringWhitelist()

public CacheKeyPolicy.Builder clearQueryStringWhitelist()

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

clone()

public CacheKeyPolicy.Builder clone()

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public CacheKeyPolicy getDefaultInstanceForType()

Returns

Type	Description
CacheKeyPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIncludeHost()

public boolean getIncludeHost()

If true, requests to different hosts will be cached separately.

optional bool include_host = 486867679;

Returns

Type	Description
boolean	The includeHost.

getIncludeHttpHeaders(int index)

public String getIncludeHttpHeaders(int index)

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Parameter

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

Returns

Type	Description
String	The includeHttpHeaders at the given index.

getIncludeHttpHeadersBytes(int index)

public ByteString getIncludeHttpHeadersBytes(int index)

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Parameter

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

Returns

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

getIncludeHttpHeadersCount()

public int getIncludeHttpHeadersCount()

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Returns

Type	Description
int	The count of includeHttpHeaders.

getIncludeHttpHeadersList()

public ProtocolStringList getIncludeHttpHeadersList()

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Returns

Type	Description
ProtocolStringList	A list containing the includeHttpHeaders.

getIncludeNamedCookies(int index)

public String getIncludeNamedCookies(int index)

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Parameter

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

Returns

Type	Description
String	The includeNamedCookies at the given index.

getIncludeNamedCookiesBytes(int index)

public ByteString getIncludeNamedCookiesBytes(int index)

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Parameter

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

Returns

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

getIncludeNamedCookiesCount()

public int getIncludeNamedCookiesCount()

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Returns

Type	Description
int	The count of includeNamedCookies.

getIncludeNamedCookiesList()

public ProtocolStringList getIncludeNamedCookiesList()

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Returns

Type	Description
ProtocolStringList	A list containing the includeNamedCookies.

getIncludeProtocol()

public boolean getIncludeProtocol()

If true, http and https requests will be cached separately.

optional bool include_protocol = 303507535;

Returns

Type	Description
boolean	The includeProtocol.

getIncludeQueryString()

public boolean getIncludeQueryString()

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

optional bool include_query_string = 474036639;

Returns

Type	Description
boolean	The includeQueryString.

getQueryStringBlacklist(int index)

public String getQueryStringBlacklist(int index)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Parameter

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

Returns

Type	Description
String	The queryStringBlacklist at the given index.

getQueryStringBlacklistBytes(int index)

public ByteString getQueryStringBlacklistBytes(int index)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Parameter

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

Returns

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

getQueryStringBlacklistCount()

public int getQueryStringBlacklistCount()

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Returns

Type	Description
int	The count of queryStringBlacklist.

getQueryStringBlacklistList()

public ProtocolStringList getQueryStringBlacklistList()

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Returns

Type	Description
ProtocolStringList	A list containing the queryStringBlacklist.

getQueryStringWhitelist(int index)

public String getQueryStringWhitelist(int index)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Parameter

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

Returns

Type	Description
String	The queryStringWhitelist at the given index.

getQueryStringWhitelistBytes(int index)

public ByteString getQueryStringWhitelistBytes(int index)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Parameter

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

Returns

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

getQueryStringWhitelistCount()

public int getQueryStringWhitelistCount()

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Returns

Type	Description
int	The count of queryStringWhitelist.

getQueryStringWhitelistList()

public ProtocolStringList getQueryStringWhitelistList()

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Returns

Type	Description
ProtocolStringList	A list containing the queryStringWhitelist.

hasIncludeHost()

public boolean hasIncludeHost()

If true, requests to different hosts will be cached separately.

optional bool include_host = 486867679;

Returns

Type	Description
boolean	Whether the includeHost field is set.

hasIncludeProtocol()

public boolean hasIncludeProtocol()

If true, http and https requests will be cached separately.

optional bool include_protocol = 303507535;

Returns

Type	Description
boolean	Whether the includeProtocol field is set.

hasIncludeQueryString()

public boolean hasIncludeQueryString()

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

optional bool include_query_string = 474036639;

Returns

Type	Description
boolean	Whether the includeQueryString 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(CacheKeyPolicy other)

public CacheKeyPolicy.Builder mergeFrom(CacheKeyPolicy other)

Parameter

Name	Description
other	CacheKeyPolicy

Returns

Type	Description
CacheKeyPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public CacheKeyPolicy.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CacheKeyPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

setIncludeHost(boolean value)

public CacheKeyPolicy.Builder setIncludeHost(boolean value)

If true, requests to different hosts will be cached separately.

optional bool include_host = 486867679;

Parameter

Name	Description
value	boolean The includeHost to set.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

setIncludeHttpHeaders(int index, String value)

public CacheKeyPolicy.Builder setIncludeHttpHeaders(int index, String value)

Allows HTTP request headers (by name) to be used in the cache key.

repeated string include_http_headers = 2489606;

Parameters

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

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

setIncludeNamedCookies(int index, String value)

public CacheKeyPolicy.Builder setIncludeNamedCookies(int index, String value)

Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.

repeated string include_named_cookies = 87316530;

Parameters

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

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

setIncludeProtocol(boolean value)

public CacheKeyPolicy.Builder setIncludeProtocol(boolean value)

If true, http and https requests will be cached separately.

optional bool include_protocol = 303507535;

Parameter

Name	Description
value	boolean The includeProtocol to set.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

setIncludeQueryString(boolean value)

public CacheKeyPolicy.Builder setIncludeQueryString(boolean value)

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

optional bool include_query_string = 474036639;

Parameter

Name	Description
value	boolean The includeQueryString to set.

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

setQueryStringBlacklist(int index, String value)

public CacheKeyPolicy.Builder setQueryStringBlacklist(int index, String value)

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_blacklist = 354964742;

Parameters

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

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

setQueryStringWhitelist(int index, String value)

public CacheKeyPolicy.Builder setQueryStringWhitelist(int index, String value)

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Parameters

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

Returns

Type	Description
CacheKeyPolicy.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final CacheKeyPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CacheKeyPolicy.Builder

Overrides

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