Class RoutersClient (2.17.0)

Version 2.17.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 routers resource.

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

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

RoutersClient(RoutersClient const &)

Copy and move support

Parameter
Name	Description
	RoutersClient const &

RoutersClient(RoutersClient &&)

Copy and move support

Parameter
Name	Description
	RoutersClient &&

RoutersClient(std::shared_ptr< RoutersConnection >, Options)

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

Operators

operator=(RoutersClient const &)

Copy and move support

Parameter
Name	Description
	RoutersClient const &

Returns
Type	Description
RoutersClient &

operator=(RoutersClient &&)

Copy and move support

Parameter
Name	Description
	RoutersClient &&

Returns
Type	Description
RoutersClient &

Functions

AggregatedListRouters(std::string const &, Options)

Retrieves an aggregated list of routers.

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

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< std::pair< std::string, google::cloud::cpp::compute::v1::RoutersScopedList > >	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.RoutersScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AggregatedListRouters(google::cloud::cpp::compute::routers::v1::AggregatedListRoutersRequest, Options)

Retrieves an aggregated list of routers.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::AggregatedListRoutersRequest 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.routers.v1.AggregatedListRoutersRequest. 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< std::pair< std::string, google::cloud::cpp::compute::v1::RoutersScopedList > >	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.RoutersScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Deletes the specified Router resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router 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.

DeleteRouter(google::cloud::cpp::compute::routers::v1::DeleteRouterRequest const &, Options)

Deletes the specified Router resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::DeleteRouterRequest 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.routers.v1.DeleteRouterRequest. 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.

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

Returns the specified Router resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router 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::Router >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Router) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRouter(google::cloud::cpp::compute::routers::v1::GetRouterRequest const &, Options)

Returns the specified Router resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::GetRouterRequest 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.routers.v1.GetRouterRequest. 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::Router >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Router) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Retrieves runtime NAT IP information.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::NatIpInfoResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NatIpInfoResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNatIpInfo(google::cloud::cpp::compute::routers::v1::GetNatIpInfoRequest const &, Options)

Retrieves runtime NAT IP information.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::GetNatIpInfoRequest 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.routers.v1.GetNatIpInfoRequest. 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::NatIpInfoResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NatIpInfoResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Retrieves runtime Nat mapping information of VM endpoints.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router resource to query for Nat Mapping information of VM endpoints.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::VmEndpointNatMappingsList >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VmEndpointNatMappingsList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNatMappingInfo(google::cloud::cpp::compute::routers::v1::GetNatMappingInfoRequest const &, Options)

Retrieves runtime Nat mapping information of VM endpoints.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::GetNatMappingInfoRequest 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.routers.v1.GetNatMappingInfoRequest. 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::VmEndpointNatMappingsList >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.VmEndpointNatMappingsList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Retrieves runtime information of the specified router.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router resource to query.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::RouterStatusResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.RouterStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRouterStatus(google::cloud::cpp::compute::routers::v1::GetRouterStatusRequest const &, Options)

Retrieves runtime information of the specified router.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::GetRouterStatusRequest 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.routers.v1.GetRouterStatusRequest. 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::RouterStatusResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.RouterStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertRouter(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Router const &, Options)

Creates a Router resource in the specified project and region using the data included in the request.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router_resource	google::cloud::cpp::compute::v1::Router const & The Router 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.

InsertRouter(google::cloud::cpp::compute::routers::v1::InsertRouterRequest const &, Options)

Creates a Router resource in the specified project and region using the data included in the request.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::InsertRouterRequest 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.routers.v1.InsertRouterRequest. 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.

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

Retrieves a list of Router resources available to the specified project.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region 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::Router >	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.Router, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRouters(google::cloud::cpp::compute::routers::v1::ListRoutersRequest, Options)

Retrieves a list of Router resources available to the specified project.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::ListRoutersRequest 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.routers.v1.ListRoutersRequest. 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::Router >	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.Router, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

PatchRouter(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Router const &, Options)

Patches the specified Router 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/routers/patch

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router resource to patch.
router_resource	google::cloud::cpp::compute::v1::Router const & The Router 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.

PatchRouter(google::cloud::cpp::compute::routers::v1::PatchRouterRequest const &, Options)

Patches the specified Router 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/routers/patch

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::PatchRouterRequest 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.routers.v1.PatchRouterRequest. 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.

Preview(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Router const &, Options)

Preview fields auto-generated during router create and update operations.

Calling this method does NOT create or update the router. https://cloud.google.com/compute/docs/reference/rest/v1/routers/preview

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router resource to query.
router_resource	google::cloud::cpp::compute::v1::Router const & The Router 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::RoutersPreviewResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.RoutersPreviewResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Preview(google::cloud::cpp::compute::routers::v1::PreviewRequest const &, Options)

Preview fields auto-generated during router create and update operations.

Calling this method does NOT create or update the router. https://cloud.google.com/compute/docs/reference/rest/v1/routers/preview

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::PreviewRequest 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.routers.v1.PreviewRequest. 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::RoutersPreviewResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.RoutersPreviewResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRouter(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Router const &, Options)

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

This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. https://cloud.google.com/compute/docs/reference/rest/v1/routers/update

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
router	std::string const & Name of the Router resource to update.
router_resource	google::cloud::cpp::compute::v1::Router const & The Router 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.

UpdateRouter(google::cloud::cpp::compute::routers::v1::UpdateRouterRequest const &, Options)

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

This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. https://cloud.google.com/compute/docs/reference/rest/v1/routers/update

Parameters
Name	Description
request	google::cloud::cpp::compute::routers::v1::UpdateRouterRequest 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.routers.v1.UpdateRouterRequest. 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.