Skip to content

Commit 0d9d568

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Minor formatting
docs: Add clarifications for fields in `RouteAction` message PiperOrigin-RevId: 553528820
1 parent 6f3544a commit 0d9d568

10 files changed

Lines changed: 277 additions & 202 deletions

File tree

‎google/cloud/networkservices/v1/common.proto‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -30,10 +30,12 @@ option ruby_package = "Google::Cloud::NetworkServices::V1";
3030
// Represents the metadata of the long-running operation.
3131
message OperationMetadata {
3232
// Output only. The time the operation was created.
33-
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
33+
google.protobuf.Timestamp create_time = 1
34+
[(google.api.field_behavior) = OUTPUT_ONLY];
3435

3536
// Output only. The time the operation finished running.
36-
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
37+
google.protobuf.Timestamp end_time = 2
38+
[(google.api.field_behavior) = OUTPUT_ONLY];
3739

3840
// Output only. Server-defined resource path for the target of the operation.
3941
string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -46,8 +48,9 @@ message OperationMetadata {
4648

4749
// Output only. Identifies whether the user has requested cancellation
4850
// of the operation. Operations that have successfully been cancelled
49-
// have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
50-
// corresponding to `Code.CANCELLED`.
51+
// have [Operation.error][] value with a
52+
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
53+
// `Code.CANCELLED`.
5154
bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
5255

5356
// Output only. API version used to start the operation.

‎google/cloud/networkservices/v1/endpoint_policy.proto‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -69,10 +69,12 @@ message EndpointPolicy {
6969
string name = 1 [(google.api.field_behavior) = REQUIRED];
7070

7171
// Output only. The timestamp when the resource was created.
72-
google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
72+
google.protobuf.Timestamp create_time = 2
73+
[(google.api.field_behavior) = OUTPUT_ONLY];
7374

7475
// Output only. The timestamp when the resource was updated.
75-
google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
76+
google.protobuf.Timestamp update_time = 3
77+
[(google.api.field_behavior) = OUTPUT_ONLY];
7678

7779
// Optional. Set of label tags associated with the EndpointPolicy resource.
7880
map<string, string> labels = 4 [(google.api.field_behavior) = OPTIONAL];
@@ -93,19 +95,22 @@ message EndpointPolicy {
9395
}
9496
];
9597

96-
// Required. A matcher that selects endpoints to which the policies should be applied.
98+
// Required. A matcher that selects endpoints to which the policies should be
99+
// applied.
97100
EndpointMatcher endpoint_matcher = 9 [(google.api.field_behavior) = REQUIRED];
98101

99102
// Optional. Port selector for the (matched) endpoints. If no port selector is
100103
// provided, the matched config is applied to all ports.
101-
TrafficPortSelector traffic_port_selector = 10 [(google.api.field_behavior) = OPTIONAL];
104+
TrafficPortSelector traffic_port_selector = 10
105+
[(google.api.field_behavior) = OPTIONAL];
102106

103-
// Optional. A free-text description of the resource. Max length 1024 characters.
107+
// Optional. A free-text description of the resource. Max length 1024
108+
// characters.
104109
string description = 11 [(google.api.field_behavior) = OPTIONAL];
105110

106-
// Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to
107-
// determine the authentication policy to be applied to terminate the inbound
108-
// traffic at the identified backends. If this field is not set,
111+
// Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is
112+
// used to determine the authentication policy to be applied to terminate the
113+
// inbound traffic at the identified backends. If this field is not set,
109114
// authentication is disabled(open) for this endpoint.
110115
string server_tls_policy = 12 [
111116
(google.api.field_behavior) = OPTIONAL,
@@ -114,14 +119,14 @@ message EndpointPolicy {
114119
}
115120
];
116121

117-
// Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set
118-
// to specify the authentication for traffic from the proxy to the actual
119-
// endpoints. More specifically, it is applied to the outgoing traffic from
120-
// the proxy to the endpoint. This is typically used for sidecar model where
121-
// the proxy identifies itself as endpoint to the control plane, with the
122-
// connection between sidecar and endpoint requiring authentication. If this
123-
// field is not set, authentication is disabled(open). Applicable only when
124-
// EndpointPolicyType is SIDECAR_PROXY.
122+
// Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy
123+
// can be set to specify the authentication for traffic from the proxy to the
124+
// actual endpoints. More specifically, it is applied to the outgoing traffic
125+
// from the proxy to the endpoint. This is typically used for sidecar model
126+
// where the proxy identifies itself as endpoint to the control plane, with
127+
// the connection between sidecar and endpoint requiring authentication. If
128+
// this field is not set, authentication is disabled(open). Applicable only
129+
// when EndpointPolicyType is SIDECAR_PROXY.
125130
string client_tls_policy = 13 [
126131
(google.api.field_behavior) = OPTIONAL,
127132
(google.api.resource_reference) = {
@@ -132,8 +137,8 @@ message EndpointPolicy {
132137

133138
// Request used with the ListEndpointPolicies method.
134139
message ListEndpointPoliciesRequest {
135-
// Required. The project and location from which the EndpointPolicies should be
136-
// listed, specified in the format `projects/*/locations/global`.
140+
// Required. The project and location from which the EndpointPolicies should
141+
// be listed, specified in the format `projects/*/locations/global`.
137142
string parent = 1 [
138143
(google.api.field_behavior) = REQUIRED,
139144
(google.api.resource_reference) = {
@@ -200,7 +205,8 @@ message UpdateEndpointPolicyRequest {
200205
// The fields specified in the update_mask are relative to the resource, not
201206
// the full request. A field will be overwritten if it is in the mask. If the
202207
// user does not provide a mask then all fields will be overwritten.
203-
google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = OPTIONAL];
208+
google.protobuf.FieldMask update_mask = 1
209+
[(google.api.field_behavior) = OPTIONAL];
204210

205211
// Required. Updated EndpointPolicy resource.
206212
EndpointPolicy endpoint_policy = 2 [(google.api.field_behavior) = REQUIRED];

‎google/cloud/networkservices/v1/gateway.proto‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2022 Google LLC
1+
// Copyright 2023 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -63,30 +63,33 @@ message Gateway {
6363
string self_link = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
6464

6565
// Output only. The timestamp when the resource was created.
66-
google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
66+
google.protobuf.Timestamp create_time = 2
67+
[(google.api.field_behavior) = OUTPUT_ONLY];
6768

6869
// Output only. The timestamp when the resource was updated.
69-
google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
70+
google.protobuf.Timestamp update_time = 3
71+
[(google.api.field_behavior) = OUTPUT_ONLY];
7072

7173
// Optional. Set of label tags associated with the Gateway resource.
7274
map<string, string> labels = 4 [(google.api.field_behavior) = OPTIONAL];
7375

74-
// Optional. A free-text description of the resource. Max length 1024 characters.
76+
// Optional. A free-text description of the resource. Max length 1024
77+
// characters.
7578
string description = 5 [(google.api.field_behavior) = OPTIONAL];
7679

7780
// Immutable. The type of the customer managed gateway.
7881
// This field is required. If unspecified, an error is returned.
7982
Type type = 6 [(google.api.field_behavior) = IMMUTABLE];
8083

81-
// Required. One or more ports that the Gateway must receive traffic on. The proxy binds
82-
// to the ports specified. Gateway listen on 0.0.0.0 on the ports specified
83-
// below.
84+
// Required. One or more ports that the Gateway must receive traffic on. The
85+
// proxy binds to the ports specified. Gateway listen on 0.0.0.0 on the ports
86+
// specified below.
8487
repeated int32 ports = 11 [(google.api.field_behavior) = REQUIRED];
8588

86-
// Required. Immutable. Scope determines how configuration across multiple Gateway instances are
87-
// merged. The configuration for multiple Gateway instances with the same
88-
// scope will be merged as presented as a single coniguration to the
89-
// proxy/load balancer.
89+
// Required. Immutable. Scope determines how configuration across multiple
90+
// Gateway instances are merged. The configuration for multiple Gateway
91+
// instances with the same scope will be merged as presented as a single
92+
// coniguration to the proxy/load balancer.
9093
//
9194
// Max length 64 characters.
9295
// Scope should start with a letter and can only have letters, numbers,
@@ -96,8 +99,8 @@ message Gateway {
9699
(google.api.field_behavior) = IMMUTABLE
97100
];
98101

99-
// Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS
100-
// traffic is terminated. If empty, TLS termination is disabled.
102+
// Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how
103+
// TLS traffic is terminated. If empty, TLS termination is disabled.
101104
string server_tls_policy = 9 [(google.api.field_behavior) = OPTIONAL];
102105
}
103106

@@ -169,7 +172,8 @@ message UpdateGatewayRequest {
169172
// The fields specified in the update_mask are relative to the resource, not
170173
// the full request. A field will be overwritten if it is in the mask. If the
171174
// user does not provide a mask then all fields will be overwritten.
172-
google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = OPTIONAL];
175+
google.protobuf.FieldMask update_mask = 1
176+
[(google.api.field_behavior) = OPTIONAL];
173177

174178
// Required. Updated Gateway resource.
175179
Gateway gateway = 2 [(google.api.field_behavior) = REQUIRED];

0 commit comments

Comments
 (0)