Class RegionInstanceGroupsClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

Service for the regionInstanceGroups resource.

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

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

RegionInstanceGroupsClient(RegionInstanceGroupsClient const &)

Copy and move support

Parameter
Name	Description
	RegionInstanceGroupsClient const &

RegionInstanceGroupsClient(RegionInstanceGroupsClient &&)

Copy and move support

Parameter
Name	Description
	RegionInstanceGroupsClient &&

RegionInstanceGroupsClient(std::shared_ptr< RegionInstanceGroupsConnection >, Options)

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

Operators

operator=(RegionInstanceGroupsClient const &)

Copy and move support

Parameter
Name	Description
	RegionInstanceGroupsClient const &

Returns
Type	Description
RegionInstanceGroupsClient &

operator=(RegionInstanceGroupsClient &&)

Copy and move support

Parameter
Name	Description
	RegionInstanceGroupsClient &&

Returns
Type	Description
RegionInstanceGroupsClient &

Functions

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

Returns the specified instance group resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping this request.
instance_group	std::string const & Name of the instance group resource to return.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::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::region_instance_groups::v1::GetInstanceGroupRequest const &, Options)

Returns the specified instance group resource.

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

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

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

Retrieves the list of instance group resources contained within the specified region.

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

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

ListRegionInstanceGroups(google::cloud::cpp::compute::region_instance_groups::v1::ListRegionInstanceGroupsRequest, Options)

Retrieves the list of instance group resources contained within the specified region.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::region_instance_groups::v1::ListRegionInstanceGroupsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_instance_groups.v1.ListRegionInstanceGroupsRequest. 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::RegionInstanceGroupsListInstancesRequest const &, Options)

Lists the instances in the specified instance group and displays information about the named ports.

Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceGroups/listInstances

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping this request.
instance_group	std::string const & Name of the regional instance group for which we want to list the instances.
region_instance_groups_list_instances_request_resource	google::cloud::cpp::compute::v1::RegionInstanceGroupsListInstancesRequest const & The RegionInstanceGroupsListInstancesRequest 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::region_instance_groups::v1::ListInstancesRequest, Options)

Lists the instances in the specified instance group and displays information about the named ports.

Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported. https://cloud.google.com/compute/docs/reference/rest/v1/regionInstanceGroups/listInstances

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

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

Sets the named ports for the specified regional instance group.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region scoping this request.
instance_group	std::string const & The name of the regional instance group where the named ports are updated.
region_instance_groups_set_named_ports_request_resource	google::cloud::cpp::compute::v1::RegionInstanceGroupsSetNamedPortsRequest const & The RegionInstanceGroupsSetNamedPortsRequest 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::region_instance_groups::v1::SetNamedPortsRequest const &, Options)

Sets the named ports for the specified regional instance group.

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

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