Class RoutesClient (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 routes resource.

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

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

RoutesClient(RoutesClient const &)

Copy and move support

Parameter
Name	Description
	RoutesClient const &

RoutesClient(RoutesClient &&)

Copy and move support

Parameter
Name	Description
	RoutesClient &&

RoutesClient(std::shared_ptr< RoutesConnection >, Options)

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

Operators

operator=(RoutesClient const &)

Copy and move support

Parameter
Name	Description
	RoutesClient const &

Returns
Type	Description
RoutesClient &

operator=(RoutesClient &&)

Copy and move support

Parameter
Name	Description
	RoutesClient &&

Returns
Type	Description
RoutesClient &

Functions

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

Deletes the specified Route resource.

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

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

DeleteRoute(google::cloud::cpp::compute::routes::v1::DeleteRouteRequest const &, Options)

Deletes the specified Route resource.

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

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

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

Returns the specified Route resource.

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

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

GetRoute(google::cloud::cpp::compute::routes::v1::GetRouteRequest const &, Options)

Returns the specified Route resource.

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

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

InsertRoute(std::string const &, google::cloud::cpp::compute::v1::Route const &, Options)

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

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

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

InsertRoute(google::cloud::cpp::compute::routes::v1::InsertRouteRequest const &, Options)

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

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

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

ListRoutes(std::string const &, Options)

Retrieves the list of Route resources available to the specified project.

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

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::Route >	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.Route, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRoutes(google::cloud::cpp::compute::routes::v1::ListRoutesRequest, Options)

Retrieves the list of Route resources available to the specified project.

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

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