Class BackendBucketCdnPolicyCacheKeyPolicy.Builder (1.54.0)

public static final class BackendBucketCdnPolicyCacheKeyPolicy.Builder extends GeneratedMessageV3.Builder<BackendBucketCdnPolicyCacheKeyPolicy.Builder> implements BackendBucketCdnPolicyCacheKeyPolicyOrBuilder

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

Protobuf type google.cloud.compute.v1.BackendBucketCdnPolicyCacheKeyPolicy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllIncludeHttpHeaders(Iterable<String> values)

public BackendBucketCdnPolicyCacheKeyPolicy.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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

addAllQueryStringWhitelist(Iterable<String> values)

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

Names of query string parameters to include in cache keys. Default parameters are always included. '&' 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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

addIncludeHttpHeaders(String value)

public BackendBucketCdnPolicyCacheKeyPolicy.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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

addIncludeHttpHeadersBytes(ByteString value)

public BackendBucketCdnPolicyCacheKeyPolicy.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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

addQueryStringWhitelist(String value)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder addQueryStringWhitelist(String value)

Names of query string parameters to include in cache keys. Default parameters are always included. '&' 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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

addQueryStringWhitelistBytes(ByteString value)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder addQueryStringWhitelistBytes(ByteString value)

Names of query string parameters to include in cache keys. Default parameters are always included. '&' 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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

build()

public BackendBucketCdnPolicyCacheKeyPolicy build()
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy

buildPartial()

public BackendBucketCdnPolicyCacheKeyPolicy buildPartial()
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy

clear()

public BackendBucketCdnPolicyCacheKeyPolicy.Builder clear()
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

clearIncludeHttpHeaders()

public BackendBucketCdnPolicyCacheKeyPolicy.Builder clearIncludeHttpHeaders()

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

repeated string include_http_headers = 2489606;

Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

clearQueryStringWhitelist()

public BackendBucketCdnPolicyCacheKeyPolicy.Builder clearQueryStringWhitelist()

Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters.

repeated string query_string_whitelist = 52456496;

Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

clone()

public BackendBucketCdnPolicyCacheKeyPolicy.Builder clone()
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

getDefaultInstanceForType()

public BackendBucketCdnPolicyCacheKeyPolicy getDefaultInstanceForType()
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getQueryStringWhitelist(int index)

public String getQueryStringWhitelist(int index)

Names of query string parameters to include in cache keys. Default parameters are always included. '&' 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. Default parameters are always included. '&' 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. Default parameters are always included. '&' 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. Default parameters are always included. '&' 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BackendBucketCdnPolicyCacheKeyPolicy other)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder mergeFrom(BackendBucketCdnPolicyCacheKeyPolicy other)
Parameter
Name Description
other BackendBucketCdnPolicyCacheKeyPolicy
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendBucketCdnPolicyCacheKeyPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public BackendBucketCdnPolicyCacheKeyPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

setIncludeHttpHeaders(int index, String value)

public BackendBucketCdnPolicyCacheKeyPolicy.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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

setQueryStringWhitelist(int index, String value)

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

Names of query string parameters to include in cache keys. Default parameters are always included. '&' 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
BackendBucketCdnPolicyCacheKeyPolicy.Builder

This builder for chaining.

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

public BackendBucketCdnPolicyCacheKeyPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendBucketCdnPolicyCacheKeyPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackendBucketCdnPolicyCacheKeyPolicy.Builder
Overrides