Class InstanceGroupManagersClient (2.23.0-rc)

Service for the instanceGroupManagers resource.

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

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

InstanceGroupManagersClient(InstanceGroupManagersClient const &)

Copy and move support

Parameter
NameDescription
InstanceGroupManagersClient const &

InstanceGroupManagersClient(InstanceGroupManagersClient &&)

Copy and move support

Parameter
NameDescription
InstanceGroupManagersClient &&

InstanceGroupManagersClient(std::shared_ptr< InstanceGroupManagersConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< InstanceGroupManagersConnection >
opts Options

Operators

operator=(InstanceGroupManagersClient const &)

Copy and move support

Parameter
NameDescription
InstanceGroupManagersClient const &
Returns
TypeDescription
InstanceGroupManagersClient &

operator=(InstanceGroupManagersClient &&)

Copy and move support

Parameter
NameDescription
InstanceGroupManagersClient &&
Returns
TypeDescription
InstanceGroupManagersClient &

Functions

AbandonInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersAbandonInstancesRequest const &, Options)

Flags the specified instances to be removed from the managed instance group.

Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/abandonInstances

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

instance_group_managers_abandon_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersAbandonInstancesRequest const &

The InstanceGroupManagersAbandonInstancesRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

AbandonInstances(google::cloud::cpp::compute::instance_group_managers::v1::AbandonInstancesRequest const &, Options)

Flags the specified instances to be removed from the managed instance group.

Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/abandonInstances

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::AbandonInstancesRequest 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.instance_group_managers.v1.AbandonInstancesRequest. 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
TypeDescription
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.

AggregatedListInstanceGroupManagers(std::string const &, Options)

Retrieves the list of managed instance groups and groups them by zone.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/aggregatedList

Parameters
NameDescription
project std::string const &

Project ID for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::InstanceGroupManagersScopedList > >

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

AggregatedListInstanceGroupManagers(google::cloud::cpp::compute::instance_group_managers::v1::AggregatedListInstanceGroupManagersRequest, Options)

Retrieves the list of managed instance groups and groups them by zone.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/aggregatedList

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::AggregatedListInstanceGroupManagersRequest

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.instance_group_managers.v1.AggregatedListInstanceGroupManagersRequest. 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
TypeDescription
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::InstanceGroupManagersScopedList > >

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

ApplyUpdatesToInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersApplyUpdatesRequest const &, Options)

Applies changes to selected instances on the managed instance group.

This method can be used to apply new overrides and/or new versions. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/applyUpdatesToInstances

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. Should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group, should conform to RFC1035.

instance_group_managers_apply_updates_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersApplyUpdatesRequest const &

The InstanceGroupManagersApplyUpdatesRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

ApplyUpdatesToInstances(google::cloud::cpp::compute::instance_group_managers::v1::ApplyUpdatesToInstancesRequest const &, Options)

Applies changes to selected instances on the managed instance group.

This method can be used to apply new overrides and/or new versions. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/applyUpdatesToInstances

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::ApplyUpdatesToInstancesRequest 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.instance_group_managers.v1.ApplyUpdatesToInstancesRequest. 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
TypeDescription
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.

CreateInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersCreateInstancesRequest const &, Options)

Creates instances with per-instance configurations in this managed instance group.

Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/createInstances

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. It should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. It should conform to RFC1035.

instance_group_managers_create_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersCreateInstancesRequest const &

The InstanceGroupManagersCreateInstancesRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

CreateInstances(google::cloud::cpp::compute::instance_group_managers::v1::CreateInstancesRequest const &, Options)

Creates instances with per-instance configurations in this managed instance group.

Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/createInstances

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::CreateInstancesRequest 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.instance_group_managers.v1.CreateInstancesRequest. 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
TypeDescription
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.

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

Deletes the specified managed instance group and all of the instances in that group.

Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/delete

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

DeleteInstanceGroupManager(google::cloud::cpp::compute::instance_group_managers::v1::DeleteInstanceGroupManagerRequest const &, Options)

Deletes the specified managed instance group and all of the instances in that group.

Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/delete

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::DeleteInstanceGroupManagerRequest 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.instance_group_managers.v1.DeleteInstanceGroupManagerRequest. 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
TypeDescription
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.

DeleteInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersDeleteInstancesRequest const &, Options)

Flags the specified instances in the managed instance group for immediate deletion.

The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/deleteInstances

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

instance_group_managers_delete_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersDeleteInstancesRequest const &

The InstanceGroupManagersDeleteInstancesRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

DeleteInstances(google::cloud::cpp::compute::instance_group_managers::v1::DeleteInstancesRequest const &, Options)

Flags the specified instances in the managed instance group for immediate deletion.

