Package com.google.cloud.compute.v1

Class CacheKeyPolicy

  • All Implemented Interfaces:
    CacheKeyPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CacheKeyPolicy
extends com.google.protobuf.GeneratedMessageV3
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:
    Serialized Form

    • Field Detail

      • INCLUDE_HOST_FIELD_NUMBER

        public static final int INCLUDE_HOST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_HTTP_HEADERS_FIELD_NUMBER

        public static final int INCLUDE_HTTP_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_NAMED_COOKIES_FIELD_NUMBER

        public static final int INCLUDE_NAMED_COOKIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_PROTOCOL_FIELD_NUMBER

        public static final int INCLUDE_PROTOCOL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_QUERY_STRING_FIELD_NUMBER

        public static final int INCLUDE_QUERY_STRING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_STRING_BLACKLIST_FIELD_NUMBER

        public static final int QUERY_STRING_BLACKLIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_STRING_WHITELIST_FIELD_NUMBER

        public static final int QUERY_STRING_WHITELIST_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasIncludeHost

        public boolean hasIncludeHost()
         If true, requests to different hosts will be cached separately.
        optional bool include_host = 486867679;
        Specified by:
        hasIncludeHost in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeHost in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeHttpHeadersList in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeHttpHeadersCount in interface CacheKeyPolicyOrBuilder
        Returns:
        The count of includeHttpHeaders.

      • getIncludeHttpHeaders

        public String getIncludeHttpHeaders​(int index)
         Allows HTTP request headers (by name) to be used in the cache key.
        repeated string include_http_headers = 2489606;
        Specified by:
        getIncludeHttpHeaders in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeHttpHeadersBytes in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeNamedCookiesList in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeNamedCookiesCount in interface CacheKeyPolicyOrBuilder
        Returns:
        The count of includeNamedCookies.

      • getIncludeNamedCookies

        public String getIncludeNamedCookies​(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:
        getIncludeNamedCookies in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeNamedCookiesBytes in interface CacheKeyPolicyOrBuilder
        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:
        hasIncludeProtocol in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeProtocol in interface CacheKeyPolicyOrBuilder
        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:
        hasIncludeQueryString in interface CacheKeyPolicyOrBuilder
        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:
        getIncludeQueryString in interface CacheKeyPolicyOrBuilder
        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:
        getQueryStringBlacklistList in interface CacheKeyPolicyOrBuilder
        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:
        getQueryStringBlacklistCount in interface CacheKeyPolicyOrBuilder
        Returns:
        The count of queryStringBlacklist.

      • getQueryStringBlacklist

        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;
        Specified by:
        getQueryStringBlacklist in interface CacheKeyPolicyOrBuilder
        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:
        getQueryStringBlacklistBytes in interface CacheKeyPolicyOrBuilder
        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:
        getQueryStringWhitelistList in interface CacheKeyPolicyOrBuilder
        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:
        getQueryStringWhitelistCount in interface CacheKeyPolicyOrBuilder
        Returns:
        The count of queryStringWhitelist.

      • getQueryStringWhitelist

        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;
        Specified by:
        getQueryStringWhitelist in interface CacheKeyPolicyOrBuilder
        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:
        getQueryStringWhitelistBytes in interface CacheKeyPolicyOrBuilder
        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:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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

        public static CacheKeyPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public CacheKeyPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CacheKeyPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CacheKeyPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static CacheKeyPolicy getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<CacheKeyPolicy> parser()

      • getParserForType

        public com.google.protobuf.Parser<CacheKeyPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CacheKeyPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder