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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
EXCLUDED_QUERY_PARAMETERS_FIELD_NUMBER
public static final int EXCLUDED_QUERY_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INCLUDED_COOKIE_NAMES_FIELD_NUMBER
public static final int INCLUDED_COOKIE_NAMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CachePolicyCacheKeyPolicy.Builder newBuilder()
newBuilder(CachePolicyCacheKeyPolicy prototype)
public static CachePolicyCacheKeyPolicy.Builder newBuilder(CachePolicyCacheKeyPolicy prototype)
public static CachePolicyCacheKeyPolicy parseDelimitedFrom(InputStream input)
public static CachePolicyCacheKeyPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CachePolicyCacheKeyPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CachePolicyCacheKeyPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CachePolicyCacheKeyPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CachePolicyCacheKeyPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CachePolicyCacheKeyPolicy parseFrom(CodedInputStream input)
public static CachePolicyCacheKeyPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CachePolicyCacheKeyPolicy parseFrom(InputStream input)
public static CachePolicyCacheKeyPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CachePolicyCacheKeyPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CachePolicyCacheKeyPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CachePolicyCacheKeyPolicy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CachePolicyCacheKeyPolicy getDefaultInstanceForType()
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;
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.
|
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.
|
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.
|
public ProtocolStringList getIncludedHeaderNamesList()
Allows HTTP request headers (by name) to be used in the cache key.
repeated string included_header_names = 533756345;
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CachePolicyCacheKeyPolicy.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected CachePolicyCacheKeyPolicy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public CachePolicyCacheKeyPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides