Class RegionNetworkEndpointGroupsClient (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 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.

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

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

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.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.AttachNetworkEndpointsRequest. 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.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.DeleteNetworkEndpointGroupRequest. 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.

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.

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

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

DetachNetworkEndpoints(google::cloud::cpp::compute::region_network_endpoint_groups::v1::DetachNetworkEndpointsRequest const &, Options)

Detach the network endpoint from the specified network endpoint group.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.DetachNetworkEndpointsRequest. 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.

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

Returns the specified network endpoint group.

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

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 StatusOr contains the error details.

GetNetworkEndpointGroup(google::cloud::cpp::compute::region_network_endpoint_groups::v1::GetNetworkEndpointGroupRequest const &, Options)

Returns the specified network endpoint group.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.GetNetworkEndpointGroupRequest. 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::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 StatusOr contains the error details.

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.

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

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

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.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.InsertNetworkEndpointGroupRequest. 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.

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.

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

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

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.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.ListRegionNetworkEndpointGroupsRequest. 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::NetworkEndpointGroup >	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.NetworkEndpointGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Lists the network endpoints in the specified network endpoint group.

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

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

ListNetworkEndpoints(google::cloud::cpp::compute::region_network_endpoint_groups::v1::ListNetworkEndpointsRequest, Options)

Lists the network endpoints in the specified network endpoint group.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.region_network_endpoint_groups.v1.ListNetworkEndpointsRequest. 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::NetworkEndpointWithHealthStatus >	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.NetworkEndpointWithHealthStatus, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.