Class InstanceGroupsClient (2.17.0)

Service for the instanceGroups resource.

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

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

InstanceGroupsClient(InstanceGroupsClient const &)

Copy and move support

Parameter
Name Description
InstanceGroupsClient const &

InstanceGroupsClient(InstanceGroupsClient &&)

Copy and move support

Parameter
Name Description
InstanceGroupsClient &&

InstanceGroupsClient(std::shared_ptr< InstanceGroupsConnection >, Options)

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

Operators

operator=(InstanceGroupsClient const &)

Copy and move support

Parameter
Name Description
InstanceGroupsClient const &
Returns
Type Description
InstanceGroupsClient &

operator=(InstanceGroupsClient &&)

Copy and move support

Parameter
Name Description
InstanceGroupsClient &&
Returns
Type Description
InstanceGroupsClient &

Functions

AddInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupsAddInstancesRequest const &, Options)

Adds a list of instances to the specified instance group.

All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/addInstances

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group std::string const &

The name of the instance group where you are adding instances.

instance_groups_add_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupsAddInstancesRequest const &

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

AddInstances(google::cloud::cpp::compute::instance_groups::v1::AddInstancesRequest const &, Options)

Adds a list of instances to the specified instance group.

All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/addInstances

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::AddInstancesRequest 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_groups.v1.AddInstancesRequest. 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.

AggregatedListInstanceGroups(std::string const &, Options)

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

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::InstanceGroupsScopedList > >

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

AggregatedListInstanceGroups(google::cloud::cpp::compute::instance_groups::v1::AggregatedListInstanceGroupsRequest, Options)

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

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::AggregatedListInstanceGroupsRequest

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_groups.v1.AggregatedListInstanceGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::InstanceGroupsScopedList > >

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

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

Deletes the specified instance group.

The instances in the group are not deleted. Note that 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/instanceGroups/delete

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group std::string const &

The name of the instance group 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.

DeleteInstanceGroup(google::cloud::cpp::compute::instance_groups::v1::DeleteInstanceGroupRequest const &, Options)

Deletes the specified instance group.

The instances in the group are not deleted. Note that 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/instanceGroups/delete

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::DeleteInstanceGroupRequest 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_groups.v1.DeleteInstanceGroupRequest. 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.

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

Returns the specified zonal instance group.

Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/get

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group std::string const &

The name of the instance group.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::InstanceGroup >

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

GetInstanceGroup(google::cloud::cpp::compute::instance_groups::v1::GetInstanceGroupRequest const &, Options)

Returns the specified zonal instance group.

Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/get

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::GetInstanceGroupRequest 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_groups.v1.GetInstanceGroupRequest. 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::InstanceGroup >

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

InsertInstanceGroup(std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroup const &, Options)

Creates an instance group in the specified project using the parameters that are included in the request.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group_resource google::cloud::cpp::compute::v1::InstanceGroup const &

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

InsertInstanceGroup(google::cloud::cpp::compute::instance_groups::v1::InsertInstanceGroupRequest const &, Options)

Creates an instance group in the specified project using the parameters that are included in the request.

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::InsertInstanceGroupRequest 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_groups.v1.InsertInstanceGroupRequest. 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.

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

Retrieves the list of zonal instance group resources contained within the specified zone.

For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/list

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::cpp::compute::v1::InstanceGroup >

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

ListInstanceGroups(google::cloud::cpp::compute::instance_groups::v1::ListInstanceGroupsRequest, Options)

Retrieves the list of zonal instance group resources contained within the specified zone.

For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/list

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::ListInstanceGroupsRequest

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_groups.v1.ListInstanceGroupsRequest. 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::InstanceGroup >

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

ListInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupsListInstancesRequest const &, Options)

Lists the instances in the specified instance group.

The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/listInstances

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group std::string const &

The name of the instance group from which you want to generate a list of included instances.

instance_groups_list_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupsListInstancesRequest const &

The InstanceGroupsListInstancesRequest 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::InstanceWithNamedPorts >

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

ListInstances(google::cloud::cpp::compute::instance_groups::v1::ListInstancesRequest, Options)

Lists the instances in the specified instance group.

The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/listInstances

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::ListInstancesRequest

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_groups.v1.ListInstancesRequest. 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::InstanceWithNamedPorts >

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

RemoveInstances(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupsRemoveInstancesRequest const &, Options)

Removes one or more instances from the specified instance group, but does not delete those 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 before the VM instance is removed or deleted. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/removeInstances

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group std::string const &

The name of the instance group where the specified instances will be removed.

instance_groups_remove_instances_request_resource google::cloud::cpp::compute::v1::InstanceGroupsRemoveInstancesRequest const &

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

RemoveInstances(google::cloud::cpp::compute::instance_groups::v1::RemoveInstancesRequest const &, Options)

Removes one or more instances from the specified instance group, but does not delete those 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 before the VM instance is removed or deleted. https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroups/removeInstances

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::RemoveInstancesRequest 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_groups.v1.RemoveInstancesRequest. 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.

SetNamedPorts(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupsSetNamedPortsRequest const &, Options)

Sets the named ports for the specified instance group.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

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

instance_group std::string const &

The name of the instance group where the named ports are updated.

instance_groups_set_named_ports_request_resource google::cloud::cpp::compute::v1::InstanceGroupsSetNamedPortsRequest const &

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

SetNamedPorts(google::cloud::cpp::compute::instance_groups::v1::SetNamedPortsRequest const &, Options)

Sets the named ports for the specified instance group.

Parameters
Name Description
request google::cloud::cpp::compute::instance_groups::v1::SetNamedPortsRequest 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_groups.v1.SetNamedPortsRequest. 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.