Package com.google.cloud.compute.v1

Class CacheKeyPolicy.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CacheKeyPolicy.Builder>
com.google.cloud.compute.v1.CacheKeyPolicy.Builder
All Implemented Interfaces:
CacheKeyPolicyOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CacheKeyPolicy
public static final class CacheKeyPolicy.Builder extends com.google.protobuf.GeneratedMessage.Builder<CacheKeyPolicy.Builder> implements CacheKeyPolicyOrBuilder
 Message containing what to include in the cache key for a request for Cloud
 CDN.
Protobuf type google.cloud.compute.v1.CacheKeyPolicy

  • 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.Builder<CacheKeyPolicy.Builder>

    • clear

      public CacheKeyPolicy.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CacheKeyPolicy.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CacheKeyPolicy.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public CacheKeyPolicy.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CacheKeyPolicy.Builder>

    • mergeFrom

      public CacheKeyPolicy.Builder mergeFrom(CacheKeyPolicy other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CacheKeyPolicy.Builder>

    • mergeFrom

      public CacheKeyPolicy.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CacheKeyPolicy.Builder>
      Throws:
      IOException

    • 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.

    • setIncludeHost

      public CacheKeyPolicy.Builder setIncludeHost(boolean value)
       If true, requests to different hosts will be cached separately.
      optional bool include_host = 486867679;
      Parameters:
      value - The includeHost to set.
      Returns:
      This builder for chaining.

    • clearIncludeHost

      public CacheKeyPolicy.Builder clearIncludeHost()
       If true, requests to different hosts will be cached separately.
      optional bool include_host = 486867679;
      Returns:
      This builder for chaining.

    • 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.

    • setIncludeHttpHeaders

      public CacheKeyPolicy.Builder setIncludeHttpHeaders(int index, String value)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string include_http_headers = 2489606;
      Parameters:
      index - The index to set the value at.
      value - The includeHttpHeaders to set.
      Returns:
      This builder for chaining.

    • addIncludeHttpHeaders

      public CacheKeyPolicy.Builder addIncludeHttpHeaders(String value)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string include_http_headers = 2489606;
      Parameters:
      value - The includeHttpHeaders to add.
      Returns:
      This builder for chaining.

    • addAllIncludeHttpHeaders

      public CacheKeyPolicy.Builder addAllIncludeHttpHeaders(Iterable<String> values)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string include_http_headers = 2489606;
      Parameters:
      values - The includeHttpHeaders to add.
      Returns:
      This builder for chaining.

    • clearIncludeHttpHeaders

      public CacheKeyPolicy.Builder clearIncludeHttpHeaders()
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string include_http_headers = 2489606;
      Returns:
      This builder for chaining.

    • addIncludeHttpHeadersBytes

      public CacheKeyPolicy.Builder addIncludeHttpHeadersBytes(com.google.protobuf.ByteString value)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string include_http_headers = 2489606;
      Parameters:
      value - The bytes of the includeHttpHeaders to add.
      Returns:
      This builder for chaining.

    • 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.

    • setIncludeNamedCookies

      public CacheKeyPolicy.Builder setIncludeNamedCookies(int index, String value)
       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;
      Parameters:
      index - The index to set the value at.
      value - The includeNamedCookies to set.
      Returns:
      This builder for chaining.

    • addIncludeNamedCookies

      public CacheKeyPolicy.Builder addIncludeNamedCookies(String value)
       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;
      Parameters:
      value - The includeNamedCookies to add.
      Returns:
      This builder for chaining.

    • addAllIncludeNamedCookies

      public CacheKeyPolicy.Builder addAllIncludeNamedCookies(Iterable<String> values)
       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;
      Parameters:
      values - The includeNamedCookies to add.
      Returns:
      This builder for chaining.

    • clearIncludeNamedCookies

      public CacheKeyPolicy.Builder clearIncludeNamedCookies()
       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;
      Returns:
      This builder for chaining.

    • addIncludeNamedCookiesBytes

      public CacheKeyPolicy.Builder addIncludeNamedCookiesBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes of the includeNamedCookies to add.
      Returns:
      This builder for chaining.

    • 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.

    • setIncludeProtocol

      public CacheKeyPolicy.Builder setIncludeProtocol(boolean value)
       If true, http and https requests will be cached separately.
      optional bool include_protocol = 303507535;
      Parameters:
      value - The includeProtocol to set.
      Returns:
      This builder for chaining.

    • clearIncludeProtocol

      public CacheKeyPolicy.Builder clearIncludeProtocol()
       If true, http and https requests will be cached separately.
      optional bool include_protocol = 303507535;
      Returns:
      This builder for chaining.

    • 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.

    • setIncludeQueryString

      public CacheKeyPolicy.Builder setIncludeQueryString(boolean value)
       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;
      Parameters:
      value - The includeQueryString to set.
      Returns:
      This builder for chaining.

    • clearIncludeQueryString

      public CacheKeyPolicy.Builder clearIncludeQueryString()
       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;
      Returns:
      This builder for chaining.

    • 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.

    • setQueryStringBlacklist

      public CacheKeyPolicy.Builder setQueryStringBlacklist(int index, String value)
       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;
      Parameters:
      index - The index to set the value at.
      value - The queryStringBlacklist to set.
      Returns:
      This builder for chaining.

    • addQueryStringBlacklist

      public CacheKeyPolicy.Builder addQueryStringBlacklist(String value)
       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;
      Parameters:
      value - The queryStringBlacklist to add.
      Returns:
      This builder for chaining.

    • addAllQueryStringBlacklist

      public CacheKeyPolicy.Builder addAllQueryStringBlacklist(Iterable<String> values)
       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;
      Parameters:
      values - The queryStringBlacklist to add.
      Returns:
      This builder for chaining.

    • clearQueryStringBlacklist

      public CacheKeyPolicy.Builder clearQueryStringBlacklist()
       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;
      Returns:
      This builder for chaining.

    • addQueryStringBlacklistBytes

      public CacheKeyPolicy.Builder addQueryStringBlacklistBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes of the queryStringBlacklist to add.
      Returns:
      This builder for chaining.

    • 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.

    • setQueryStringWhitelist

      public CacheKeyPolicy.Builder setQueryStringWhitelist(int index, String value)
       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;
      Parameters:
      index - The index to set the value at.
      value - The queryStringWhitelist to set.
      Returns:
      This builder for chaining.

    • addQueryStringWhitelist

      public CacheKeyPolicy.Builder addQueryStringWhitelist(String value)
       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;
      Parameters:
      value - The queryStringWhitelist to add.
      Returns:
      This builder for chaining.

    • addAllQueryStringWhitelist

      public CacheKeyPolicy.Builder addAllQueryStringWhitelist(Iterable<String> values)
       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;
      Parameters:
      values - The queryStringWhitelist to add.
      Returns:
      This builder for chaining.

    • clearQueryStringWhitelist

      public CacheKeyPolicy.Builder clearQueryStringWhitelist()
       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;
      Returns:
      This builder for chaining.

    • addQueryStringWhitelistBytes

      public CacheKeyPolicy.Builder addQueryStringWhitelistBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes of the queryStringWhitelist to add.
      Returns:
      This builder for chaining.