Class: Google::Apis::ComputeAlpha::CacheKeyPolicy

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

Message containing what to include in the cache key for a request for Cloud CDN.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CacheKeyPolicy

Returns a new instance of CacheKeyPolicy.



8289
8290
8291
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8289

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#include_host ⇒ Boolean Also known as: include_host?

If true, requests to different hosts will be cached separately. Corresponds to the JSON property includeHost

Returns:

  • (Boolean) 


8244
8245
8246
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8244

def include_host
  @include_host
end

#include_http_headers ⇒ Array<String>

Allows HTTP request headers (by name) to be used in the cache key. Corresponds to the JSON property includeHttpHeaders

Returns:

  • (Array<String>) 


8250
8251
8252
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8250

def include_http_headers
  @include_http_headers
end

#include_named_cookies ⇒ Array<String>

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. Corresponds to the JSON property includeNamedCookies

Returns:

  • (Array<String>) 


8256
8257
8258
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8256

def include_named_cookies
  @include_named_cookies
end

#include_protocol ⇒ Boolean Also known as: include_protocol?

If true, http and https requests will be cached separately. Corresponds to the JSON property includeProtocol

Returns:

  • (Boolean) 


8261
8262
8263
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8261

def include_protocol
  @include_protocol
end

#include_query_string ⇒ Boolean Also known as: include_query_string?

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. Corresponds to the JSON property includeQueryString

Returns:

  • (Boolean) 


8270
8271
8272
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8270

def include_query_string
  @include_query_string
end

#query_string_blacklist ⇒ Array<String>

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. Corresponds to the JSON property queryStringBlacklist

Returns:

  • (Array<String>) 


8279
8280
8281
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8279

def query_string_blacklist
  @query_string_blacklist
end

#query_string_whitelist ⇒ Array<String>

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. Corresponds to the JSON property queryStringWhitelist

Returns:

  • (Array<String>) 


8287
8288
8289
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8287

def query_string_whitelist
  @query_string_whitelist
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8294
8295
8296
8297
8298
8299
8300
8301
8302
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 8294

def update!(**args)
  @include_host = args[:include_host] if args.key?(:include_host)
  @include_http_headers = args[:include_http_headers] if args.key?(:include_http_headers)
  @include_named_cookies = args[:include_named_cookies] if args.key?(:include_named_cookies)
  @include_protocol = args[:include_protocol] if args.key?(:include_protocol)
  @include_query_string = args[:include_query_string] if args.key?(:include_query_string)
  @query_string_blacklist = args[:query_string_blacklist] if args.key?(:query_string_blacklist)
  @query_string_whitelist = args[:query_string_whitelist] if args.key?(:query_string_whitelist)
end