- 1.62.0 (latest)
- 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.BuilderImplements
CacheKeyPolicyOrBuilderMethods
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;
Name | Description |
values | Iterable<String> The queryStringBlacklist to add. |
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;
Name | Description |
values | Iterable<String> The queryStringWhitelist to add. |
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;
Name | Description |
value | String The queryStringBlacklist to add. |
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;
Name | Description |
value | ByteString The bytes of the queryStringBlacklist to add. |
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;
Name | Description |
value | String The queryStringWhitelist to add. |
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;
Name | Description |
value | ByteString The bytes of the queryStringWhitelist to add. |
Type | Description |
CacheKeyPolicy.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CacheKeyPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
CacheKeyPolicy.Builder |
build()
public CacheKeyPolicy build()
Type | Description |
CacheKeyPolicy |
buildPartial()
public CacheKeyPolicy buildPartial()
Type | Description |
CacheKeyPolicy |
clear()
public CacheKeyPolicy.Builder clear()
Type | Description |
CacheKeyPolicy.Builder |
clearField(Descriptors.FieldDescriptor field)
public CacheKeyPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
CacheKeyPolicy.Builder |
clearIncludeHost()
public CacheKeyPolicy.Builder clearIncludeHost()
If true, requests to different hosts will be cached separately.
optional bool include_host = 486867679;
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;
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;
Type | Description |
CacheKeyPolicy.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CacheKeyPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
CacheKeyPolicy.Builder |
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;
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;
Type | Description |
CacheKeyPolicy.Builder | This builder for chaining. |
clone()
public CacheKeyPolicy.Builder clone()
Type | Description |
CacheKeyPolicy.Builder |
getDefaultInstanceForType()
public CacheKeyPolicy getDefaultInstanceForType()
Type | Description |
CacheKeyPolicy |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getIncludeHost()
public boolean getIncludeHost()
If true, requests to different hosts will be cached separately.
optional bool include_host = 486867679;
Type | Description |
boolean | The includeHost. |
getIncludeProtocol()
public boolean getIncludeProtocol()
If true, http and https requests will be cached separately.
optional bool include_protocol = 303507535;
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;
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;
Name | Description |
index | int The index of the element to return. |
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;
Name | Description |
index | int The index of the value to return. |
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;
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;
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;
Name | Description |
index | int The index of the element to return. |
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;
Name | Description |
index | int The index of the value to return. |
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;
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;
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;
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;
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;
Type | Description |
boolean | Whether the includeQueryString field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(CacheKeyPolicy other)
public CacheKeyPolicy.Builder mergeFrom(CacheKeyPolicy other)
Name | Description |
other | CacheKeyPolicy |
Type | Description |
CacheKeyPolicy.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CacheKeyPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
CacheKeyPolicy.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public CacheKeyPolicy.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
CacheKeyPolicy.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CacheKeyPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
CacheKeyPolicy.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CacheKeyPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
CacheKeyPolicy.Builder |
setIncludeHost(boolean value)
public CacheKeyPolicy.Builder setIncludeHost(boolean value)
If true, requests to different hosts will be cached separately.
optional bool include_host = 486867679;
Name | Description |
value | boolean The includeHost to set. |
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;
Name | Description |
value | boolean The includeProtocol to set. |
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;
Name | Description |
value | boolean The includeQueryString to set. |
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;
Name | Description |
index | int The index to set the value at. |
value | String The queryStringBlacklist to set. |
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;
Name | Description |
index | int The index to set the value at. |
value | String The queryStringWhitelist to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
CacheKeyPolicy.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final CacheKeyPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
CacheKeyPolicy.Builder |