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

Inherits:

Object

• Object
• Google::Apis::ComputeAlpha::CacheKeyPolicy

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb more...

Overview

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

Instance Attribute Summary

• #include_host ⇒ Boolean (also: #include_host?)

  If true, requests to different hosts will be cached separately.

• #include_protocol ⇒ Boolean (also: #include_protocol?)

  If true, http and https requests will be cached separately.

• #include_query_string ⇒ Boolean (also: #include_query_string?)

  If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist.

• #query_string_blacklist ⇒ Array<String>

  Names of query string parameters to exclude in cache keys.

• #query_string_whitelist ⇒ Array<String>

  Names of query string parameters to include in cache keys.

Instance Method Summary

• #initialize(**args) ⇒ CacheKeyPolicy constructor

  A new instance of CacheKeyPolicy.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CacheKeyPolicy

Returns a new instance of CacheKeyPolicy

# File 'generated/google/apis/compute_alpha/classes.rb', line 4079

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)

# File 'generated/google/apis/compute_alpha/classes.rb', line 4045

def include_host
  @include_host
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)

# File 'generated/google/apis/compute_alpha/classes.rb', line 4051

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)

# File 'generated/google/apis/compute_alpha/classes.rb', line 4060

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>)

# File 'generated/google/apis/compute_alpha/classes.rb', line 4069

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>)

# File 'generated/google/apis/compute_alpha/classes.rb', line 4077

def query_string_whitelist
  @query_string_whitelist
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/compute_alpha/classes.rb', line 4084

def update!(**args)
  @include_host = args[:include_host] if args.key?(:include_host)
  @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