The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/deleteInstances

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::DeleteInstancesRequest 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.instance_group_managers.v1.DeleteInstancesRequest. 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
TypeDescription
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.

DeletePerInstanceConfigs(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersDeletePerInstanceConfigsReq const &, Options)

Deletes selected per-instance configurations for the managed instance group.

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. It should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. It should conform to RFC1035.

instance_group_managers_delete_per_instance_configs_req_resource google::cloud::cpp::compute::v1::InstanceGroupManagersDeletePerInstanceConfigsReq const &

The InstanceGroupManagersDeletePerInstanceConfigsReq for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

DeletePerInstanceConfigs(google::cloud::cpp::compute::instance_group_managers::v1::DeletePerInstanceConfigsRequest const &, Options)

Deletes selected per-instance configurations for the managed instance group.

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::DeletePerInstanceConfigsRequest 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.instance_group_managers.v1.DeletePerInstanceConfigsRequest. 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
TypeDescription
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.

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

Returns all of the details about the specified managed instance group.

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::InstanceGroupManager >

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

GetInstanceGroupManager(google::cloud::cpp::compute::instance_group_managers::v1::GetInstanceGroupManagerRequest const &, Options)

Returns all of the details about the specified managed instance group.

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::GetInstanceGroupManagerRequest 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.instance_group_managers.v1.GetInstanceGroupManagerRequest. 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
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::InstanceGroupManager >

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

InsertInstanceGroupManager(std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManager const &, Options)

Creates a managed instance group using the information that you specify in the request.

After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/insert

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where you want to create the managed instance group.

instance_group_manager_resource google::cloud::cpp::compute::v1::InstanceGroupManager const &

The InstanceGroupManager for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

InsertInstanceGroupManager(google::cloud::cpp::compute::instance_group_managers::v1::InsertInstanceGroupManagerRequest const &, Options)

Creates a managed instance group using the information that you specify in the request.

After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/insert

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::InsertInstanceGroupManagerRequest 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.instance_group_managers.v1.InsertInstanceGroupManagerRequest. 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
TypeDescription
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.

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

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::InstanceGroupManager >

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

ListInstanceGroupManagers(google::cloud::cpp::compute::instance_group_managers::v1::ListInstanceGroupManagersRequest, Options)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::ListInstanceGroupManagersRequest

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.instance_group_managers.v1.ListInstanceGroupManagersRequest. 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
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::InstanceGroupManager >

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

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

Lists all errors thrown by actions on instances for a given managed instance group.

The filter and orderBy query parameters are not supported. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/listErrors

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. It should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:a-z?)|1-9{0,19}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::InstanceManagedByIgmError >

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

ListErrors(google::cloud::cpp::compute::instance_group_managers::v1::ListErrorsRequest, Options)

Lists all errors thrown by actions on instances for a given managed instance group.

The filter and orderBy query parameters are not supported. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/listErrors

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::ListErrorsRequest

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.instance_group_managers.v1.ListErrorsRequest. 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
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::InstanceManagedByIgmError >

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

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

Lists all of the instances in the managed instance group.

Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The pageToken query parameter is supported only if the group's listManagedInstancesResults field is set to PAGINATED. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/listManagedInstances

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::InstanceGroupManagersListManagedInstancesResponse >

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

ListManagedInstances(google::cloud::cpp::compute::instance_group_managers::v1::ListManagedInstancesRequest const &, Options)

Lists all of the instances in the managed instance group.

Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The pageToken query parameter is supported only if the group's listManagedInstancesResults field is set to PAGINATED. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/listManagedInstances

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::ListManagedInstancesRequest 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.instance_group_managers.v1.ListManagedInstancesRequest. 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
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::InstanceGroupManagersListManagedInstancesResponse >

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

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

Lists all of the per-instance configurations defined for the managed instance group.

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. It should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. It should conform to RFC1035.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::PerInstanceConfig >

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

ListPerInstanceConfigs(google::cloud::cpp::compute::instance_group_managers::v1::ListPerInstanceConfigsRequest, Options)

Lists all of the per-instance configurations defined for the managed instance group.

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::ListPerInstanceConfigsRequest

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.instance_group_managers.v1.ListPerInstanceConfigsRequest. 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
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::PerInstanceConfig >

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

PatchInstanceGroupManager(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManager const &, Options)

Updates a managed instance group using the information that you specify in the request.

This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/patch

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where you want to create the managed instance group.

instance_group_manager std::string const &

The name of the instance group manager.

instance_group_manager_resource google::cloud::cpp::compute::v1::InstanceGroupManager const &

The InstanceGroupManager for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

PatchInstanceGroupManager(google::cloud::cpp::compute::instance_group_managers::v1::PatchInstanceGroupManagerRequest const &, Options)

