Service for the urlMaps resource.
https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
UrlMapsClient(UrlMapsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UrlMapsClient const &
|
UrlMapsClient(UrlMapsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UrlMapsClient &&
|
UrlMapsClient(std::shared_ptr< UrlMapsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< UrlMapsConnection >
|
opts |
Options
|
Operators
operator=(UrlMapsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UrlMapsClient const &
|
Returns | |
---|---|
Type | Description |
UrlMapsClient & |
operator=(UrlMapsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
UrlMapsClient &&
|
Returns | |
---|---|
Type | Description |
UrlMapsClient & |
Functions
AggregatedListUrlMaps(std::string const &, Options)
Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Name of the project scoping this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::UrlMapsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListUrlMaps(google::cloud::cpp::compute::url_maps::v1::AggregatedListUrlMapsRequest, Options)
Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::AggregatedListUrlMapsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::UrlMapsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteUrlMap(std::string const &, std::string const &, Options)
Deletes the specified UrlMap resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map |
std::string const &
Name of the UrlMap resource to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteUrlMap(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified UrlMap resource.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
url_map |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteUrlMap(google::cloud::cpp::compute::url_maps::v1::DeleteUrlMapRequest const &, Options)
Deletes the specified UrlMap resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::DeleteUrlMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteUrlMap(NoAwaitTag, google::cloud::cpp::compute::url_maps::v1::DeleteUrlMapRequest const &, Options)
Deletes the specified UrlMap resource.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::url_maps::v1::DeleteUrlMapRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteUrlMap(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified UrlMap resource.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetUrlMap(std::string const &, std::string const &, Options)
Returns the specified UrlMap resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map |
std::string const &
Name of the UrlMap resource to return. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::UrlMap > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.UrlMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetUrlMap(google::cloud::cpp::compute::url_maps::v1::GetUrlMapRequest const &, Options)
Returns the specified UrlMap resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::GetUrlMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::UrlMap > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.UrlMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertUrlMap(std::string const &, google::cloud::cpp::compute::v1::UrlMap const &, Options)
Creates a UrlMap resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map_resource |
google::cloud::cpp::compute::v1::UrlMap const &
The UrlMap for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertUrlMap(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::UrlMap const &, Options)
Creates a UrlMap resource in the specified project using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
url_map_resource |
google::cloud::cpp::compute::v1::UrlMap const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertUrlMap(google::cloud::cpp::compute::url_maps::v1::InsertUrlMapRequest const &, Options)
Creates a UrlMap resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::InsertUrlMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertUrlMap(NoAwaitTag, google::cloud::cpp::compute::url_maps::v1::InsertUrlMapRequest const &, Options)
Creates a UrlMap resource in the specified project using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::url_maps::v1::InsertUrlMapRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertUrlMap(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a UrlMap resource in the specified project using the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
InvalidateCache(std::string const &, std::string const &, google::cloud::cpp::compute::v1::CacheInvalidationRule const &, Options)
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
For more information, see Invalidating cached content. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/invalidateCache
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map |
std::string const &
Name of the UrlMap scoping this request. |
cache_invalidation_rule_resource |
google::cloud::cpp::compute::v1::CacheInvalidationRule const &
The CacheInvalidationRule for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InvalidateCache(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::CacheInvalidationRule const &, Options)
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
url_map |
std::string const &
|
cache_invalidation_rule_resource |
google::cloud::cpp::compute::v1::CacheInvalidationRule const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InvalidateCache(google::cloud::cpp::compute::url_maps::v1::InvalidateCacheRequest const &, Options)
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
For more information, see Invalidating cached content. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/invalidateCache
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::InvalidateCacheRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InvalidateCache(NoAwaitTag, google::cloud::cpp::compute::url_maps::v1::InvalidateCacheRequest const &, Options)
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::url_maps::v1::InvalidateCacheRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InvalidateCache(google::cloud::cpp::compute::v1::Operation const &, Options)
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListUrlMaps(std::string const &, Options)
Retrieves the list of UrlMap resources available to the specified project.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::UrlMap > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUrlMaps(google::cloud::cpp::compute::url_maps::v1::ListUrlMapsRequest, Options)
Retrieves the list of UrlMap resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::ListUrlMapsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::UrlMap > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchUrlMap(std::string const &, std::string const &, google::cloud::cpp::compute::v1::UrlMap const &, Options)
Patches the specified UrlMap resource with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map |
std::string const &
Name of the UrlMap resource to patch. |
url_map_resource |
google::cloud::cpp::compute::v1::UrlMap const &
The UrlMap for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
PatchUrlMap(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::UrlMap const &, Options)
Patches the specified UrlMap resource with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
url_map |
std::string const &
|
url_map_resource |
google::cloud::cpp::compute::v1::UrlMap const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchUrlMap(google::cloud::cpp::compute::url_maps::v1::PatchUrlMapRequest const &, Options)
Patches the specified UrlMap resource with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::PatchUrlMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
PatchUrlMap(NoAwaitTag, google::cloud::cpp::compute::url_maps::v1::PatchUrlMapRequest const &, Options)
Patches the specified UrlMap resource with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::url_maps::v1::PatchUrlMapRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchUrlMap(google::cloud::cpp::compute::v1::Operation const &, Options)
Patches the specified UrlMap resource with the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
UpdateUrlMap(std::string const &, std::string const &, google::cloud::cpp::compute::v1::UrlMap const &, Options)
Updates the specified UrlMap resource with the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map |
std::string const &
Name of the UrlMap resource to update. |
url_map_resource |
google::cloud::cpp::compute::v1::UrlMap const &
The UrlMap for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
UpdateUrlMap(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::UrlMap const &, Options)
Updates the specified UrlMap resource with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
url_map |
std::string const &
|
url_map_resource |
google::cloud::cpp::compute::v1::UrlMap const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateUrlMap(google::cloud::cpp::compute::url_maps::v1::UpdateUrlMapRequest const &, Options)
Updates the specified UrlMap resource with the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::UpdateUrlMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
UpdateUrlMap(NoAwaitTag, google::cloud::cpp::compute::url_maps::v1::UpdateUrlMapRequest const &, Options)
Updates the specified UrlMap resource with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::url_maps::v1::UpdateUrlMapRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateUrlMap(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified UrlMap resource with the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
Validate(std::string const &, std::string const &, google::cloud::cpp::compute::v1::UrlMapsValidateRequest const &, Options)
Runs static validation for the UrlMap.
In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/validate
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
url_map |
std::string const &
Name of the UrlMap resource to be validated as. |
url_maps_validate_request_resource |
google::cloud::cpp::compute::v1::UrlMapsValidateRequest const &
The UrlMapsValidateRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::UrlMapsValidateResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.UrlMapsValidateResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
Validate(google::cloud::cpp::compute::url_maps::v1::ValidateRequest const &, Options)
Runs static validation for the UrlMap.
In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps/validate
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::url_maps::v1::ValidateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::UrlMapsValidateResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.UrlMapsValidateResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |