Class RegionInstancesClient (2.17.0)

Service for the regionInstances resource.

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

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

RegionInstancesClient(RegionInstancesClient const &)

Copy and move support

Parameter
Name Description
RegionInstancesClient const &

RegionInstancesClient(RegionInstancesClient &&)

Copy and move support

Parameter
Name Description
RegionInstancesClient &&

RegionInstancesClient(std::shared_ptr< RegionInstancesConnection >, Options)

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

Operators

operator=(RegionInstancesClient const &)

Copy and move support

Parameter
Name Description
RegionInstancesClient const &
Returns
Type Description
RegionInstancesClient &

operator=(RegionInstancesClient &&)

Copy and move support

Parameter
Name Description
RegionInstancesClient &&
Returns
Type Description
RegionInstancesClient &

Functions

BulkInsert(std::string const &, std::string const &, google::cloud::cpp::compute::v1::BulkInsertInstanceResource const &, Options)

Creates multiple instances in a given region.

Count specifies the number of instances to create. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstances/bulkInsert

Parameters
Name Description
project std::string const &

Project ID for this request.

region std::string const &

The name of the region for this request.

bulk_insert_instance_resource google::cloud::cpp::compute::v1::BulkInsertInstanceResource const &

The BulkInsertInstanceResource 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.

BulkInsert(google::cloud::cpp::compute::region_instances::v1::BulkInsertRequest const &, Options)

Creates multiple instances in a given region.

Count specifies the number of instances to create. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstances/bulkInsert

Parameters
Name Description
request google::cloud::cpp::compute::region_instances::v1::BulkInsertRequest 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_instances.v1.BulkInsertRequest. 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.