Package com.google.cloud.compute.v1
Class CacheKeyPolicy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.CacheKeyPolicy
- All Implemented Interfaces:
CacheKeyPolicyOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class CacheKeyPolicy
extends com.google.protobuf.GeneratedMessage
implements CacheKeyPolicyOrBuilder
Message containing what to include in the cache key for a request for Cloud CDN.Protobuf type
google.cloud.compute.v1.CacheKeyPolicy- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classMessage containing what to include in the cache key for a request for Cloud CDN.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic CacheKeyPolicystatic final com.google.protobuf.Descriptors.DescriptorbooleanIf true, requests to different hosts will be cached separately.getIncludeHttpHeaders(int index) Allows HTTP request headers (by name) to be used in the cache key.com.google.protobuf.ByteStringgetIncludeHttpHeadersBytes(int index) Allows HTTP request headers (by name) to be used in the cache key.intAllows HTTP request headers (by name) to be used in the cache key.com.google.protobuf.ProtocolStringListAllows HTTP request headers (by name) to be used in the cache key.getIncludeNamedCookies(int index) Allows HTTP cookies (by name) to be used in the cache key.com.google.protobuf.ByteStringgetIncludeNamedCookiesBytes(int index) Allows HTTP cookies (by name) to be used in the cache key.intAllows HTTP cookies (by name) to be used in the cache key.com.google.protobuf.ProtocolStringListAllows HTTP cookies (by name) to be used in the cache key.booleanIf true, http and https requests will be cached separately.booleanIf true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.com.google.protobuf.Parser<CacheKeyPolicy>getQueryStringBlacklist(int index) Names of query string parameters to exclude in cache keys.com.google.protobuf.ByteStringgetQueryStringBlacklistBytes(int index) Names of query string parameters to exclude in cache keys.intNames of query string parameters to exclude in cache keys.com.google.protobuf.ProtocolStringListNames of query string parameters to exclude in cache keys.getQueryStringWhitelist(int index) Names of query string parameters to include in cache keys.com.google.protobuf.ByteStringgetQueryStringWhitelistBytes(int index) Names of query string parameters to include in cache keys.intNames of query string parameters to include in cache keys.com.google.protobuf.ProtocolStringListNames of query string parameters to include in cache keys.intinthashCode()booleanIf true, requests to different hosts will be cached separately.booleanIf true, http and https requests will be cached separately.booleanIf true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic CacheKeyPolicy.Builderstatic CacheKeyPolicy.BuildernewBuilder(CacheKeyPolicy prototype) protected CacheKeyPolicy.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static CacheKeyPolicyparseDelimitedFrom(InputStream input) static CacheKeyPolicyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CacheKeyPolicyparseFrom(byte[] data) static CacheKeyPolicyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CacheKeyPolicyparseFrom(com.google.protobuf.ByteString data) static CacheKeyPolicyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CacheKeyPolicyparseFrom(com.google.protobuf.CodedInputStream input) static CacheKeyPolicyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CacheKeyPolicyparseFrom(InputStream input) static CacheKeyPolicyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CacheKeyPolicyparseFrom(ByteBuffer data) static CacheKeyPolicyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<CacheKeyPolicy>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
INCLUDE_HOST_FIELD_NUMBER
public static final int INCLUDE_HOST_FIELD_NUMBER- See Also:
-
INCLUDE_HTTP_HEADERS_FIELD_NUMBER
public static final int INCLUDE_HTTP_HEADERS_FIELD_NUMBER- See Also:
-
INCLUDE_NAMED_COOKIES_FIELD_NUMBER
public static final int INCLUDE_NAMED_COOKIES_FIELD_NUMBER- See Also:
-
INCLUDE_PROTOCOL_FIELD_NUMBER
public static final int INCLUDE_PROTOCOL_FIELD_NUMBER- See Also:
-
INCLUDE_QUERY_STRING_FIELD_NUMBER
public static final int INCLUDE_QUERY_STRING_FIELD_NUMBER- See Also:
-
QUERY_STRING_BLACKLIST_FIELD_NUMBER
public static final int QUERY_STRING_BLACKLIST_FIELD_NUMBER- See Also:
-
QUERY_STRING_WHITELIST_FIELD_NUMBER
public static final int QUERY_STRING_WHITELIST_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
hasIncludeHost
public boolean hasIncludeHost()If true, requests to different hosts will be cached separately.
optional bool include_host = 486867679;- Specified by:
hasIncludeHostin interfaceCacheKeyPolicyOrBuilder- Returns:
- Whether the includeHost field is set.
-
getIncludeHost
public boolean getIncludeHost()If true, requests to different hosts will be cached separately.
optional bool include_host = 486867679;- Specified by:
getIncludeHostin interfaceCacheKeyPolicyOrBuilder- Returns:
- The includeHost.
-
getIncludeHttpHeadersList
public com.google.protobuf.ProtocolStringList getIncludeHttpHeadersList()Allows HTTP request headers (by name) to be used in the cache key.
repeated string include_http_headers = 2489606;- Specified by:
getIncludeHttpHeadersListin interfaceCacheKeyPolicyOrBuilder- Returns:
- A list containing the includeHttpHeaders.
-
getIncludeHttpHeadersCount
public int getIncludeHttpHeadersCount()Allows HTTP request headers (by name) to be used in the cache key.
repeated string include_http_headers = 2489606;- Specified by:
getIncludeHttpHeadersCountin interfaceCacheKeyPolicyOrBuilder- Returns:
- The count of includeHttpHeaders.
-
getIncludeHttpHeaders
Allows HTTP request headers (by name) to be used in the cache key.
repeated string include_http_headers = 2489606;- Specified by:
getIncludeHttpHeadersin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The includeHttpHeaders at the given index.
-
getIncludeHttpHeadersBytes
public com.google.protobuf.ByteString getIncludeHttpHeadersBytes(int index) Allows HTTP request headers (by name) to be used in the cache key.
repeated string include_http_headers = 2489606;- Specified by:
getIncludeHttpHeadersBytesin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the includeHttpHeaders at the given index.
-
getIncludeNamedCookiesList
public com.google.protobuf.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;- Specified by:
getIncludeNamedCookiesListin interfaceCacheKeyPolicyOrBuilder- Returns:
- A list containing the includeNamedCookies.
-
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;- Specified by:
getIncludeNamedCookiesCountin interfaceCacheKeyPolicyOrBuilder- Returns:
- The count of includeNamedCookies.
-
getIncludeNamedCookies
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;- Specified by:
getIncludeNamedCookiesin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The includeNamedCookies at the given index.
-
getIncludeNamedCookiesBytes
public com.google.protobuf.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;- Specified by:
getIncludeNamedCookiesBytesin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the includeNamedCookies at the given index.
-
hasIncludeProtocol
public boolean hasIncludeProtocol()If true, http and https requests will be cached separately.
optional bool include_protocol = 303507535;- Specified by:
hasIncludeProtocolin interfaceCacheKeyPolicyOrBuilder- Returns:
- Whether the includeProtocol field is set.
-
getIncludeProtocol
public boolean getIncludeProtocol()If true, http and https requests will be cached separately.
optional bool include_protocol = 303507535;- Specified by:
getIncludeProtocolin interfaceCacheKeyPolicyOrBuilder- Returns:
- The includeProtocol.
-
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;- Specified by:
hasIncludeQueryStringin interfaceCacheKeyPolicyOrBuilder- Returns:
- Whether the includeQueryString field is set.
-
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;- Specified by:
getIncludeQueryStringin interfaceCacheKeyPolicyOrBuilder- Returns:
- The includeQueryString.
-
getQueryStringBlacklistList
public com.google.protobuf.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;- Specified by:
getQueryStringBlacklistListin interfaceCacheKeyPolicyOrBuilder- Returns:
- A list containing the queryStringBlacklist.
-
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;- Specified by:
getQueryStringBlacklistCountin interfaceCacheKeyPolicyOrBuilder- Returns:
- The count of queryStringBlacklist.
-
getQueryStringBlacklist
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;- Specified by:
getQueryStringBlacklistin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The queryStringBlacklist at the given index.
-
getQueryStringBlacklistBytes
public com.google.protobuf.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;- Specified by:
getQueryStringBlacklistBytesin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the queryStringBlacklist at the given index.
-
getQueryStringWhitelistList
public com.google.protobuf.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;- Specified by:
getQueryStringWhitelistListin interfaceCacheKeyPolicyOrBuilder- Returns:
- A list containing the queryStringWhitelist.
-
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;- Specified by:
getQueryStringWhitelistCountin interfaceCacheKeyPolicyOrBuilder- Returns:
- The count of queryStringWhitelist.
-
getQueryStringWhitelist
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;- Specified by:
getQueryStringWhitelistin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The queryStringWhitelist at the given index.
-
getQueryStringWhitelistBytes
public com.google.protobuf.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;- Specified by:
getQueryStringWhitelistBytesin interfaceCacheKeyPolicyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the queryStringWhitelist at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CacheKeyPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CacheKeyPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CacheKeyPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CacheKeyPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CacheKeyPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CacheKeyPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static CacheKeyPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static CacheKeyPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static CacheKeyPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static CacheKeyPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CacheKeyPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-