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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateHub(NoAwaitTag, std::string const &, google::cloud::networkconnectivity::v1::Hub const &, std::string const &, Options)
Creates a new Network Connectivity Center hub in the specified project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
hub |
google::cloud::networkconnectivity::v1::Hub const &
|
hub_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateHub(NoAwaitTag, google::cloud::networkconnectivity::v1::CreateHubRequest const &, Options)
Creates a new Network Connectivity Center hub in the specified project.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::CreateHubRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateHub(google::longrunning::Operation const &, Options)
Creates a new Network Connectivity Center hub in the specified project.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::Hub > > |
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 |
UpdateHub(NoAwaitTag, google::cloud::networkconnectivity::v1::Hub const &, google::protobuf::FieldMask const &, Options)
Updates the description and/or labels of a Network Connectivity Center hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
hub |
google::cloud::networkconnectivity::v1::Hub const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateHub(NoAwaitTag, google::cloud::networkconnectivity::v1::UpdateHubRequest const &, Options)
Updates the description and/or labels of a Network Connectivity Center hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::UpdateHubRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateHub(google::longrunning::Operation const &, Options)
Updates the description and/or labels of a Network Connectivity Center hub.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::Hub > > |
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 |
DeleteHub(NoAwaitTag, std::string const &, Options)
Deletes a Network Connectivity Center hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteHub(NoAwaitTag, google::cloud::networkconnectivity::v1::DeleteHubRequest const &, Options)
Deletes a Network Connectivity Center hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::DeleteHubRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteHub(google::longrunning::Operation const &, Options)
Deletes a Network Connectivity Center hub.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::OperationMetadata > > |
ListHubSpokes(std::string const &, Options)
Lists the Network Connectivity Center spokes associated with a specified hub and location.
The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the hub. |
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 |
ListHubSpokes(google::cloud::networkconnectivity::v1::ListHubSpokesRequest, Options)
Lists the Network Connectivity Center spokes associated with a specified hub and location.
The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::ListHubSpokesRequest
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::networkconnectivity::v1::Spoke > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
CreateSpoke(NoAwaitTag, std::string const &, google::cloud::networkconnectivity::v1::Spoke const &, std::string const &, Options)
Creates a Network Connectivity Center spoke.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
spoke |
google::cloud::networkconnectivity::v1::Spoke const &
|
spoke_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
CreateSpoke(NoAwaitTag, google::cloud::networkconnectivity::v1::CreateSpokeRequest const &, Options)
Creates a Network Connectivity Center spoke.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::CreateSpokeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSpoke(google::longrunning::Operation const &, Options)
Creates a Network Connectivity Center spoke.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::Spoke > > |
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 |
UpdateSpoke(NoAwaitTag, google::cloud::networkconnectivity::v1::Spoke const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a Network Connectivity Center spoke.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
spoke |
google::cloud::networkconnectivity::v1::Spoke const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
UpdateSpoke(NoAwaitTag, google::cloud::networkconnectivity::v1::UpdateSpokeRequest const &, Options)
Updates the parameters of a Network Connectivity Center spoke.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::UpdateSpokeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateSpoke(google::longrunning::Operation const &, Options)
Updates the parameters of a Network Connectivity Center spoke.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::Spoke > > |
RejectHubSpoke(std::string const &, std::string const &, Options)
Rejects a Network Connectivity Center spoke from being attached to a hub.
If the spoke was previously in the ACTIVE
state, it transitions to the INACTIVE
state and is no longer able to connect to other spokes that are attached to the hub.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the hub from which to reject the spoke. |
spoke_uri |
std::string const &
Required. The URI of the spoke to reject from 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::RejectHubSpokeResponse > > |
A |
RejectHubSpoke(NoAwaitTag, std::string const &, std::string const &, Options)
Rejects a Network Connectivity Center spoke from being attached to a hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
spoke_uri |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RejectHubSpoke(google::cloud::networkconnectivity::v1::RejectHubSpokeRequest const &, Options)
Rejects a Network Connectivity Center spoke from being attached to a hub.
If the spoke was previously in the ACTIVE
state, it transitions to the INACTIVE
state and is no longer able to connect to other spokes that are attached to the hub.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::RejectHubSpokeRequest 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::networkconnectivity::v1::RejectHubSpokeResponse > > |
A |
RejectHubSpoke(NoAwaitTag, google::cloud::networkconnectivity::v1::RejectHubSpokeRequest const &, Options)
Rejects a Network Connectivity Center spoke from being attached to a hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::RejectHubSpokeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RejectHubSpoke(google::longrunning::Operation const &, Options)
Rejects a Network Connectivity Center spoke from being attached to a hub.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::RejectHubSpokeResponse > > |
AcceptHubSpoke(std::string const &, std::string const &, Options)
Accepts a proposal to attach a Network Connectivity Center spoke to a hub.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the hub into which to accept the spoke. |
spoke_uri |
std::string const &
Required. The URI of the spoke to accept into 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::AcceptHubSpokeResponse > > |
A |
AcceptHubSpoke(NoAwaitTag, std::string const &, std::string const &, Options)
Accepts a proposal to attach a Network Connectivity Center spoke to a hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
spoke_uri |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
AcceptHubSpoke(google::cloud::networkconnectivity::v1::AcceptHubSpokeRequest const &, Options)
Accepts a proposal to attach a Network Connectivity Center spoke to a hub.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::AcceptHubSpokeRequest 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::networkconnectivity::v1::AcceptHubSpokeResponse > > |
A |
AcceptHubSpoke(NoAwaitTag, google::cloud::networkconnectivity::v1::AcceptHubSpokeRequest const &, Options)
Accepts a proposal to attach a Network Connectivity Center spoke to a hub.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::AcceptHubSpokeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
AcceptHubSpoke(google::longrunning::Operation const &, Options)
Accepts a proposal to attach a Network Connectivity Center spoke to a hub.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::AcceptHubSpokeResponse > > |
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 |
DeleteSpoke(NoAwaitTag, std::string const &, Options)
Deletes a Network Connectivity Center spoke.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
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 |
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 |
DeleteSpoke(NoAwaitTag, google::cloud::networkconnectivity::v1::DeleteSpokeRequest const &, Options)
Deletes a Network Connectivity Center spoke.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::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::networkconnectivity::v1::DeleteSpokeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteSpoke(google::longrunning::Operation const &, Options)
Deletes a Network Connectivity Center spoke.
This method accepts a google::longrunning::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::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkconnectivity::v1::OperationMetadata > > |
GetRouteTable(std::string const &, Options)
Gets details about a Network Connectivity Center route table.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the route table resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::networkconnectivity::v1::RouteTable > |
the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.RouteTable) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRouteTable(google::cloud::networkconnectivity::v1::GetRouteTableRequest const &, Options)
Gets details about a Network Connectivity Center route table.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::GetRouteTableRequest 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::networkconnectivity::v1::RouteTable > |
the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.RouteTable) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRoute(std::string const &, Options)
Gets details about the specified route.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the route resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::networkconnectivity::v1::Route > |
the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Route) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRoute(google::cloud::networkconnectivity::v1::GetRouteRequest const &, Options)
Gets details about the specified route.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::GetRouteRequest 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::networkconnectivity::v1::Route > |
the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Route) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListRoutes(std::string const &, Options)
Lists routes in 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::Route > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRoutes(google::cloud::networkconnectivity::v1::ListRoutesRequest, Options)
Lists routes in a given project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::ListRoutesRequest
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::networkconnectivity::v1::Route > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRouteTables(std::string const &, Options)
Lists route tables in 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::RouteTable > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRouteTables(google::cloud::networkconnectivity::v1::ListRouteTablesRequest, Options)
Lists route tables in a given project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::ListRouteTablesRequest
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::networkconnectivity::v1::RouteTable > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetGroup(std::string const &, Options)
Gets details about a Network Connectivity Center group.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the route table resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::networkconnectivity::v1::Group > |
the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetGroup(google::cloud::networkconnectivity::v1::GetGroupRequest const &, Options)
Gets details about a Network Connectivity Center group.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::GetGroupRequest 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::networkconnectivity::v1::Group > |
the result of the RPC. The response message type (google.cloud.networkconnectivity.v1.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListGroups(std::string const &, Options)
Lists groups in a given hub.
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::Group > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListGroups(google::cloud::networkconnectivity::v1::ListGroupsRequest, Options)
Lists groups in a given hub.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkconnectivity::v1::ListGroupsRequest
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::networkconnectivity::v1::Group > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
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::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest 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::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::SetIamPolicyRequest 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::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::GetIamPolicyRequest 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::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest 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::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
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::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest 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::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest 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 |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest 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 |
Status |
a |