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.
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 |
GetInstanceGroup(google::cloud::cpp::compute::region_instance_groups::v1::GetInstanceGroupRequest const &, Options)
Returns the specified instance group resource.
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 |
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 |
ListRegionInstanceGroups(std::string const &, std::string const &, Options)
Retrieves the list of instance group resources contained within the specified region.
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 |
ListRegionInstanceGroups(google::cloud::cpp::compute::region_instance_groups::v1::ListRegionInstanceGroupsRequest, Options)
Retrieves the list of instance group resources contained within the specified region.
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 |
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 |
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 |
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 |
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 |
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.
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 |
SetNamedPorts(NoAwaitTag, 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.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
instance_group |
std::string const &
|
region_instance_groups_set_named_ports_request_resource |
google::cloud::cpp::compute::v1::RegionInstanceGroupsSetNamedPortsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetNamedPorts(google::cloud::cpp::compute::region_instance_groups::v1::SetNamedPortsRequest const &, Options)
Sets the named ports for the specified regional instance group.
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 |
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 |
SetNamedPorts(NoAwaitTag, google::cloud::cpp::compute::region_instance_groups::v1::SetNamedPortsRequest const &, Options)
Sets the named ports for the specified regional instance group.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::region_instance_groups::v1::SetNamedPortsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetNamedPorts(google::cloud::cpp::compute::v1::Operation const &, Options)
Sets the named ports for the specified regional instance group.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |