Class CachePolicyCacheKeyPolicy (1.105.0)

public final class CachePolicyCacheKeyPolicy extends GeneratedMessage implements CachePolicyCacheKeyPolicyOrBuilder

Message containing what to include in the cache key for a request for Cache Policy defined on Route Action.

Protobuf type google.cloud.compute.v1.CachePolicyCacheKeyPolicy

Static Fields

EXCLUDED_QUERY_PARAMETERS_FIELD_NUMBER

public static final int EXCLUDED_QUERY_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int
public static final int INCLUDED_COOKIE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

INCLUDED_HEADER_NAMES_FIELD_NUMBER

public static final int INCLUDED_HEADER_NAMES_FIELD_NUMBER
Field Value
Type Description
int

INCLUDED_QUERY_PARAMETERS_FIELD_NUMBER

public static final int INCLUDED_QUERY_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_HOST_FIELD_NUMBER

public static final int INCLUDE_HOST_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_PROTOCOL_FIELD_NUMBER

public static final int INCLUDE_PROTOCOL_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_QUERY_STRING_FIELD_NUMBER

public static final int INCLUDE_QUERY_STRING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CachePolicyCacheKeyPolicy getDefaultInstance()
Returns
Type Description
CachePolicyCacheKeyPolicy

getDescriptor()

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

newBuilder()

public static CachePolicyCacheKeyPolicy.Builder newBuilder()
Returns
Type Description
CachePolicyCacheKeyPolicy.Builder

newBuilder(CachePolicyCacheKeyPolicy prototype)

public static CachePolicyCacheKeyPolicy.Builder newBuilder(CachePolicyCacheKeyPolicy prototype)
Parameter
Name Description
prototype CachePolicyCacheKeyPolicy
Returns
Type Description
CachePolicyCacheKeyPolicy.Builder

parseDelimitedFrom(InputStream input)

public static CachePolicyCacheKeyPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CachePolicyCacheKeyPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CachePolicyCacheKeyPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CachePolicyCacheKeyPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CachePolicyCacheKeyPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CachePolicyCacheKeyPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CachePolicyCacheKeyPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CachePolicyCacheKeyPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CachePolicyCacheKeyPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CachePolicyCacheKeyPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CachePolicyCacheKeyPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CachePolicyCacheKeyPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CachePolicyCacheKeyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CachePolicyCacheKeyPolicy> parser()
Returns
Type Description
Parser<CachePolicyCacheKeyPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CachePolicyCacheKeyPolicy getDefaultInstanceForType()
Returns
Type Description
CachePolicyCacheKeyPolicy

getExcludedQueryParameters(int index)

public String getExcludedQueryParameters(int index)

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

Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters to define which parameters should be part of the cache key.

repeated string excluded_query_parameters = 124896150;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludedQueryParameters at the given index.

getExcludedQueryParametersBytes(int index)

public ByteString getExcludedQueryParametersBytes(int index)

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

Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters to define which parameters should be part of the cache key.

repeated string excluded_query_parameters = 124896150;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludedQueryParameters at the given index.

getExcludedQueryParametersCount()

public int getExcludedQueryParametersCount()

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

Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters to define which parameters should be part of the cache key.

repeated string excluded_query_parameters = 124896150;

Returns
Type Description
int

The count of excludedQueryParameters.

getExcludedQueryParametersList()

public ProtocolStringList getExcludedQueryParametersList()

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

Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters to define which parameters should be part of the cache key.

repeated string excluded_query_parameters = 124896150;

Returns
Type Description
ProtocolStringList

A list containing the excludedQueryParameters.

getIncludeHost()

public boolean getIncludeHost()

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

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the host is never included in a Backend Bucket's cache key. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error.

optional bool include_host = 486867679;

Returns
Type Description
boolean

The includeHost.

getIncludeProtocol()

public boolean getIncludeProtocol()

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

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the protocol is never included in a Backend Bucket's cache key. Attempting to set on a route that points exclusively to Backend Buckets will result in a configuration error.

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 includedQueryParameters and excludedQueryParameters. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters to define which parameters should be part of the cache key.

