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.
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 |
AggregatedListRouters(google::cloud::cpp::compute::routers::v1::AggregatedListRoutersRequest, Options)
Retrieves an aggregated list of routers.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::routers::v1::AggregatedListRoutersRequest
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::RoutersScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteRouter(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified Router resource.
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 |
DeleteRouter(google::cloud::cpp::compute::routers::v1::DeleteRouterRequest const &, Options)
Deletes the specified Router resource.
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 |
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 |
GetRouter(std::string const &, std::string const &, std::string const &, Options)
Returns the specified Router resource.
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 |
GetRouter(google::cloud::cpp::compute::routers::v1::GetRouterRequest const &, Options)
Returns the specified Router resource.
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 |
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 |
GetNatIpInfo(std::string const &, std::string const &, std::string const &, Options)
Retrieves runtime NAT IP information.
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 |
GetNatIpInfo(google::cloud::cpp::compute::routers::v1::GetNatIpInfoRequest const &, Options)
Retrieves runtime NAT IP information.
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 |
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 |
GetNatMappingInfo(std::string const &, std::string const &, std::string const &, Options)
Retrieves runtime Nat mapping information of VM endpoints.
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 |
GetNatMappingInfo(google::cloud::cpp::compute::routers::v1::GetNatMappingInfoRequest const &, Options)
Retrieves runtime Nat mapping information of VM endpoints.
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 |
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 |
GetRouterStatus(std::string const &, std::string const &, std::string const &, Options)
Retrieves runtime information of the specified router.
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 |
GetRouterStatus(google::cloud::cpp::compute::routers::v1::GetRouterStatusRequest const &, Options)
Retrieves runtime information of the specified router.
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 |
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 |
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.
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 |
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.
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 |
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 |
ListRouters(std::string const &, std::string const &, Options)
Retrieves a list of Router resources available to the specified project.
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 |
ListRouters(google::cloud::cpp::compute::routers::v1::ListRoutersRequest, Options)
Retrieves a list of Router resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::routers::v1::ListRoutersRequest
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::Router > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |