Skip to content

Commit 2852893

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Update comments for Connectivity Test
PiperOrigin-RevId: 737495961
1 parent a63cdf6 commit 2852893

2 files changed

Lines changed: 52 additions & 94 deletions

File tree

‎google/cloud/networkmanagement/v1/connectivity_test.proto‎

Lines changed: 26 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -47,46 +47,22 @@ message ConnectivityTest {
4747

4848
// Required. Source specification of the Connectivity Test.
4949
//
50-
// You can use a combination of source IP address, virtual machine
51-
// (VM) instance, or Compute Engine network to uniquely identify
52-
// the source location.
50+
// You can use a combination of source IP address, URI of a supported
51+
// endpoint, project ID, or VPC network to identify the source location.
5352
//
54-
// Examples:
55-
// If the source IP address is an internal IP address within a Google Cloud
56-
// Virtual Private Cloud (VPC) network, then you must also specify the VPC
57-
// network. Otherwise, specify the VM instance, which already contains its
58-
// internal IP address and VPC network information.
59-
//
60-
// If the source of the test is within an on-premises network, then you must
61-
// provide the destination VPC network.
62-
//
63-
// If the source endpoint is a Compute Engine VM instance with multiple
64-
// network interfaces, the instance itself is not sufficient to identify the
65-
// endpoint. So, you must also specify the source IP address or VPC network.
66-
//
67-
// A reachability analysis proceeds even if the source location is
68-
// ambiguous. However, the test result may include endpoints that you don't
69-
// intend to test.
53+
// Reachability analysis might proceed even if the source location is
54+
// ambiguous. However, the test result might include endpoints or use a source
55+
// that you don't intend to test.
7056
Endpoint source = 3 [(google.api.field_behavior) = REQUIRED];
7157

7258
// Required. Destination specification of the Connectivity Test.
7359
//
74-
// You can use a combination of destination IP address, Compute Engine
75-
// VM instance, or VPC network to uniquely identify the destination
76-
// location.
77-
//
78-
// Even if the destination IP address is not unique, the source IP
79-
// location is unique. Usually, the analysis can infer the destination
80-
// endpoint from route information.
81-
//
82-
// If the destination you specify is a VM instance and the instance has
83-
// multiple network interfaces, then you must also specify either
84-
// a destination IP address or VPC network to identify the destination
85-
// interface.
60+
// You can use a combination of destination IP address, URI of a supported
61+
// endpoint, project ID, or VPC network to identify the destination location.
8662
//
87-
// A reachability analysis proceeds even if the destination location is
88-
// ambiguous. However, the result can include endpoints that you don't
89-
// intend to test.
63+
// Reachability analysis proceeds even if the destination location is
64+
// ambiguous. However, the test result might include endpoints or use a
65+
// destination that you don't intend to test.
9066
Endpoint destination = 4 [(google.api.field_behavior) = REQUIRED];
9167

9268
// IP Protocol of the test. When not provided, "TCP" is assumed.
@@ -134,8 +110,7 @@ message ConnectivityTest {
134110
ReachabilityDetails return_reachability_details = 16
135111
[(google.api.field_behavior) = OUTPUT_ONLY];
136112

137-
// Whether the test should skip firewall checking.
138-
// If not provided, we assume false.
113+
// Whether the analysis should skip firewall checking. Default value is false.
139114
bool bypass_firewall_checks = 17;
140115
}
141116

@@ -153,8 +128,8 @@ message Endpoint {
153128
GCP_NETWORK = 1;
154129

155130
// A network hosted outside of Google Cloud.
156-
// This can be an on-premises network, or a network hosted by another cloud
157-
// provider.
131+
// This can be an on-premises network, an internet resource or a network
132+
// hosted by another cloud provider.
158133
NON_GCP_NETWORK = 2;
159134
}
160135

@@ -213,7 +188,8 @@ message Endpoint {
213188
// A forwarding rule and its corresponding IP address represent the frontend
214189
// configuration of a Google Cloud load balancer. Forwarding rules are also
215190
// used for protocol forwarding, Private Service Connect and other network
216-
// services to provide forwarding information in the control plane. Format:
191+
// services to provide forwarding information in the control plane. Applicable
192+
// only to destination endpoint. Format:
217193
// projects/{project}/global/forwardingRules/{id} or
218194
// projects/{project}/regions/{region}/forwardingRules/{id}
219195
string forwarding_rule = 13;
@@ -244,26 +220,29 @@ message Endpoint {
244220
// A [Cloud SQL](https://cloud.google.com/sql) instance URI.
245221
string cloud_sql_instance = 8;
246222

247-
// A [Redis Instance](https://cloud.google.com/memorystore/docs/redis)
248-
// URI.
223+
// A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI.
224+
// Applicable only to destination endpoint.
249225
string redis_instance = 17;
250226

251-
// A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster)
252-
// URI.
227+
// A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI.
228+
// Applicable only to destination endpoint.
253229
string redis_cluster = 18;
254230

255-
// A [Cloud Function](https://cloud.google.com/functions).
231+
// A [Cloud Function](https://cloud.google.com/functions). Applicable only to
232+
// source endpoint.
256233
CloudFunctionEndpoint cloud_function = 10;
257234

258235
// An [App Engine](https://cloud.google.com/appengine) [service
259236
// version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
237+
// Applicable only to source endpoint.
260238
AppEngineVersionEndpoint app_engine_version = 11;
261239

262240
// A [Cloud Run](https://cloud.google.com/run)
263241
// [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get)
242+
// Applicable only to source endpoint.
264243
CloudRunRevisionEndpoint cloud_run_revision = 12;
265244

266-
// A Compute Engine network URI.
245+
// A VPC network URI.
267246
string network = 4;
268247

269248
// Type of the network where the endpoint is located.
@@ -272,9 +251,9 @@ message Endpoint {
272251
NetworkType network_type = 5;
273252

274253
// Project ID where the endpoint is located.
275-
// The Project ID can be derived from the URI if you provide a VM instance or
254+
// The project ID can be derived from the URI if you provide a endpoint or
276255
// network URI.
277-
// The following are two cases where you must provide the project ID:
256+
// The following are two cases where you may need to provide the project ID:
278257
// 1. Only the IP address is specified, and the IP address is within a Google
279258
// Cloud project.
280259
// 2. When you are using Shared VPC and the IP address that you provide is

‎google/cloud/networkmanagement/v1beta1/connectivity_test.proto‎

Lines changed: 26 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -47,46 +47,22 @@ message ConnectivityTest {
4747

4848
// Required. Source specification of the Connectivity Test.
4949
//
50-
// You can use a combination of source IP address, virtual machine
51-
// (VM) instance, or Compute Engine network to uniquely identify
52-
// the source location.
50+
// You can use a combination of source IP address, URI of a supported
51+
// endpoint, project ID, or VPC network to identify the source location.
5352
//
54-
// Examples:
55-
// If the source IP address is an internal IP address within a Google Cloud
56-
// Virtual Private Cloud (VPC) network, then you must also specify the VPC
57-
// network. Otherwise, specify the VM instance, which already contains its
58-
// internal IP address and VPC network information.
59-
//
60-
// If the source of the test is within an on-premises network, then you must
61-
// provide the destination VPC network.
62-
//
63-
// If the source endpoint is a Compute Engine VM instance with multiple
64-
// network interfaces, the instance itself is not sufficient to identify the
65-
// endpoint. So, you must also specify the source IP address or VPC network.
66-
//
67-
// A reachability analysis proceeds even if the source location is
68-
// ambiguous. However, the test result may include endpoints that you don't
69-
// intend to test.
53+
// Reachability analysis might proceed even if the source location is
54+
// ambiguous. However, the test result might include endpoints or use a source
55+
// that you don't intend to test.
7056
Endpoint source = 3 [(google.api.field_behavior) = REQUIRED];
7157

7258
// Required. Destination specification of the Connectivity Test.
7359
//
74-
// You can use a combination of destination IP address, Compute Engine
75-
// VM instance, or VPC network to uniquely identify the destination
76-
// location.
77-
//
78-
// Even if the destination IP address is not unique, the source IP
79-
// location is unique. Usually, the analysis can infer the destination
80-
// endpoint from route information.
81-
//
82-
// If the destination you specify is a VM instance and the instance has
83-
// multiple network interfaces, then you must also specify either
84-
// a destination IP address or VPC network to identify the destination
85-
// interface.
60+
// You can use a combination of destination IP address, URI of a supported
61+
// endpoint, project ID, or VPC network to identify the destination location.
8662
//
87-
// A reachability analysis proceeds even if the destination location is
88-
// ambiguous. However, the result can include endpoints that you don't
89-
// intend to test.
63+
// Reachability analysis proceeds even if the destination location is
64+
// ambiguous. However, the test result might include endpoints or use a
65+
// destination that you don't intend to test.
9066
Endpoint destination = 4 [(google.api.field_behavior) = REQUIRED];
9167

9268
// IP Protocol of the test. When not provided, "TCP" is assumed.
@@ -134,8 +110,7 @@ message ConnectivityTest {
134110
ReachabilityDetails return_reachability_details = 16
135111
[(google.api.field_behavior) = OUTPUT_ONLY];
136112

137-
// Whether the test should skip firewall checking.
138-
// If not provided, we assume false.
113+
// Whether the analysis should skip firewall checking. Default value is false.
139114
bool bypass_firewall_checks = 17;
140115
}
141116

@@ -153,8 +128,8 @@ message Endpoint {
153128
GCP_NETWORK = 1;
154129

155130
// A network hosted outside of Google Cloud.
156-
// This can be an on-premises network, or a network hosted by another cloud
157-
// provider.
131+
// This can be an on-premises network, an internet resource or a network
132+
// hosted by another cloud provider.
158133
NON_GCP_NETWORK = 2;
159134
}
160135

@@ -213,7 +188,8 @@ message Endpoint {
213188
// A forwarding rule and its corresponding IP address represent the frontend
214189
// configuration of a Google Cloud load balancer. Forwarding rules are also
215190
// used for protocol forwarding, Private Service Connect and other network
216-
// services to provide forwarding information in the control plane. Format:
191+
// services to provide forwarding information in the control plane. Applicable
192+
// only to destination endpoint. Format:
217193
// projects/{project}/global/forwardingRules/{id} or
218194
// projects/{project}/regions/{region}/forwardingRules/{id}
219195
string forwarding_rule = 13;
@@ -244,26 +220,29 @@ message Endpoint {
244220
// A [Cloud SQL](https://cloud.google.com/sql) instance URI.
245221
string cloud_sql_instance = 8;
246222

247-
// A [Redis Instance](https://cloud.google.com/memorystore/docs/redis)
248-
// URI.
223+
// A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI.
224+
// Applicable only to destination endpoint.
249225
string redis_instance = 17;
250226

251-
// A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster)
252-
// URI.
227+
// A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI.
228+
// Applicable only to destination endpoint.
253229
string redis_cluster = 18;
254230

255-
// A [Cloud Function](https://cloud.google.com/functions).
231+
// A [Cloud Function](https://cloud.google.com/functions). Applicable only to
232+
// source endpoint.
256233
CloudFunctionEndpoint cloud_function = 10;
257234

258235
// An [App Engine](https://cloud.google.com/appengine) [service
259236
// version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
237+
// Applicable only to source endpoint.
260238
AppEngineVersionEndpoint app_engine_version = 11;
261239

262240
// A [Cloud Run](https://cloud.google.com/run)
263241
// [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get)
242+
// Applicable only to source endpoint.
264243
CloudRunRevisionEndpoint cloud_run_revision = 12;
265244

266-
// A Compute Engine network URI.
245+
// A VPC network URI.
267246
string network = 4;
268247

269248
// Type of the network where the endpoint is located.
@@ -272,9 +251,9 @@ message Endpoint {
272251
NetworkType network_type = 5;
273252

274253
// Project ID where the endpoint is located.
275-
// The Project ID can be derived from the URI if you provide a VM instance or
254+
// The project ID can be derived from the URI if you provide a endpoint or
276255
// network URI.
277-
// The following are two cases where you must provide the project ID:
256+
// The following are two cases where you may need to provide the project ID:
278257
// 1. Only the IP address is specified, and the IP address is within a Google
279258
// Cloud project.
280259
// 2. When you are using Shared VPC and the IP address that you provide is

0 commit comments

Comments
 (0)