Class HubServiceClient (2.16.0)

Version 2.16.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 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
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud.

It reduces operational complexity through a simple, centralized connectivity management model.

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

HubServiceClient(HubServiceClient const &)

Copy and move support

Parameter
Name	Description
	HubServiceClient const &

HubServiceClient(HubServiceClient &&)

Copy and move support

Parameter
Name	Description
	HubServiceClient &&

HubServiceClient(std::shared_ptr< HubServiceConnection >, Options)

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

Operators

operator=(HubServiceClient const &)

Copy and move support

Parameter
Name	Description
	HubServiceClient const &

Returns
Type	Description
HubServiceClient &

operator=(HubServiceClient &&)

Copy and move support

Parameter
Name	Description
	HubServiceClient &&

Returns
Type	Description
HubServiceClient &

Functions

ListHubs(std::string const &, Options)

Lists the Network Connectivity Center hubs associated with a given project.

Parameters
Name	Description
parent	std::string const & Required. The parent resource's name.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::networkconnectivity::v1::Hub >	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.networkconnectivity.v1.Hub, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListHubs(google::cloud::networkconnectivity::v1::ListHubsRequest, Options)

Lists the Network Connectivity Center hubs associated with a given project.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::ListHubsRequest 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.networkconnectivity.v1.ListHubsRequest. 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::networkconnectivity::v1::Hub >	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.networkconnectivity.v1.Hub, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetHub(std::string const &, Options)

Gets details about a Network Connectivity Center hub.

Parameters
Name	Description
name	std::string const & Required. The name of the hub resource to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::networkconnectivity::v1::Hub >	the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Hub) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetHub(google::cloud::networkconnectivity::v1::GetHubRequest const &, Options)

Gets details about a Network Connectivity Center hub.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::GetHubRequest 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.networkconnectivity.v1.GetHubRequest. 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::networkconnectivity::v1::Hub >	the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Hub) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateHub(std::string const &, google::cloud::networkconnectivity::v1::Hub const &, std::string const &, Options)

Creates a new Network Connectivity Center hub in the specified project.

Parameters
Name	Description
parent	std::string const & Required. The parent resource.
hub	google::cloud::networkconnectivity::v1::Hub const & Required. The initial values for a new hub.
hub_id	std::string const & Required. A unique identifier for the hub.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::networkconnectivity::v1::Hub > >	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.networkconnectivity.v1.Hub proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateHub(google::cloud::networkconnectivity::v1::CreateHubRequest const &, Options)

Creates a new Network Connectivity Center hub in the specified project.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::CreateHubRequest 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.networkconnectivity.v1.CreateHubRequest. 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::networkconnectivity::v1::Hub > >	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.networkconnectivity.v1.Hub proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateHub(google::cloud::networkconnectivity::v1::Hub const &, google::protobuf::FieldMask const &, Options)

Updates the description and/or labels of a Network Connectivity Center hub.

Parameters
Name	Description
hub	google::cloud::networkconnectivity::v1::Hub const & Required. The state that the hub should be in after the update.
update_mask	google::protobuf::FieldMask const & Optional. In the case of an update to an existing hub, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::networkconnectivity::v1::Hub > >	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.networkconnectivity.v1.Hub proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateHub(google::cloud::networkconnectivity::v1::UpdateHubRequest const &, Options)

Updates the description and/or labels of a Network Connectivity Center hub.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::UpdateHubRequest 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.networkconnectivity.v1.UpdateHubRequest. 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::networkconnectivity::v1::Hub > >	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.networkconnectivity.v1.Hub proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteHub(std::string const &, Options)

Deletes a Network Connectivity Center hub.

Parameters
Name	Description
name	std::string const & Required. The name of the hub to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::networkconnectivity::v1::OperationMetadata > >	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.networkconnectivity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteHub(google::cloud::networkconnectivity::v1::DeleteHubRequest const &, Options)

Deletes a Network Connectivity Center hub.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::DeleteHubRequest 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.networkconnectivity.v1.DeleteHubRequest. 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::networkconnectivity::v1::OperationMetadata > >	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.networkconnectivity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListSpokes(std::string const &, Options)

Lists the Network Connectivity Center spokes in a specified project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::networkconnectivity::v1::Spoke >	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.networkconnectivity.v1.Spoke, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSpokes(google::cloud::networkconnectivity::v1::ListSpokesRequest, Options)

Lists the Network Connectivity Center spokes in a specified project and location.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::ListSpokesRequest 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.networkconnectivity.v1.ListSpokesRequest. 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::networkconnectivity::v1::Spoke >	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.networkconnectivity.v1.Spoke, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetSpoke(std::string const &, Options)

Gets details about a Network Connectivity Center spoke.

Parameters
Name	Description
name	std::string const & Required. The name of the spoke resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::networkconnectivity::v1::Spoke >	the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Spoke) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSpoke(google::cloud::networkconnectivity::v1::GetSpokeRequest const &, Options)

Gets details about a Network Connectivity Center spoke.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::GetSpokeRequest 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.networkconnectivity.v1.GetSpokeRequest. 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::networkconnectivity::v1::Spoke >	the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Spoke) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSpoke(std::string const &, google::cloud::networkconnectivity::v1::Spoke const &, std::string const &, Options)

Creates a Network Connectivity Center spoke.

Parameters
Name	Description
parent	std::string const & Required. The parent resource.
spoke	google::cloud::networkconnectivity::v1::Spoke const & Required. The initial values for a new spoke.
spoke_id	std::string const & Required. Unique id for the spoke to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::networkconnectivity::v1::Spoke > >	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.networkconnectivity.v1.Spoke proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateSpoke(google::cloud::networkconnectivity::v1::CreateSpokeRequest const &, Options)

Creates a Network Connectivity Center spoke.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::CreateSpokeRequest 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.networkconnectivity.v1.CreateSpokeRequest. 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::networkconnectivity::v1::Spoke > >	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.networkconnectivity.v1.Spoke proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSpoke(google::cloud::networkconnectivity::v1::Spoke const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a Network Connectivity Center spoke.

Parameters
Name	Description
spoke	google::cloud::networkconnectivity::v1::Spoke const & Required. The state that the spoke should be in after the update.
update_mask	google::protobuf::FieldMask const & Optional. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::networkconnectivity::v1::Spoke > >	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.networkconnectivity.v1.Spoke proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateSpoke(google::cloud::networkconnectivity::v1::UpdateSpokeRequest const &, Options)

Updates the parameters of a Network Connectivity Center spoke.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::UpdateSpokeRequest 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.networkconnectivity.v1.UpdateSpokeRequest. 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::networkconnectivity::v1::Spoke > >	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.networkconnectivity.v1.Spoke proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSpoke(std::string const &, Options)

Deletes a Network Connectivity Center spoke.

Parameters
Name	Description
name	std::string const & Required. The name of the spoke to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::networkconnectivity::v1::OperationMetadata > >	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.networkconnectivity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSpoke(google::cloud::networkconnectivity::v1::DeleteSpokeRequest const &, Options)

Deletes a Network Connectivity Center spoke.

Parameters
Name	Description
request	google::cloud::networkconnectivity::v1::DeleteSpokeRequest 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.networkconnectivity.v1.DeleteSpokeRequest. 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::networkconnectivity::v1::OperationMetadata > >	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.networkconnectivity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.