Service for the regionNetworkEndpointGroups resource.
https://cloud.google.com/compute/docs/reference/rest/v1/regionNetworkEndpointGroups
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
RegionNetworkEndpointGroupsClient(RegionNetworkEndpointGroupsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionNetworkEndpointGroupsClient const &
|
RegionNetworkEndpointGroupsClient(RegionNetworkEndpointGroupsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionNetworkEndpointGroupsClient &&
|
RegionNetworkEndpointGroupsClient(std::shared_ptr< RegionNetworkEndpointGroupsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< RegionNetworkEndpointGroupsConnection >
|
opts |
Options
|
Operators
operator=(RegionNetworkEndpointGroupsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionNetworkEndpointGroupsClient const &
|
Returns | |
---|---|
Type | Description |
RegionNetworkEndpointGroupsClient & |
operator=(RegionNetworkEndpointGroupsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
RegionNetworkEndpointGroupsClient &&
|
Returns | |
---|---|
Type | Description |
RegionNetworkEndpointGroupsClient & |
Functions
AttachNetworkEndpoints(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsAttachEndpointsRequest const &, Options)
Attach a list of network endpoints to the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where you want to create the network endpoint group. It should comply with RFC1035. |
network_endpoint_group |
std::string const &
The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. |
region_network_endpoint_groups_attach_endpoints_request_resource |
google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsAttachEndpointsRequest const &
The RegionNetworkEndpointGroupsAttachEndpointsRequest 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 |
AttachNetworkEndpoints(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsAttachEndpointsRequest const &, Options)
Attach a list of network endpoints to the specified network endpoint 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 &
|
network_endpoint_group |
std::string const &
|
region_network_endpoint_groups_attach_endpoints_request_resource |
google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsAttachEndpointsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
AttachNetworkEndpoints(google::cloud::cpp::compute::region_network_endpoint_groups::v1::AttachNetworkEndpointsRequest const &, Options)
Attach a list of network endpoints to the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::AttachNetworkEndpointsRequest 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 |
AttachNetworkEndpoints(NoAwaitTag, google::cloud::cpp::compute::region_network_endpoint_groups::v1::AttachNetworkEndpointsRequest const &, Options)
Attach a list of network endpoints to the specified network endpoint 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_network_endpoint_groups::v1::AttachNetworkEndpointsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
AttachNetworkEndpoints(google::cloud::cpp::compute::v1::Operation const &, Options)
Attach a list of network endpoints to the specified network endpoint 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 > > |
DeleteNetworkEndpointGroup(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified network endpoint group.
Note that the NEG cannot be deleted if it is configured as a backend of a backend service. https://cloud.google.com/compute/docs/reference/rest/v1/regionNetworkEndpointGroups/delete
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the network endpoint group is located. It should comply with RFC1035. |
network_endpoint_group |
std::string const &
The name of the network endpoint group to delete. It should comply with RFC1035. |
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 |
DeleteNetworkEndpointGroup(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified network endpoint 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 &
|
network_endpoint_group |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteNetworkEndpointGroup(google::cloud::cpp::compute::region_network_endpoint_groups::v1::DeleteNetworkEndpointGroupRequest const &, Options)
Deletes the specified network endpoint group.
Note that the NEG cannot be deleted if it is configured as a backend of a backend service. https://cloud.google.com/compute/docs/reference/rest/v1/regionNetworkEndpointGroups/delete
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::DeleteNetworkEndpointGroupRequest 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 |
DeleteNetworkEndpointGroup(NoAwaitTag, google::cloud::cpp::compute::region_network_endpoint_groups::v1::DeleteNetworkEndpointGroupRequest const &, Options)
Deletes the specified network endpoint 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_network_endpoint_groups::v1::DeleteNetworkEndpointGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteNetworkEndpointGroup(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified network endpoint 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 > > |
DetachNetworkEndpoints(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsDetachEndpointsRequest const &, Options)
Detach the network endpoint from the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the network endpoint group is located. It should comply with RFC1035. |
network_endpoint_group |
std::string const &
The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. |
region_network_endpoint_groups_detach_endpoints_request_resource |
google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsDetachEndpointsRequest const &
The RegionNetworkEndpointGroupsDetachEndpointsRequest 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 |
DetachNetworkEndpoints(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsDetachEndpointsRequest const &, Options)
Detach the network endpoint from the specified network endpoint 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 &
|
network_endpoint_group |
std::string const &
|
region_network_endpoint_groups_detach_endpoints_request_resource |
google::cloud::cpp::compute::v1::RegionNetworkEndpointGroupsDetachEndpointsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DetachNetworkEndpoints(google::cloud::cpp::compute::region_network_endpoint_groups::v1::DetachNetworkEndpointsRequest const &, Options)
Detach the network endpoint from the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::DetachNetworkEndpointsRequest 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 |
DetachNetworkEndpoints(NoAwaitTag, google::cloud::cpp::compute::region_network_endpoint_groups::v1::DetachNetworkEndpointsRequest const &, Options)
Detach the network endpoint from the specified network endpoint 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_network_endpoint_groups::v1::DetachNetworkEndpointsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DetachNetworkEndpoints(google::cloud::cpp::compute::v1::Operation const &, Options)
Detach the network endpoint from the specified network endpoint 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 > > |
GetNetworkEndpointGroup(std::string const &, std::string const &, std::string const &, Options)
Returns the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the network endpoint group is located. It should comply with RFC1035. |
network_endpoint_group |
std::string const &
The name of the network endpoint group. It should comply with RFC1035. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::NetworkEndpointGroup > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NetworkEndpointGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNetworkEndpointGroup(google::cloud::cpp::compute::region_network_endpoint_groups::v1::GetNetworkEndpointGroupRequest const &, Options)
Returns the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::GetNetworkEndpointGroupRequest 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::NetworkEndpointGroup > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NetworkEndpointGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertNetworkEndpointGroup(std::string const &, std::string const &, google::cloud::cpp::compute::v1::NetworkEndpointGroup const &, Options)
Creates a network endpoint 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. |
region |
std::string const &
The name of the region where you want to create the network endpoint group. It should comply with RFC1035. |
network_endpoint_group_resource |
google::cloud::cpp::compute::v1::NetworkEndpointGroup const &
The NetworkEndpointGroup 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 |
InsertNetworkEndpointGroup(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::NetworkEndpointGroup const &, Options)
Creates a network endpoint group in the specified project using the parameters that are included in the request.
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 &
|
network_endpoint_group_resource |
google::cloud::cpp::compute::v1::NetworkEndpointGroup const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertNetworkEndpointGroup(google::cloud::cpp::compute::region_network_endpoint_groups::v1::InsertNetworkEndpointGroupRequest const &, Options)
Creates a network endpoint group in the specified project using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::InsertNetworkEndpointGroupRequest 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 |
InsertNetworkEndpointGroup(NoAwaitTag, google::cloud::cpp::compute::region_network_endpoint_groups::v1::InsertNetworkEndpointGroupRequest const &, Options)
Creates a network endpoint group in the specified project using the parameters that are included in the request.
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_network_endpoint_groups::v1::InsertNetworkEndpointGroupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertNetworkEndpointGroup(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a network endpoint group in the specified project using the parameters that are included in the request.
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 > > |
ListRegionNetworkEndpointGroups(std::string const &, std::string const &, Options)
Retrieves the list of regional network endpoint groups available to the specified project in the given region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the network endpoint group is located. It should comply with RFC1035. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::NetworkEndpointGroup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRegionNetworkEndpointGroups(google::cloud::cpp::compute::region_network_endpoint_groups::v1::ListRegionNetworkEndpointGroupsRequest, Options)
Retrieves the list of regional network endpoint groups available to the specified project in the given region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::ListRegionNetworkEndpointGroupsRequest
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::NetworkEndpointGroup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNetworkEndpoints(std::string const &, std::string const &, std::string const &, Options)
Lists the network endpoints in the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region where the network endpoint group is located. It should comply with RFC1035. |
network_endpoint_group |
std::string const &
The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::NetworkEndpointWithHealthStatus > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNetworkEndpoints(google::cloud::cpp::compute::region_network_endpoint_groups::v1::ListNetworkEndpointsRequest, Options)
Lists the network endpoints in the specified network endpoint group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::region_network_endpoint_groups::v1::ListNetworkEndpointsRequest
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::NetworkEndpointWithHealthStatus > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |