Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [networkmanagement] Update comments in Connectivity Test protos #9362

Merged
merged 2 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions java-network-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.11.0</version>
<version>26.12.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-stable-green
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-network-management.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-network-management/1.15.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-network-management/1.16.0
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted within Google Cloud Platform.
* A network hosted within Google Cloud.
* To receive more detailed output, specify the URI for the source or
* destination network.
* </pre>
Expand All @@ -110,7 +110,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted outside of Google Cloud Platform.
* A network hosted outside of Google Cloud.
* This can be an on-premises network, or a network hosted by another cloud
* provider.
* </pre>
Expand All @@ -135,7 +135,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted within Google Cloud Platform.
* A network hosted within Google Cloud.
* To receive more detailed output, specify the URI for the source or
* destination network.
* </pre>
Expand All @@ -147,7 +147,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted outside of Google Cloud Platform.
* A network hosted outside of Google Cloud.
* This can be an on-premises network, or a network hosted by another cloud
* provider.
* </pre>
Expand Down Expand Up @@ -572,8 +572,8 @@ public com.google.cloud.networkmanagement.v1.Endpoint.NetworkType getNetworkType
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -603,8 +603,8 @@ public java.lang.String getProjectId() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -1849,8 +1849,8 @@ public Builder clearNetworkType() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -1879,8 +1879,8 @@ public java.lang.String getProjectId() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -1909,8 +1909,8 @@ public com.google.protobuf.ByteString getProjectIdBytes() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -1938,8 +1938,8 @@ public Builder setProjectId(java.lang.String value) {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand All @@ -1963,8 +1963,8 @@ public Builder clearProjectId() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ public interface EndpointOrBuilder
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand All @@ -225,8 +225,8 @@ public interface EndpointOrBuilder
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,18 @@ message ConnectivityTest {
map<string, string> labels = 8;

// Output only. The time the test was created.
google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Timestamp create_time = 10
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. The time the test's configuration was updated.
google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Timestamp update_time = 11
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. The reachability details of this test from the latest run.
// The details are updated when creating a new test, updating an
// existing test, or triggering a one-time rerun of an existing test.
ReachabilityDetails reachability_details = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
ReachabilityDetails reachability_details = 12
[(google.api.field_behavior) = OUTPUT_ONLY];
}

// Source or destination of the Connectivity Test.
Expand All @@ -122,12 +125,12 @@ message Endpoint {
// Default type if unspecified.
NETWORK_TYPE_UNSPECIFIED = 0;

// A network hosted within Google Cloud Platform.
// A network hosted within Google Cloud.
// To receive more detailed output, specify the URI for the source or
// destination network.
GCP_NETWORK = 1;

// A network hosted outside of Google Cloud Platform.
// A network hosted outside of Google Cloud.
// This can be an on-premises network, or a network hosted by another cloud
// provider.
NON_GCP_NETWORK = 2;
Expand Down Expand Up @@ -164,8 +167,8 @@ message Endpoint {
// The Project ID can be derived from the URI if you provide a VM instance or
// network URI.
// The following are two cases where you must provide the project ID:
// 1. Only the IP address is specified, and the IP address is within a GCP
// project.
// 1. Only the IP address is specified, and the IP address is within a Google
// Cloud project.
// 2. When you are using Shared VPC and the IP address that you provide is
// from the service project. In this case, the network that the IP address
// resides in is defined in the host project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted within Google Cloud Platform.
* A network hosted within Google Cloud.
* To receive more detailed output, specify the URI for the source or
* destination network.
* </pre>
Expand All @@ -110,7 +110,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted outside of Google Cloud Platform.
* A network hosted outside of Google Cloud.
* This can be an on-premises network, or a network hosted by another cloud
* provider.
* </pre>
Expand All @@ -135,7 +135,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted within Google Cloud Platform.
* A network hosted within Google Cloud.
* To receive more detailed output, specify the URI for the source or
* destination network.
* </pre>
Expand All @@ -147,7 +147,7 @@ public enum NetworkType implements com.google.protobuf.ProtocolMessageEnum {
*
*
* <pre>
* A network hosted outside of Google Cloud Platform.
* A network hosted outside of Google Cloud.
* This can be an on-premises network, or a network hosted by another cloud
* provider.
* </pre>
Expand Down Expand Up @@ -1306,8 +1306,8 @@ public com.google.cloud.networkmanagement.v1beta1.Endpoint.NetworkType getNetwor
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -1337,8 +1337,8 @@ public java.lang.String getProjectId() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -2834,8 +2834,8 @@ public Builder clearNetworkType() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -2864,8 +2864,8 @@ public java.lang.String getProjectId() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -2894,8 +2894,8 @@ public com.google.protobuf.ByteString getProjectIdBytes() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down Expand Up @@ -2923,8 +2923,8 @@ public Builder setProjectId(java.lang.String value) {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand All @@ -2948,8 +2948,8 @@ public Builder clearProjectId() {
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ public interface EndpointOrBuilder
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand All @@ -269,8 +269,8 @@ public interface EndpointOrBuilder
* The Project ID can be derived from the URI if you provide a VM instance or
* network URI.
* The following are two cases where you must provide the project ID:
* 1. Only the IP address is specified, and the IP address is within a GCP
* project.
* 1. Only the IP address is specified, and the IP address is within a Google
* Cloud project.
* 2. When you are using Shared VPC and the IP address that you provide is
* from the service project. In this case, the network that the IP address
* resides in is defined in the host project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,12 @@ message Endpoint {
// Default type if unspecified.
NETWORK_TYPE_UNSPECIFIED = 0;

// A network hosted within Google Cloud Platform.
// A network hosted within Google Cloud.
// To receive more detailed output, specify the URI for the source or
// destination network.
GCP_NETWORK = 1;

// A network hosted outside of Google Cloud Platform.
// A network hosted outside of Google Cloud.
// This can be an on-premises network, or a network hosted by another cloud
// provider.
NON_GCP_NETWORK = 2;
Expand Down Expand Up @@ -184,8 +184,8 @@ message Endpoint {
// The Project ID can be derived from the URI if you provide a VM instance or
// network URI.
// The following are two cases where you must provide the project ID:
// 1. Only the IP address is specified, and the IP address is within a GCP
// project.
// 1. Only the IP address is specified, and the IP address is within a Google
// Cloud project.
// 2. When you are using Shared VPC and the IP address that you provide is
// from the service project. In this case, the network that the IP address
// resides in is defined in the host project.
Expand Down