Class RegionUrlMapsClient (2.18.0)

Version 2.18.0

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

Service for the regionUrlMaps resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps

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

RegionUrlMapsClient(RegionUrlMapsClient const &)

Copy and move support

Parameter
Name	Description
	RegionUrlMapsClient const &

RegionUrlMapsClient(RegionUrlMapsClient &&)

Copy and move support

Parameter
Name	Description
	RegionUrlMapsClient &&

RegionUrlMapsClient(std::shared_ptr< RegionUrlMapsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< RegionUrlMapsConnection >
opts	Options

Operators

operator=(RegionUrlMapsClient const &)

Copy and move support

Parameter
Name	Description
	RegionUrlMapsClient const &

Returns
Type	Description
RegionUrlMapsClient &

operator=(RegionUrlMapsClient &&)

Copy and move support

Parameter
Name	Description
	RegionUrlMapsClient &&

Returns
Type	Description
RegionUrlMapsClient &

Functions

DeleteUrlMap(std::string const &, std::string const &, std::string const &, Options)

Deletes the specified UrlMap resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/delete

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping 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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteUrlMap(google::cloud::cpp::compute::region_url_maps::v1::DeleteUrlMapRequest const &, Options)

Deletes the specified UrlMap resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/delete

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::DeleteUrlMapRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.DeleteUrlMapRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetUrlMap(std::string const &, std::string const &, std::string const &, Options)

Returns the specified UrlMap resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/get

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping 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 StatusOr contains the error details.

GetUrlMap(google::cloud::cpp::compute::region_url_maps::v1::GetUrlMapRequest const &, Options)

Returns the specified UrlMap resource.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/get

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::GetUrlMapRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.GetUrlMapRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

InsertUrlMap(std::string const &, 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.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/insert

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping 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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InsertUrlMap(google::cloud::cpp::compute::region_url_maps::v1::InsertUrlMapRequest const &, Options)

Creates a UrlMap resource in the specified project using the data included in the request.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/insert

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::InsertUrlMapRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.InsertUrlMapRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListRegionUrlMaps(std::string const &, std::string const &, Options)

Retrieves the list of UrlMap resources available to the specified project in the specified region.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/list

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping 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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.UrlMap, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRegionUrlMaps(google::cloud::cpp::compute::region_url_maps::v1::ListRegionUrlMapsRequest, Options)

Retrieves the list of UrlMap resources available to the specified project in the specified region.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/list

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::ListRegionUrlMapsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.ListRegionUrlMapsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.UrlMap, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

PatchUrlMap(std::string const &, 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 JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/patch

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping 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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PatchUrlMap(google::cloud::cpp::compute::region_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 JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/patch

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::PatchUrlMapRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.PatchUrlMapRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateUrlMap(std::string const &, 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.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/update

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping 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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateUrlMap(google::cloud::cpp::compute::region_url_maps::v1::UpdateUrlMapRequest const &, Options)

Updates the specified UrlMap resource with the data included in the request.

https://cloud.google.com/compute/docs/reference/rest/v1/regionUrlMaps/update

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::UpdateUrlMapRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.UpdateUrlMapRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

Validate(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionUrlMapsValidateRequest 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/regionUrlMaps/validate

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping this request.
url_map	std::string const & Name of the UrlMap resource to be validated as.
region_url_maps_validate_request_resource	google::cloud::cpp::compute::v1::RegionUrlMapsValidateRequest const & The RegionUrlMapsValidateRequest 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 StatusOr contains the error details.

Validate(google::cloud::cpp::compute::region_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/regionUrlMaps/validate

Parameters
Name	Description
request	google::cloud::cpp::compute::region_url_maps::v1::ValidateRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_url_maps.v1.ValidateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.