#include <cache_key_policy.h>

Inheritance diagram for google_compute_api::CacheKeyPolicy:

Public Member Functions
	CacheKeyPolicy (const Json::Value &storage)

	CacheKeyPolicy (Json::Value *storage)

virtual	~CacheKeyPolicy ()

const StringPiece	GetTypeName () const

bool	has_include_host () const

void	clear_include_host ()

bool	get_include_host () const

void	set_include_host (bool value)

bool	has_include_protocol () const

void	clear_include_protocol ()

bool	get_include_protocol () const

void	set_include_protocol (bool value)

bool	has_include_query_string () const

void	clear_include_query_string ()

bool	get_include_query_string () const

void	set_include_query_string (bool value)

bool	has_query_string_blacklist () const

void	clear_query_string_blacklist ()

const client::JsonCppArray< string >	get_query_string_blacklist () const

client::JsonCppArray< string >	mutable_queryStringBlacklist ()

bool	has_query_string_whitelist () const

void	clear_query_string_whitelist ()

const client::JsonCppArray< string >	get_query_string_whitelist () const

client::JsonCppArray< string >	mutable_queryStringWhitelist ()

Static Public Member Functions
static CacheKeyPolicy *	New ()

Detailed Description

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

Constructor & Destructor Documentation

◆ CacheKeyPolicy() [1/2]

google_compute_api::CacheKeyPolicy::CacheKeyPolicy ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ CacheKeyPolicy() [2/2]

google_compute_api::CacheKeyPolicy::CacheKeyPolicy ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~CacheKeyPolicy()

google_compute_api::CacheKeyPolicy::~CacheKeyPolicy ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_include_host()

void google_compute_api::CacheKeyPolicy::clear_include_host ( )

inline

Clears the 'includeHost' attribute.

◆ clear_include_protocol()

void google_compute_api::CacheKeyPolicy::clear_include_protocol ( )

inline

Clears the 'includeProtocol' attribute.

◆ clear_include_query_string()

void google_compute_api::CacheKeyPolicy::clear_include_query_string ( )

inline

Clears the 'includeQueryString' attribute.

◆ clear_query_string_blacklist()

void google_compute_api::CacheKeyPolicy::clear_query_string_blacklist ( )

inline

Clears the 'queryStringBlacklist' attribute.

◆ clear_query_string_whitelist()

void google_compute_api::CacheKeyPolicy::clear_query_string_whitelist ( )

inline

Clears the 'queryStringWhitelist' attribute.

◆ get_include_host()

bool google_compute_api::CacheKeyPolicy::get_include_host ( ) const

inline

Get the value of the 'includeHost' attribute.

◆ get_include_protocol()

bool google_compute_api::CacheKeyPolicy::get_include_protocol ( ) const

inline

Get the value of the 'includeProtocol' attribute.

◆ get_include_query_string()

bool google_compute_api::CacheKeyPolicy::get_include_query_string ( ) const

inline

Get the value of the 'includeQueryString' attribute.

◆ get_query_string_blacklist()

const client::JsonCppArray<string > google_compute_api::CacheKeyPolicy::get_query_string_blacklist ( ) const

inline

Get a reference to the value of the 'queryStringBlacklist' attribute.

◆ get_query_string_whitelist()

const client::JsonCppArray<string > google_compute_api::CacheKeyPolicy::get_query_string_whitelist ( ) const

inline

Get a reference to the value of the 'queryStringWhitelist' attribute.

◆ GetTypeName()

const StringPiece google_compute_api::CacheKeyPolicy::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_compute_api::CacheKeyPolicy

◆ has_include_host()

bool google_compute_api::CacheKeyPolicy::has_include_host ( ) const

inline

Determine if the 'includeHost' attribute was set.

Returns: true if the 'includeHost' attribute was set.

◆ has_include_protocol()

bool google_compute_api::CacheKeyPolicy::has_include_protocol ( ) const

inline

Determine if the 'includeProtocol' attribute was set.

Returns: true if the 'includeProtocol' attribute was set.

◆ has_include_query_string()

bool google_compute_api::CacheKeyPolicy::has_include_query_string ( ) const

inline

Determine if the 'includeQueryString' attribute was set.

Returns: true if the 'includeQueryString' attribute was set.

◆ has_query_string_blacklist()

bool google_compute_api::CacheKeyPolicy::has_query_string_blacklist ( ) const

inline

Determine if the 'queryStringBlacklist' attribute was set.

Returns: true if the 'queryStringBlacklist' attribute was set.

◆ has_query_string_whitelist()

bool google_compute_api::CacheKeyPolicy::has_query_string_whitelist ( ) const

inline

Determine if the 'queryStringWhitelist' attribute was set.

Returns: true if the 'queryStringWhitelist' attribute was set.

◆ mutable_queryStringBlacklist()

client::JsonCppArray<string > google_compute_api::CacheKeyPolicy::mutable_queryStringBlacklist ( )

inline

Gets a reference to a mutable value of the 'queryStringBlacklist' property.

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.

Returns: The result can be modified to change the attribute value.

◆ mutable_queryStringWhitelist()

client::JsonCppArray<string > google_compute_api::CacheKeyPolicy::mutable_queryStringWhitelist ( )

inline

Gets a reference to a mutable value of the 'queryStringWhitelist' property.

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.

Returns: The result can be modified to change the attribute value.

◆ New()

CacheKeyPolicy * google_compute_api::CacheKeyPolicy::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_include_host()

void google_compute_api::CacheKeyPolicy::set_include_host ( bool value )

inline

Change the 'includeHost' attribute.

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

Parameters

[in] value The new value.

◆ set_include_protocol()

void google_compute_api::CacheKeyPolicy::set_include_protocol ( bool value )

inline

Change the 'includeProtocol' attribute.

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

Parameters

[in] value The new value.

◆ set_include_query_string()

void google_compute_api::CacheKeyPolicy::set_include_query_string ( bool value )

inline

Change the 'includeQueryString' attribute.

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.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/compute_api/cache_key_policy.h
google/compute_api/cache_key_policy.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CacheKeyPolicy() [1/2]

◆ CacheKeyPolicy() [2/2]

◆ ~CacheKeyPolicy()

Member Function Documentation

◆ clear_include_host()

◆ clear_include_protocol()

◆ clear_include_query_string()

◆ clear_query_string_blacklist()

◆ clear_query_string_whitelist()

◆ get_include_host()

◆ get_include_protocol()

◆ get_include_query_string()

◆ get_query_string_blacklist()

◆ get_query_string_whitelist()

◆ GetTypeName()

◆ has_include_host()

◆ has_include_protocol()

◆ has_include_query_string()

◆ has_query_string_blacklist()

◆ has_query_string_whitelist()

◆ mutable_queryStringBlacklist()

◆ mutable_queryStringWhitelist()

◆ New()

◆ set_include_host()

◆ set_include_protocol()

◆ set_include_query_string()