The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts.
A reachability analysis is based on Google Cloud network configurations.
You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.
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
ReachabilityServiceClient(ReachabilityServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReachabilityServiceClient const &
|
ReachabilityServiceClient(ReachabilityServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReachabilityServiceClient &&
|
ReachabilityServiceClient(std::shared_ptr< ReachabilityServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ReachabilityServiceConnection >
|
opts |
Options
|
Operators
operator=(ReachabilityServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReachabilityServiceClient const &
|
Returns | |
---|---|
Type | Description |
ReachabilityServiceClient & |
operator=(ReachabilityServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReachabilityServiceClient &&
|
Returns | |
---|---|
Type | Description |
ReachabilityServiceClient & |
Functions
ListConnectivityTests(std::string const &, Options)
Lists all Connectivity Tests owned by a project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource of the Connectivity Tests: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::networkmanagement::v1::ConnectivityTest > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListConnectivityTests(google::cloud::networkmanagement::v1::ListConnectivityTestsRequest, Options)
Lists all Connectivity Tests owned by a project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkmanagement::v1::ListConnectivityTestsRequest
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::networkmanagement::v1::ConnectivityTest > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetConnectivityTest(std::string const &, Options)
Gets the details of a specific Connectivity Test.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::networkmanagement::v1::ConnectivityTest > |
the result of the RPC. The response message type (google.cloud.networkmanagement.v1.ConnectivityTest) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConnectivityTest(google::cloud::networkmanagement::v1::GetConnectivityTestRequest const &, Options)
Gets the details of a specific Connectivity Test.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkmanagement::v1::GetConnectivityTestRequest 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::networkmanagement::v1::ConnectivityTest > |
the result of the RPC. The response message type (google.cloud.networkmanagement.v1.ConnectivityTest) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateConnectivityTest(std::string const &, std::string const &, google::cloud::networkmanagement::v1::ConnectivityTest const &, Options)
Creates a new Connectivity Test.
After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.
If the endpoint specifications in ConnectivityTest
are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN
.
If the endpoint specifications in ConnectivityTest
are incomplete, the reachability result returns a value of AMBIGUOUS
. For more information, see the Connectivity Test documentation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource of the Connectivity Test to create: |
test_id |
std::string const &
Required. The logical name of the Connectivity Test in your project with the following restrictions:
|
resource |
google::cloud::networkmanagement::v1::ConnectivityTest const &
Required. A |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkmanagement::v1::ConnectivityTest > > |
A |
CreateConnectivityTest(google::cloud::networkmanagement::v1::CreateConnectivityTestRequest const &, Options)
Creates a new Connectivity Test.
After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.
If the endpoint specifications in ConnectivityTest
are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN
.
If the endpoint specifications in ConnectivityTest
are incomplete, the reachability result returns a value of AMBIGUOUS
. For more information, see the Connectivity Test documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkmanagement::v1::CreateConnectivityTestRequest 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::networkmanagement::v1::ConnectivityTest > > |
A |
UpdateConnectivityTest(google::protobuf::FieldMask const &, google::cloud::networkmanagement::v1::ConnectivityTest const &, Options)
Updates the configuration of an existing ConnectivityTest
.
After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result.
If the endpoint specifications in ConnectivityTest
are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN
.
If the endpoint specifications in ConnectivityTest
are incomplete, the reachability result returns a value of AMBIGUOUS
. See the documentation in ConnectivityTest
for for more details.
Parameters | |
---|---|
Name | Description |
update_mask |
google::protobuf::FieldMask const &
Required. Mask of fields to update. At least one path must be supplied in this field. |
resource |
google::cloud::networkmanagement::v1::ConnectivityTest const &
Required. Only fields specified in update_mask are updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkmanagement::v1::ConnectivityTest > > |
A |
UpdateConnectivityTest(google::cloud::networkmanagement::v1::UpdateConnectivityTestRequest const &, Options)
Updates the configuration of an existing ConnectivityTest
.
After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result.
If the endpoint specifications in ConnectivityTest
are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN
.
If the endpoint specifications in ConnectivityTest
are incomplete, the reachability result returns a value of AMBIGUOUS
. See the documentation in ConnectivityTest
for for more details.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkmanagement::v1::UpdateConnectivityTestRequest 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::networkmanagement::v1::ConnectivityTest > > |
A |
RerunConnectivityTest(google::cloud::networkmanagement::v1::RerunConnectivityTestRequest const &, Options)
Rerun an existing ConnectivityTest
.
After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.
Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes.
If the endpoint specifications in ConnectivityTest
become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkmanagement::v1::RerunConnectivityTestRequest 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::networkmanagement::v1::ConnectivityTest > > |
A |
DeleteConnectivityTest(std::string const &, Options)
Deletes a specific ConnectivityTest
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Connectivity Test resource name using the form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::networkmanagement::v1::OperationMetadata > > |
A |
DeleteConnectivityTest(google::cloud::networkmanagement::v1::DeleteConnectivityTestRequest const &, Options)
Deletes a specific ConnectivityTest
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::networkmanagement::v1::DeleteConnectivityTestRequest 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::networkmanagement::v1::OperationMetadata > > |
A |