optional bool include_query_string = 474036639;

Returns
Type Description
boolean

The includeQueryString.

getIncludedCookieNames(int index)

public String getIncludedCookieNames(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.

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.

repeated string included_cookie_names = 66987088;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The includedCookieNames at the given index.

getIncludedCookieNamesBytes(int index)

public ByteString getIncludedCookieNamesBytes(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.

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.

repeated string included_cookie_names = 66987088;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the includedCookieNames at the given index.

getIncludedCookieNamesCount()

public int getIncludedCookieNamesCount()

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.

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.

repeated string included_cookie_names = 66987088;

Returns
Type Description
int

The count of includedCookieNames.

getIncludedCookieNamesList()

public ProtocolStringList getIncludedCookieNamesList()

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.

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. Up to 5 cookie names can be specified.

repeated string included_cookie_names = 66987088;

Returns
Type Description
ProtocolStringList

A list containing the includedCookieNames.

getIncludedHeaderNames(int index)

public String getIncludedHeaderNames(int index)

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

repeated string included_header_names = 533756345;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The includedHeaderNames at the given index.

getIncludedHeaderNamesBytes(int index)

public ByteString getIncludedHeaderNamesBytes(int index)

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

repeated string included_header_names = 533756345;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the includedHeaderNames at the given index.

getIncludedHeaderNamesCount()

public int getIncludedHeaderNamesCount()

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

repeated string included_header_names = 533756345;

Returns
Type Description
int

The count of includedHeaderNames.

getIncludedHeaderNamesList()

public ProtocolStringList getIncludedHeaderNamesList()

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

repeated string included_header_names = 533756345;

Returns
Type Description
ProtocolStringList

A list containing the includedHeaderNames.

getIncludedQueryParameters(int index)

public String getIncludedQueryParameters(int index)

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

repeated string included_query_parameters = 2319076;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The includedQueryParameters at the given index.

getIncludedQueryParametersBytes(int index)

public ByteString getIncludedQueryParametersBytes(int index)

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

repeated string included_query_parameters = 2319076;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the includedQueryParameters at the given index.

getIncludedQueryParametersCount()

public int getIncludedQueryParametersCount()

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

repeated string included_query_parameters = 2319076;

Returns
Type Description
int

The count of includedQueryParameters.

getIncludedQueryParametersList()

public ProtocolStringList getIncludedQueryParametersList()

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

repeated string included_query_parameters = 2319076;

Returns
Type Description
ProtocolStringList

A list containing the includedQueryParameters.

getParserForType()

public Parser<CachePolicyCacheKeyPolicy> getParserForType()
Returns
Type Description
Parser<CachePolicyCacheKeyPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasIncludeHost()

public boolean hasIncludeHost()

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

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the host is never included in a Backend Bucket's cache key. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error.

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.

Note: This setting is only applicable to routes that use a Backend Service. It does not affect requests served by a Backend Bucket, as the protocol is never included in a Backend Bucket's cache key. Attempting to set on a route that points exclusively to Backend Buckets will result in a configuration error.

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 includedQueryParameters and excludedQueryParameters. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

Note: This field applies to routes that use backend services. Attempting to set it on a route that points exclusively to Backend Buckets will result in a configuration error. For routes that point to a Backend Bucket, use includedQueryParameters to define which parameters should be part of the cache key.

optional bool include_query_string = 474036639;

Returns
Type Description
boolean

Whether the includeQueryString field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CachePolicyCacheKeyPolicy.Builder newBuilderForType()
Returns
Type Description
CachePolicyCacheKeyPolicy.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CachePolicyCacheKeyPolicy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CachePolicyCacheKeyPolicy.Builder
Overrides

toBuilder()

public CachePolicyCacheKeyPolicy.Builder toBuilder()
Returns
Type Description
CachePolicyCacheKeyPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException