compute  v1
Public Member Functions | Static Public Member Functions | List of all members
google_compute_api::UrlMap Class Reference

#include <url_map.h>

Inheritance diagram for google_compute_api::UrlMap:

Public Member Functions

 UrlMap (const Json::Value &storage)
 
 UrlMap (Json::Value *storage)
 
virtual ~UrlMap ()
 
const StringPiece GetTypeName () const
 
bool has_creation_timestamp () const
 
void clear_creation_timestamp ()
 
const StringPiece get_creation_timestamp () const
 
void set_creation_timestamp (const StringPiece &value)
 
bool has_default_service () const
 
void clear_default_service ()
 
const StringPiece get_default_service () const
 
void set_default_service (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_fingerprint () const
 
void clear_fingerprint ()
 
const StringPiece get_fingerprint () const
 
void set_fingerprint (const StringPiece &value)
 
bool has_host_rules () const
 
void clear_host_rules ()
 
const client::JsonCppArray< HostRuleget_host_rules () const
 
client::JsonCppArray< HostRulemutable_hostRules ()
 
bool has_id () const
 
void clear_id ()
 
uint64 get_id () const
 
void set_id (uint64 value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_path_matchers () const
 
void clear_path_matchers ()
 
const client::JsonCppArray< PathMatcherget_path_matchers () const
 
client::JsonCppArray< PathMatchermutable_pathMatchers ()
 
bool has_self_link () const
 
void clear_self_link ()
 
const StringPiece get_self_link () const
 
void set_self_link (const StringPiece &value)
 
bool has_tests () const
 
void clear_tests ()
 
const client::JsonCppArray< UrlMapTestget_tests () const
 
client::JsonCppArray< UrlMapTestmutable_tests ()
 

Static Public Member Functions

static UrlMapNew ()
 

Detailed Description

A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.

Constructor & Destructor Documentation

◆ UrlMap() [1/2]

google_compute_api::UrlMap::UrlMap ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ UrlMap() [2/2]

google_compute_api::UrlMap::UrlMap ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~UrlMap()

google_compute_api::UrlMap::~UrlMap ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_creation_timestamp()

void google_compute_api::UrlMap::clear_creation_timestamp ( )
inline

Clears the 'creationTimestamp' attribute.

◆ clear_default_service()

void google_compute_api::UrlMap::clear_default_service ( )
inline

Clears the 'defaultService' attribute.

◆ clear_description()

void google_compute_api::UrlMap::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_fingerprint()

void google_compute_api::UrlMap::clear_fingerprint ( )
inline

Clears the 'fingerprint' attribute.

◆ clear_host_rules()

void google_compute_api::UrlMap::clear_host_rules ( )
inline

Clears the 'hostRules' attribute.

◆ clear_id()

void google_compute_api::UrlMap::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_compute_api::UrlMap::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_compute_api::UrlMap::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_path_matchers()

void google_compute_api::UrlMap::clear_path_matchers ( )
inline

Clears the 'pathMatchers' attribute.

◆ clear_self_link()

void google_compute_api::UrlMap::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_tests()

void google_compute_api::UrlMap::clear_tests ( )
inline

Clears the 'tests' attribute.

◆ get_creation_timestamp()

const StringPiece google_compute_api::UrlMap::get_creation_timestamp ( ) const
inline

Get the value of the 'creationTimestamp' attribute.

◆ get_default_service()

const StringPiece google_compute_api::UrlMap::get_default_service ( ) const
inline

Get the value of the 'defaultService' attribute.

◆ get_description()

const StringPiece google_compute_api::UrlMap::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_fingerprint()

const StringPiece google_compute_api::UrlMap::get_fingerprint ( ) const
inline

Get the value of the 'fingerprint' attribute.

◆ get_host_rules()

const client::JsonCppArray<HostRule > google_compute_api::UrlMap::get_host_rules ( ) const

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

◆ get_id()

uint64 google_compute_api::UrlMap::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_compute_api::UrlMap::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_compute_api::UrlMap::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_path_matchers()

const client::JsonCppArray<PathMatcher > google_compute_api::UrlMap::get_path_matchers ( ) const

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

◆ get_self_link()

const StringPiece google_compute_api::UrlMap::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_tests()

const client::JsonCppArray<UrlMapTest > google_compute_api::UrlMap::get_tests ( ) const

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

◆ GetTypeName()

const StringPiece google_compute_api::UrlMap::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_compute_api::UrlMap

◆ has_creation_timestamp()

bool google_compute_api::UrlMap::has_creation_timestamp ( ) const
inline

Determine if the 'creationTimestamp' attribute was set.

Returns
true if the 'creationTimestamp' attribute was set.

◆ has_default_service()

bool google_compute_api::UrlMap::has_default_service ( ) const
inline

Determine if the 'defaultService' attribute was set.

Returns
true if the 'defaultService' attribute was set.

◆ has_description()

bool google_compute_api::UrlMap::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_fingerprint()

bool google_compute_api::UrlMap::has_fingerprint ( ) const
inline

Determine if the 'fingerprint' attribute was set.

Returns
true if the 'fingerprint' attribute was set.

◆ has_host_rules()

bool google_compute_api::UrlMap::has_host_rules ( ) const
inline

Determine if the 'hostRules' attribute was set.

Returns
true if the 'hostRules' attribute was set.

◆ has_id()

bool google_compute_api::UrlMap::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_compute_api::UrlMap::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_name()

bool google_compute_api::UrlMap::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_path_matchers()

bool google_compute_api::UrlMap::has_path_matchers ( ) const
inline

Determine if the 'pathMatchers' attribute was set.

Returns
true if the 'pathMatchers' attribute was set.

◆ has_self_link()

bool google_compute_api::UrlMap::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_tests()

bool google_compute_api::UrlMap::has_tests ( ) const
inline

Determine if the 'tests' attribute was set.

Returns
true if the 'tests' attribute was set.

◆ mutable_hostRules()

client::JsonCppArray<HostRule > google_compute_api::UrlMap::mutable_hostRules ( )

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

The list of HostRules to use against the URL.

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

◆ mutable_pathMatchers()

client::JsonCppArray<PathMatcher > google_compute_api::UrlMap::mutable_pathMatchers ( )

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

The list of named PathMatchers to use against the URL.

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

◆ mutable_tests()

client::JsonCppArray<UrlMapTest > google_compute_api::UrlMap::mutable_tests ( )

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

The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

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

◆ New()

UrlMap * google_compute_api::UrlMap::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_creation_timestamp()

void google_compute_api::UrlMap::set_creation_timestamp ( const StringPiece &  value)
inline

Change the 'creationTimestamp' attribute.

[Output Only] Creation timestamp in RFC3339 text format.

Parameters
[in]valueThe new value.

◆ set_default_service()

void google_compute_api::UrlMap::set_default_service ( const StringPiece &  value)
inline

Change the 'defaultService' attribute.

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Parameters
[in]valueThe new value.

◆ set_description()

void google_compute_api::UrlMap::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

An optional description of this resource. Provide this property when you create the resource.

Parameters
[in]valueThe new value.

◆ set_fingerprint()

void google_compute_api::UrlMap::set_fingerprint ( const StringPiece &  value)
inline

Change the 'fingerprint' attribute.

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a UrlMap.

Parameters
[in]valueThe new value.

◆ set_id()

void google_compute_api::UrlMap::set_id ( uint64  value)
inline

Change the 'id' attribute.

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_compute_api::UrlMap::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

[Output Only] Type of the resource. Always compute::urlMaps for url maps.

Parameters
[in]valueThe new value.

◆ set_name()

void google_compute_api::UrlMap::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_compute_api::UrlMap::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

[Output Only] Server-defined URL for the resource.

Parameters
[in]valueThe new value.

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