Updates a managed instance group using the information that you specify in the request.

This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/patch

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::PatchInstanceGroupManagerRequest 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.instance_group_managers.v1.PatchInstanceGroupManagerRequest. 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
TypeDescription
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.

PatchPerInstanceConfigs(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersPatchPerInstanceConfigsReq const &, Options)

Inserts or patches per-instance configurations for the managed instance group.

perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/patchPerInstanceConfigs

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. It should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. It should conform to RFC1035.

instance_group_managers_patch_per_instance_configs_req_resource google::cloud::cpp::compute::v1::InstanceGroupManagersPatchPerInstanceConfigsReq const &

The InstanceGroupManagersPatchPerInstanceConfigsReq for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

PatchPerInstanceConfigs(google::cloud::cpp::compute::instance_group_managers::v1::PatchPerInstanceConfigsRequest const &, Options)

Inserts or patches per-instance configurations for the managed instance group.

perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/patchPerInstanceConfigs

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::PatchPerInstanceConfigsRequest 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.instance_group_managers.v1.PatchPerInstanceConfigsRequest. 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
TypeDescription
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.

RecreateInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersRecreateInstancesRequest const &, Options)

Flags the specified VM instances in the managed instance group to be immediately recreated.

Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/recreateInstances

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

instance_group_managers_recreate_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersRecreateInstancesRequest const &

The InstanceGroupManagersRecreateInstancesRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

RecreateInstances(google::cloud::cpp::compute::instance_group_managers::v1::RecreateInstancesRequest const &, Options)

Flags the specified VM instances in the managed instance group to be immediately recreated.

Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/recreateInstances

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::RecreateInstancesRequest 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.instance_group_managers.v1.RecreateInstancesRequest. 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
TypeDescription
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.

Resize(std::string const &, std::string const &, std::string const &, std::int32_t, Options)

Resizes the managed instance group.

If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/resize

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

size std::int32_t

The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

Resize(google::cloud::cpp::compute::instance_group_managers::v1::ResizeRequest const &, Options)

Resizes the managed instance group.

If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/resize

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::ResizeRequest 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.instance_group_managers.v1.ResizeRequest. 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
TypeDescription
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.

SetInstanceTemplate(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersSetInstanceTemplateRequest const &, Options)

Specifies the instance template to use when creating new instances in this group.

The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/setInstanceTemplate

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

instance_group_managers_set_instance_template_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersSetInstanceTemplateRequest const &

The InstanceGroupManagersSetInstanceTemplateRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

SetInstanceTemplate(google::cloud::cpp::compute::instance_group_managers::v1::SetInstanceTemplateRequest const &, Options)

Specifies the instance template to use when creating new instances in this group.

The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/setInstanceTemplate

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::SetInstanceTemplateRequest 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.instance_group_managers.v1.SetInstanceTemplateRequest. 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
TypeDescription
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.

SetTargetPools(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersSetTargetPoolsRequest const &, Options)

Modifies the target pools to which all instances in this managed instance group are assigned.

The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/setTargetPools

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located.

instance_group_manager std::string const &

The name of the managed instance group.

instance_group_managers_set_target_pools_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagersSetTargetPoolsRequest const &

The InstanceGroupManagersSetTargetPoolsRequest for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

SetTargetPools(google::cloud::cpp::compute::instance_group_managers::v1::SetTargetPoolsRequest const &, Options)

Modifies the target pools to which all instances in this managed instance group are assigned.

The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/setTargetPools

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::SetTargetPoolsRequest 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.instance_group_managers.v1.SetTargetPoolsRequest. 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
TypeDescription
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.

UpdatePerInstanceConfigs(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagersUpdatePerInstanceConfigsReq const &, Options)

Inserts or updates per-instance configurations for the managed instance group.

perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/updatePerInstanceConfigs

Parameters
NameDescription
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. It should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. It should conform to RFC1035.

instance_group_managers_update_per_instance_configs_req_resource google::cloud::cpp::compute::v1::InstanceGroupManagersUpdatePerInstanceConfigsReq const &

The InstanceGroupManagersUpdatePerInstanceConfigsReq for this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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.

UpdatePerInstanceConfigs(google::cloud::cpp::compute::instance_group_managers::v1::UpdatePerInstanceConfigsRequest const &, Options)

Inserts or updates per-instance configurations for the managed instance group.

perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/updatePerInstanceConfigs

Parameters
NameDescription
request google::cloud::cpp::compute::instance_group_managers::v1::UpdatePerInstanceConfigsRequest 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.instance_group_managers.v1.UpdatePerInstanceConfigsRequest. 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
TypeDescription
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.