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 Classes
    Modifier and Type
    Class
    Description
    static final class 
    Message 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.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    boolean
    If true, requests to different hosts will be cached separately.
    Allows HTTP request headers (by name) to be used in the cache key.
    com.google.protobuf.ByteString
    Allows HTTP request headers (by name) to be used in the cache key.
    int
    Allows HTTP request headers (by name) to be used in the cache key.
    com.google.protobuf.ProtocolStringList
    Allows HTTP request headers (by name) to be used in the cache key.
    Allows HTTP cookies (by name) to be used in the cache key.
    com.google.protobuf.ByteString
    Allows HTTP cookies (by name) to be used in the cache key.
    int
    Allows HTTP cookies (by name) to be used in the cache key.
    com.google.protobuf.ProtocolStringList
    Allows HTTP cookies (by name) to be used in the cache key.
    boolean
    If true, http and https requests will be cached separately.
    boolean
    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.
    com.google.protobuf.Parser<CacheKeyPolicy>
     
    Names of query string parameters to exclude in cache keys.
    com.google.protobuf.ByteString
    Names of query string parameters to exclude in cache keys.
    int
    Names of query string parameters to exclude in cache keys.
    com.google.protobuf.ProtocolStringList
    Names of query string parameters to exclude in cache keys.
    Names of query string parameters to include in cache keys.
    com.google.protobuf.ByteString
    Names of query string parameters to include in cache keys.
    int
    Names of query string parameters to include in cache keys.
    com.google.protobuf.ProtocolStringList
    Names of query string parameters to include in cache keys.
    int
     
    int
     
    boolean
    If true, requests to different hosts will be cached separately.
    boolean
    If true, http and https requests will be cached separately.
    boolean
    If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CacheKeyPolicy>
     
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods 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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CacheKeyPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CacheKeyPolicy parseDelimitedFrom(InputStream input) throws IOException
      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

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

      public static CacheKeyPolicy.Builder newBuilder()
    • newBuilder

      public static CacheKeyPolicy.Builder newBuilder(CacheKeyPolicy prototype)
    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

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