Package com.google.cloud.compute.v1

Interface CachePolicyCacheKeyPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CachePolicyCacheKeyPolicy, CachePolicyCacheKeyPolicy.Builder
@Generated public interface CachePolicyCacheKeyPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getExcludedQueryParametersList

      List<String> 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:
      A list containing the excludedQueryParameters.

    • getExcludedQueryParametersCount

      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:
      The count of excludedQueryParameters.

    • getExcludedQueryParameters

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedQueryParameters at the given index.

    • getExcludedQueryParametersBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the excludedQueryParameters at the given index.

    • hasIncludeHost

      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:
      Whether the includeHost field is set.

    • getIncludeHost

      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:
      The includeHost.

    • hasIncludeProtocol

      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:
      Whether the includeProtocol field is set.

    • getIncludeProtocol

      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:
      The includeProtocol.

    • hasIncludeQueryString

      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:
      Whether the includeQueryString field is set.

    • getIncludeQueryString

      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:
      The includeQueryString.

    • getIncludedCookieNamesList

      List<String> 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;
      Returns:
      A list containing the includedCookieNames.

    • getIncludedCookieNamesCount

      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:
      The count of includedCookieNames.

    • getIncludedCookieNames

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedCookieNames at the given index.

    • getIncludedCookieNamesBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedCookieNames at the given index.

    • getIncludedHeaderNamesList

      List<String> getIncludedHeaderNamesList()
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Returns:
      A list containing the includedHeaderNames.

    • getIncludedHeaderNamesCount

      int getIncludedHeaderNamesCount()
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Returns:
      The count of includedHeaderNames.

    • getIncludedHeaderNames

      String getIncludedHeaderNames(int index)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedHeaderNames at the given index.

    • getIncludedHeaderNamesBytes

      com.google.protobuf.ByteString getIncludedHeaderNamesBytes(int index)
       Allows HTTP request headers (by name) to be used in the cache key.
      repeated string included_header_names = 533756345;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedHeaderNames at the given index.

    • getIncludedQueryParametersList

      List<String> 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:
      A list containing the includedQueryParameters.

    • getIncludedQueryParametersCount

      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:
      The count of includedQueryParameters.

    • getIncludedQueryParameters

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedQueryParameters at the given index.

    • getIncludedQueryParametersBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedQueryParameters at the given index.