Debian Codegraph @

docs/dyn/compute_beta.networkEndpointGroups.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.networkEndpointGroups.html">networkEndpointGroups</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves the list of network endpoint groups and sorts them by zone.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Attach a list of network endpoints to the specified network endpoint group.</p>
86 <p class="toc_element">
87 <code><a href="#close">close()</a></code></p>
88 <p class="firstline">Close httplib2 connections.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(project, zone, networkEndpointGroup, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes the specified network endpoint group. The network endpoints in the</p>
92 <p class="toc_element">
93 <code><a href="#detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Detach a list of network endpoints from the specified network endpoint</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, zone, networkEndpointGroup, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified network endpoint group.</p>
98 <p class="toc_element">
99 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Creates a network endpoint group in the specified project using the</p>
101 <p class="toc_element">
102 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Retrieves the list of network endpoint groups that are located in the</p>
104 <p class="toc_element">
105 <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Lists the network endpoints in the specified network endpoint group.</p>
107 <p class="toc_element">
108 <code><a href="#listNetworkEndpoints_next">listNetworkEndpoints_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#list_next">list_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <h3>Method Details</h3>
117 <div class="method">
118 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
119 <pre>Retrieves the list of network endpoint groups and sorts them by zone.
120
121 To prevent failure, Google recommends that you set the
122 `returnPartialSuccess` parameter to `true`.
123
124 Args:
125 project: string, Project ID for this request. (required)
126 filter: string, A filter expression that filters resources listed in the response. Most
127 Compute resources support two types of filter expressions:
128 expressions that support regular expressions and expressions that follow
129 API improvement proposal AIP-160.
130 These two types of filter expressions cannot be mixed in one request.
131
132 If you want to use AIP-160, your expression must specify the field name, an
133 operator, and the value that you want to use for filtering. The value
134 must be a string, a number, or a boolean. The operator
135 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
136
137 For example, if you are filtering Compute Engine instances, you can
138 exclude instances named `example-instance` by specifying
139 `name != example-instance`.
140
141 The `:*` comparison can be used to test whether a key has been defined.
142 For example, to find all objects with `owner` label use:
143 ```
144 labels.owner:*
145 ```
146
147 You can also filter nested fields. For example, you could specify
148 `scheduling.automaticRestart = false` to include instances only
149 if they are not scheduled for automatic restarts. You can use filtering
150 on nested fields to filter based onresource labels.
151
152 To filter on multiple expressions, provide each separate expression within
153 parentheses. For example:
154 ```
155 (scheduling.automaticRestart = true)
156 (cpuPlatform = &quot;Intel Skylake&quot;)
157 ```
158 By default, each expression is an `AND` expression. However, you
159 can include `AND` and `OR` expressions explicitly.
160 For example:
161 ```
162 (cpuPlatform = &quot;Intel Skylake&quot;) OR
163 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
164 (scheduling.automaticRestart = true)
165 ```
166
167 If you want to use a regular expression, use the `eq` (equal) or `ne`
168 (not equal) operator against a single un-parenthesized expression with or
169 without quotes or against multiple parenthesized expressions. Examples:
170
171 `fieldname eq unquoted literal`
172 `fieldname eq &#x27;single quoted literal&#x27;`
173 `fieldname eq &quot;double quoted literal&quot;`
174 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
175
176 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
177 The literal value must match the entire field.
178
179 For example, to filter for instances that do not end with name &quot;instance&quot;,
180 you would use `name ne .*instance`.
181
182 You cannot combine constraints on multiple fields using regular
183 expressions.
184 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
185 global) should be included in the response. For new resource types added
186 after this field, the flag has no effect as new resource types will always
187 include every visible scope for each scope type in response. For resource
188 types which predate this field, if this flag is omitted or false, only
189 scopes of the scope types where the resource type is expected to be found
190 will be included.
191 maxResults: integer, The maximum number of results per page that should be returned.
192 If the number of available results is larger than `maxResults`,
193 Compute Engine returns a `nextPageToken` that can be used to get
194 the next page of results in subsequent list requests. Acceptable values are
195 `0` to `500`, inclusive. (Default: `500`)
196 orderBy: string, Sorts list results by a certain order. By default, results
197 are returned in alphanumerical order based on the resource name.
198
199 You can also sort results in descending order based on the creation
200 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
201 results based on the `creationTimestamp` field in
202 reverse chronological order (newest result first). Use this to sort
203 resources like operations so that the newest operation is returned first.
204
205 Currently, only sorting by `name` or
206 `creationTimestamp desc` is supported.
207 pageToken: string, Specifies a page token to use. Set `pageToken` to the
208 `nextPageToken` returned by a previous list request to get
209 the next page of results.
210 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
211 of failure. The default value is false.
212
213 For example, when partial success behavior is enabled, aggregatedList for a
214 single zone scope either returns all resources in the zone or no resources,
215 with an error code.
216 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
217 aggregated list request is invoked for subnetworks list-usable api.
218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223 Returns:
224 An object of the form:
225
226 {
227 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
228 &quot;items&quot;: { # A list of NetworkEndpointGroupsScopedList resources.
229 &quot;a_key&quot;: { # The name of the scope that contains this set of network endpoint groups.
230 &quot;networkEndpointGroups&quot;: [ # Output only. [Output Only] The list ofnetwork
231 # endpoint groups that are contained in this scope.
232 { # Represents a collection of network endpoints.
233 #
234 # A network endpoint group (NEG) defines how a set of endpoints should be
235 # reached, whether they are reachable, and where they are located.
236 # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
237 #
238 # Note: Use the following APIs to manage network endpoint groups:
239 #
240 # -
241 # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
242 # NEGs): zonal
243 # API
244 # -
245 # To manage NEGs with regional scope (such as regional internet NEGs,
246 # serverless NEGs, Private Service Connect NEGs): regional
247 # API
248 # -
249 # To manage NEGs with global scope (such as global internet NEGs):global
250 # API
251 &quot;annotations&quot;: { # Optional. Metadata defined as annotations on the network endpoint group.
252 &quot;a_key&quot;: &quot;A String&quot;,
253 },
254 &quot;appEngine&quot;: { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
255 # The service is optional, may be provided explicitly or in the
256 # URL mask. The version is optional and can only be provided
257 # explicitly or in the URL mask when service is present.
258 #
259 # Note: App Engine service must be in the same project and located in the
260 # same region as the Serverless NEG.
261 &quot;service&quot;: &quot;A String&quot;, # Optional serving service.
262 #
263 # The service name is case-sensitive and must be 1-63
264 # characters long.
265 #
266 # Example value: default, my-service.
267 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
268 # mask is one of the main components of the Cloud Function.
269 #
270 # A template to parse service and version fields
271 # from a request URL. URL mask allows for routing to multiple App Engine
272 # services without having to create multiple Network Endpoint Groups and
273 # backend services.
274 #
275 # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same
276 # Serverless NEG with URL mask&lt;service&gt;-dot-appname.appspot.com/&lt;version&gt;.
277 # The URL mask will parse them to { service = &quot;foo1&quot;, version = &quot;v1&quot;
278 # } and { service = &quot;foo1&quot;, version = &quot;v2&quot; }
279 # respectively.
280 &quot;version&quot;: &quot;A String&quot;, # Optional serving version.
281 #
282 # The version name is case-sensitive and must be 1-100
283 # characters long.
284 #
285 # Example value: v1, v2.
286 },
287 &quot;cloudFunction&quot;: { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
288 # The function must be provided explicitly or in the URL mask.
289 #
290 # Note: Cloud Function must be in the same project and located in the same
291 # region as the Serverless NEG.
292 &quot;function&quot;: &quot;A String&quot;, # A user-defined name of the Cloud Function.
293 #
294 # The function name is case-sensitive and must be 1-63
295 # characters long.
296 #
297 # Example value: func1.
298 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
299 # mask is one of the main components of the Cloud Function.
300 #
301 # A template to parse function field from a request URL. URL
302 # mask allows for routing to multiple Cloud Functions without having to
303 # create multiple Network Endpoint Groups and backend services.
304 #
305 # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same
306 # Serverless NEG with URL mask /&lt;function&gt;. The URL
307 # mask will parse them to { function = &quot;function1&quot; } and{ function = &quot;function2&quot; } respectively.
308 },
309 &quot;cloudRun&quot;: { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
310 # The service must be provided explicitly or in the URL mask.
311 # The tag is optional, may be provided explicitly or in the URL
312 # mask.
313 #
314 # Note: Cloud Run service must be in the same project and located in the same
315 # region as the Serverless NEG.
316 &quot;service&quot;: &quot;A String&quot;, # Cloud Run service is the main resource of Cloud Run.
317 #
318 # The service must be 1-63 characters long, and comply withRFC1035.
319 #
320 # Example value: &quot;run-service&quot;.
321 &quot;tag&quot;: &quot;A String&quot;, # Optional Cloud Run tag represents the &quot;named-revision&quot; to provide additional
322 # fine-grained traffic routing information.
323 #
324 # The tag must be 1-63 characters long, and comply withRFC1035.
325 #
326 # Example value: &quot;revision-0010&quot;.
327 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
328 # mask is one of the main components of the Cloud Function.
329 #
330 # A template to parse &lt;service&gt; and&lt;tag&gt; fields from a request URL. URL mask allows for
331 # routing to multiple Run services without having to create multiple
332 # network endpoint groups and backend services.
333 #
334 # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless
335 # Network Endpoint Group (NEG) with URL mask&lt;tag&gt;.domain.com/&lt;service&gt;. The URL mask will
336 # parse them to { service=&quot;bar1&quot;, tag=&quot;foo1&quot; } and {
337 # service=&quot;bar2&quot;, tag=&quot;foo2&quot; } respectively.
338 },
339 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
340 # text format.
341 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
342 # endpoint.
343 #
344 # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
345 # field must not be specified.
346 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
347 # create the resource.
348 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
349 # defined by the server.
350 &quot;kind&quot;: &quot;compute#networkEndpointGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.
351 &quot;loadBalancer&quot;: { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load
352 # balancing.
353 # [Deprecated] This field is deprecated.
354 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
355 # endpoint.
356 #
357 # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
358 # field must not be specified.
359 # [Deprecated] This field is deprecated.
360 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
361 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
362 # if this field is not specified, a default network will be used.
363 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
364 # global NEGs.
365 # For all other network endpoint types, this field is required.
366 # [Deprecated] This field is deprecated.
367 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
368 # belong.
369 # [Deprecated] This field is deprecated.
370 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
371 # where the network endpoint group is located.
372 # [Deprecated] This field is deprecated.
373 },
374 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
375 # The name must be 1-63 characters long, and comply withRFC1035.
376 # Specifically, the name must be 1-63 characters long and match the regular
377 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
378 # character must be a lowercase letter, and all following characters must be
379 # a dash, lowercase letter, or digit, except the last character, which cannot
380 # be a dash.
381 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
382 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
383 # if this field is not specified, a default network will be used.
384 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
385 # global NEGs.
386 # For all other network endpoint types, this field is required.
387 &quot;networkEndpointType&quot;: &quot;A String&quot;, # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.
388 &quot;pscData&quot;: { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
389 # type PRIVATE_SERVICE_CONNECT.
390 &quot;consumerPscAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] Address allocated from given subnetwork for PSC. This IP
391 # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in
392 # L7 PSC-XLB.
393 &quot;producerPort&quot;: 42, # The psc producer port is used to connect PSC NEG with specific port on
394 # the PSC Producer side; should only be used for the
395 # PRIVATE_SERVICE_CONNECT NEG type
396 &quot;pscConnectionId&quot;: &quot;A String&quot;, # Output only. [Output Only] The PSC connection id of the PSC Network Endpoint Group
397 # Consumer.
398 &quot;pscConnectionStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The connection status of the PSC Forwarding Rule.
399 },
400 &quot;pscTargetService&quot;: &quot;A String&quot;, # The target service url used to set up private service connection to
401 # a Google API or a PSC Producer Service Attachment.
402 # An example value is: asia-northeast3-cloudkms.googleapis.com.
403 #
404 # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
405 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
406 # where the network endpoint group is located.
407 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
408 &quot;serverlessDeployment&quot;: { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set.
409 #
410 # Note: The target backend service must be in the same project and located in
411 # the same region as the Serverless NEG.
412 &quot;platform&quot;: &quot;A String&quot;, # The platform of the backend target(s) of this NEG.
413 # The only supported value is
414 # API Gateway: apigateway.googleapis.com.
415 &quot;resource&quot;: &quot;A String&quot;, # The user-defined name of the workload/instance. This value must be
416 # provided explicitly or in the urlMask. The resource
417 # identified by this value is platform-specific and is as follows:
418 #
419 #
420 #
421 # 1. API Gateway: The gateway ID
422 # 2. App Engine: The service name
423 # 3. Cloud Functions: The function name
424 # 4. Cloud Run: The service name
425 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
426 # mask is one of the main components of the Cloud Function.
427 #
428 # A template to parse platform-specific fields from a request URL. URL mask
429 # allows for routing to multiple resources on the same serverless platform
430 # without having to create multiple Network Endpoint Groups and backend
431 # resources. The fields parsed by this template are platform-specific and
432 # are as follows:
433 #
434 #
435 #
436 # 1. API Gateway: The gateway ID
437 # 2. App Engine: The service and version
438 # 3. Cloud Functions: The function name
439 # 4. Cloud Run: The service and tag
440 &quot;version&quot;: &quot;A String&quot;, # The optional resource version. The version identified by this value is
441 # platform-specific and is follows:
442 #
443 #
444 #
445 # 1. API Gateway: Unused
446 # 2. App Engine: The service version
447 # 3. Cloud Functions: Unused
448 # 4. Cloud Run: The service tag
449 },
450 &quot;size&quot;: 42, # Output only. [Output only] Number of network endpoints in the network endpoint group.
451 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
452 # belong.
453 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
454 # where the network endpoint group is located.
455 },
456 ],
457 &quot;warning&quot;: { # Output only. [Output Only] An informational warning that replaces the list of network
458 # endpoint groups when the list is empty.
459 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
460 # Engine returns NO_RESULTS_ON_PAGE if there
461 # are no results in the response.
462 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
463 # value format. For example:
464 #
465 # &quot;data&quot;: [
466 # {
467 # &quot;key&quot;: &quot;scope&quot;,
468 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
469 # }
470 {
471 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
472 # returned. For example, for warnings where there are no results in a list
473 # request for a particular zone, this key might be scope and
474 # the key value might be the zone name. Other examples might be a key
475 # indicating a deprecated resource and a suggested replacement, or a
476 # warning about invalid network settings (for example, if an instance
477 # attempts to perform IP forwarding but is not enabled for IP forwarding).
478 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
479 },
480 ],
481 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
482 },
483 },
484 },
485 &quot;kind&quot;: &quot;compute#networkEndpointGroupAggregatedList&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupAggregatedList for aggregated
486 # lists of network endpoint groups.
487 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
488 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
489 # the query parameter pageToken in the next list request.
490 # Subsequent list requests will have their own nextPageToken to
491 # continue paging through the results.
492 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
493 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
494 &quot;A String&quot;,
495 ],
496 &quot;warning&quot;: { # [Output Only] Informational warning message.
497 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
498 # Engine returns NO_RESULTS_ON_PAGE if there
499 # are no results in the response.
500 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
501 # value format. For example:
502 #
503 # &quot;data&quot;: [
504 # {
505 # &quot;key&quot;: &quot;scope&quot;,
506 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
507 # }
508 {
509 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
510 # returned. For example, for warnings where there are no results in a list
511 # request for a particular zone, this key might be scope and
512 # the key value might be the zone name. Other examples might be a key
513 # indicating a deprecated resource and a suggested replacement, or a
514 # warning about invalid network settings (for example, if an instance
515 # attempts to perform IP forwarding but is not enabled for IP forwarding).
516 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
517 },
518 ],
519 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
520 },
521 }</pre>
522 </div>
523
524 <div class="method">
525 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
526 <pre>Retrieves the next page of results.
527
528 Args:
529 previous_request: The request for the previous page. (required)
530 previous_response: The response from the request for the previous page. (required)
531
532 Returns:
533 A request object that you can call &#x27;execute()&#x27; on to request the next
534 page. Returns None if there are no more items in the collection.
535 </pre>
536 </div>
537
538 <div class="method">
539 <code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</code>
540 <pre>Attach a list of network endpoints to the specified network endpoint group.
541
542 Args:
543 project: string, Project ID for this request. (required)
544 zone: string, The name of the zone where
545 the network endpoint group is located. It should comply with RFC1035. (required)
546 networkEndpointGroup: string, The name of the network endpoint group where you are attaching network
547 endpoints to. It should comply with RFC1035. (required)
548 body: object, The request body.
549 The object takes the form of:
550
551 {
552 &quot;networkEndpoints&quot;: [ # The list of network endpoints to be attached.
553 { # The network endpoint.
554 &quot;annotations&quot;: { # Optional metadata defined as annotations on the network endpoint.
555 &quot;a_key&quot;: &quot;A String&quot;,
556 },
557 &quot;clientDestinationPort&quot;: 42, # Represents the port number to which PSC consumer sends packets.
558 #
559 # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type.
560 &quot;fqdn&quot;: &quot;A String&quot;, # Optional fully qualified domain name of network endpoint. This can only be
561 # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT.
562 &quot;instance&quot;: &quot;A String&quot;, # The name or a URL of VM instance of this network endpoint.
563 # Optional, the field presence depends on the network endpoint type. The
564 # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT.
565 #
566 # The instance must be in the same zone of network endpoint group (for zonal
567 # NEGs) or in the zone within the region of the NEG (for regional NEGs).
568 # If the ipAddress is specified, it must belongs to the VM
569 # instance.
570 #
571 # The name must be 1-63 characters long, and comply withRFC1035
572 # or be a valid URL pointing to an existing instance.
573 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional IPv4 address of network endpoint. The IP address must belong to a
574 # VM in Compute Engine (either the primary IP or as part of an aliased IP
575 # range). If the IP address is not specified, then the primary IP address for
576 # the VM instance in the network that the network endpoint group belongs to
577 # will be used.
578 #
579 # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP
580 # address of the attached VM instance that matches the subnetwork of the NEG.
581 # The primary internal IP address from any NIC of a multi-NIC VM instance can
582 # be added to a NEG as long as it matches the NEG subnetwork.
583 &quot;ipv6Address&quot;: &quot;A String&quot;, # Optional IPv6 address of network endpoint.
584 &quot;port&quot;: 42, # Optional port number of network endpoint. If not specified, the
585 # defaultPort for the network endpoint group will be used.
586 #
587 # This field can not be set for network endpoints of typeGCE_VM_IP.
588 },
589 ],
590 }
591
592 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
593 that if you must retry your request, the server will know to ignore the
594 request if it has already been completed.
595
596 For example, consider a situation where you make an initial request and
597 the request times out. If you make the request again with the same
598 request ID, the server can check if original operation with the same
599 request ID was received, and if so, will ignore the second request. This
600 prevents clients from accidentally creating duplicate commitments.
601
602 The request ID must be
603 a valid UUID with the exception that zero UUID is not supported
604 (00000000-0000-0000-0000-000000000000).
605 x__xgafv: string, V1 error format.
606 Allowed values
607 1 - v1 error format
608 2 - v2 error format
609
610 Returns:
611 An object of the form:
612
613 { # Represents an Operation resource.
614 #
615 # Google Compute Engine has three Operation resources:
616 #
617 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
618 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
619 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
620 #
621 # You can use an operation resource to manage asynchronous API requests.
622 # For more information, readHandling
623 # API responses.
624 #
625 # Operations can be global, regional or zonal.
626 #
627 # - For global operations, use the `globalOperations`
628 # resource.
629 # - For regional operations, use the
630 # `regionOperations` resource.
631 # - For zonal operations, use
632 # the `zoneOperations` resource.
633 #
634 #
635 #
636 # For more information, read
637 # Global, Regional, and Zonal Resources.
638 #
639 # Note that completed Operation resources have a limited
640 # retention period.
641 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
642 # Not present otherwise.
643 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
644 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
645 # set when the operation is created.
646 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
647 # text format.
648 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
649 # this field will be populated.
650 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
651 # operation.
652 {
653 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
654 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
655 # details. There is a set of defined message types to use for providing
656 # details.The syntax depends on the error code. For example,
657 # QuotaExceededInfo will have details when the error code is
658 # QUOTA_EXCEEDED.
659 {
660 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
661 #
662 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
663 # is not enabled:
664 #
665 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
666 # &quot;domain&quot;: &quot;googleapis.com&quot;
667 # &quot;metadata&quot;: {
668 # &quot;resource&quot;: &quot;projects/123&quot;,
669 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
670 # }
671 # }
672 #
673 # This response indicates that the pubsub.googleapis.com API is not enabled.
674 #
675 # Example of an error that is returned when attempting to create a Spanner
676 # instance in a region that is out of stock:
677 #
678 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
679 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
680 # &quot;metadata&quot;: {
681 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
682 # }
683 # }
684 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
685 # is typically the registered service name of the tool or product that
686 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
687 # generated by some common infrastructure, the error domain must be a
688 # globally unique value that identifies the infrastructure. For Google API
689 # infrastructure, the error domain is &quot;googleapis.com&quot;.
690 &quot;metadatas&quot;: { # Additional structured details about this error.
691 #
692 # Keys must match a regular expression of `a-z+` but should
693 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
694 # length. When identifying the current value of an exceeded limit, the units
695 # should be contained in the key, not the value. For example, rather than
696 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
697 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
698 # instances that can be created in a single (batch) request.
699 &quot;a_key&quot;: &quot;A String&quot;,
700 },
701 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
702 # proximate cause of the error. Error reasons are unique within a particular
703 # domain of errors. This should be at most 63 characters and match a
704 # regular expression of `A-Z+[A-Z0-9]`, which represents
705 # UPPER_SNAKE_CASE.
706 },
707 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
708 #
709 # For example, if a quota check failed with an error indicating the calling
710 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
711 # directly to the right place in the developer console to flip the bit.
712 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
713 { # Describes a URL link.
714 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
715 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
716 },
717 ],
718 },
719 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
720 # which can be attached to an RPC error.
721 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
722 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
723 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
724 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
725 },
726 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
727 &quot;dimensions&quot;: { # The map holding related quota dimensions.
728 &quot;a_key&quot;: &quot;A String&quot;,
729 },
730 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
731 # type or metric.
732 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
733 # or metric.
734 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
735 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
736 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
737 },
738 },
739 ],
740 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
741 # This property is optional.
742 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
743 },
744 ],
745 },
746 &quot;getVersionOperationMetadata&quot;: {
747 &quot;inlineSbomInfo&quot;: {
748 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
749 # appropriate identifiers.
750 &quot;a_key&quot;: &quot;A String&quot;,
751 },
752 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
753 # identifiers.
754 &quot;a_key&quot;: &quot;A String&quot;,
755 },
756 },
757 },
758 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
759 # message that was returned, such as `NOT FOUND`.
760 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
761 # status code that was returned. For example, a `404` means the
762 # resource was not found.
763 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
764 # defined by the server.
765 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
766 # This value is inRFC3339
767 # text format.
768 &quot;instancesBulkInsertOperationMetadata&quot;: {
769 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
770 # Example key: zones/us-central1-a
771 &quot;a_key&quot;: {
772 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
773 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
774 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
775 # error.
776 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
777 # if the flow is rolling forward or rolling back.
778 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
779 },
780 },
781 },
782 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
783 # Operation resources.
784 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
785 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
786 # group of operations results from a `bulkInsert` API request.
787 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
788 # `update`, or `delete`, and so on.
789 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
790 # There is no requirement that this be linear or support any granularity of
791 # operations. This should not be used to guess when the operation will be
792 # complete. This number should monotonically increase as the operation
793 # progresses.
794 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
795 # applicable when performing regional operations.
796 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
797 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
798 # this field will contain information on all underlying zonal actions and
799 # their state.
800 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
801 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
802 # Example key: zones/us-central1-a
803 &quot;a_key&quot;: {
804 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
805 # populated.
806 # different programming environments, including REST APIs and RPC APIs. It is
807 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
808 # three pieces of data: error code, error message, and error details.
809 #
810 # You can find out more about this error model and how to work with it in the
811 # [API Design Guide](https://cloud.google.com/apis/design/errors).
812 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
813 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
814 # message types for APIs to use.
815 {
816 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
817 },
818 ],
819 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
820 # user-facing error message should be localized and sent in the
821 # google.rpc.Status.details field, or localized by the client.
822 },
823 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
824 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
825 },
826 },
827 },
828 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
829 # This value is inRFC3339
830 # text format.
831 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
832 # following:
833 # `PENDING`, `RUNNING`, or `DONE`.
834 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
835 # operation.
836 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
837 # of the target resource.
838 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
839 # operations related to creating a snapshot, this points to the disk
840 # that the snapshot was created from.
841 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
842 # `[email protected]` or
843 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
844 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
845 # operation, this field will be populated.
846 {
847 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
848 # Engine returns NO_RESULTS_ON_PAGE if there
849 # are no results in the response.
850 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
851 # value format. For example:
852 #
853 # &quot;data&quot;: [
854 # {
855 # &quot;key&quot;: &quot;scope&quot;,
856 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
857 # }
858 {
859 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
860 # returned. For example, for warnings where there are no results in a list
861 # request for a particular zone, this key might be scope and
862 # the key value might be the zone name. Other examples might be a key
863 # indicating a deprecated resource and a suggested replacement, or a
864 # warning about invalid network settings (for example, if an instance
865 # attempts to perform IP forwarding but is not enabled for IP forwarding).
866 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
867 },
868 ],
869 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
870 },
871 ],
872 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
873 # applicable when performing per-zone operations.
874 }</pre>
875 </div>
876
877 <div class="method">
878 <code class="details" id="close">close()</code>
879 <pre>Close httplib2 connections.</pre>
880 </div>
881
882 <div class="method">
883 <code class="details" id="delete">delete(project, zone, networkEndpointGroup, requestId=None, x__xgafv=None)</code>
884 <pre>Deletes the specified network endpoint group. The network endpoints in the
885 NEG and the VM instances they belong to are not terminated when the NEG is
886 deleted. Note that the NEG cannot be deleted if there are backend services
887 referencing it.
888
889 Args:
890 project: string, Project ID for this request. (required)
891 zone: string, The name of the zone where
892 the network endpoint group is located. It should comply with RFC1035. (required)
893 networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with
894 RFC1035. (required)
895 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
896 that if you must retry your request, the server will know to ignore the
897 request if it has already been completed.
898
899 For example, consider a situation where you make an initial request and
900 the request times out. If you make the request again with the same
901 request ID, the server can check if original operation with the same
902 request ID was received, and if so, will ignore the second request. This
903 prevents clients from accidentally creating duplicate commitments.
904
905 The request ID must be
906 a valid UUID with the exception that zero UUID is not supported
907 (00000000-0000-0000-0000-000000000000).
908 x__xgafv: string, V1 error format.
909 Allowed values
910 1 - v1 error format
911 2 - v2 error format
912
913 Returns:
914 An object of the form:
915
916 { # Represents an Operation resource.
917 #
918 # Google Compute Engine has three Operation resources:
919 #
920 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
921 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
922 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
923 #
924 # You can use an operation resource to manage asynchronous API requests.
925 # For more information, readHandling
926 # API responses.
927 #
928 # Operations can be global, regional or zonal.
929 #
930 # - For global operations, use the `globalOperations`
931 # resource.
932 # - For regional operations, use the
933 # `regionOperations` resource.
934 # - For zonal operations, use
935 # the `zoneOperations` resource.
936 #
937 #
938 #
939 # For more information, read
940 # Global, Regional, and Zonal Resources.
941 #
942 # Note that completed Operation resources have a limited
943 # retention period.
944 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
945 # Not present otherwise.
946 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
947 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
948 # set when the operation is created.
949 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
950 # text format.
951 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
952 # this field will be populated.
953 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
954 # operation.
955 {
956 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
957 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
958 # details. There is a set of defined message types to use for providing
959 # details.The syntax depends on the error code. For example,
960 # QuotaExceededInfo will have details when the error code is
961 # QUOTA_EXCEEDED.
962 {
963 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
964 #
965 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
966 # is not enabled:
967 #
968 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
969 # &quot;domain&quot;: &quot;googleapis.com&quot;
970 # &quot;metadata&quot;: {
971 # &quot;resource&quot;: &quot;projects/123&quot;,
972 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
973 # }
974 # }
975 #
976 # This response indicates that the pubsub.googleapis.com API is not enabled.
977 #
978 # Example of an error that is returned when attempting to create a Spanner
979 # instance in a region that is out of stock:
980 #
981 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
982 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
983 # &quot;metadata&quot;: {
984 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
985 # }
986 # }
987 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
988 # is typically the registered service name of the tool or product that
989 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
990 # generated by some common infrastructure, the error domain must be a
991 # globally unique value that identifies the infrastructure. For Google API
992 # infrastructure, the error domain is &quot;googleapis.com&quot;.
993 &quot;metadatas&quot;: { # Additional structured details about this error.
994 #
995 # Keys must match a regular expression of `a-z+` but should
996 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
997 # length. When identifying the current value of an exceeded limit, the units
998 # should be contained in the key, not the value. For example, rather than
999 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1000 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1001 # instances that can be created in a single (batch) request.
1002 &quot;a_key&quot;: &quot;A String&quot;,
1003 },
1004 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1005 # proximate cause of the error. Error reasons are unique within a particular
1006 # domain of errors. This should be at most 63 characters and match a
1007 # regular expression of `A-Z+[A-Z0-9]`, which represents
1008 # UPPER_SNAKE_CASE.
1009 },
1010 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1011 #
1012 # For example, if a quota check failed with an error indicating the calling
1013 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1014 # directly to the right place in the developer console to flip the bit.
1015 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1016 { # Describes a URL link.
1017 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1018 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1019 },
1020 ],
1021 },
1022 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1023 # which can be attached to an RPC error.
1024 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1025 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1026 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1027 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1028 },
1029 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1030 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1031 &quot;a_key&quot;: &quot;A String&quot;,
1032 },
1033 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1034 # type or metric.
1035 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1036 # or metric.
1037 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1038 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1039 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1040 },
1041 },
1042 ],
1043 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1044 # This property is optional.
1045 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1046 },
1047 ],
1048 },
1049 &quot;getVersionOperationMetadata&quot;: {
1050 &quot;inlineSbomInfo&quot;: {
1051 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1052 # appropriate identifiers.
1053 &quot;a_key&quot;: &quot;A String&quot;,
1054 },
1055 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1056 # identifiers.
1057 &quot;a_key&quot;: &quot;A String&quot;,
1058 },
1059 },
1060 },
1061 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1062 # message that was returned, such as `NOT FOUND`.
1063 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1064 # status code that was returned. For example, a `404` means the
1065 # resource was not found.
1066 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1067 # defined by the server.
1068 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1069 # This value is inRFC3339
1070 # text format.
1071 &quot;instancesBulkInsertOperationMetadata&quot;: {
1072 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1073 # Example key: zones/us-central1-a
1074 &quot;a_key&quot;: {
1075 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1076 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1077 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1078 # error.
1079 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1080 # if the flow is rolling forward or rolling back.
1081 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1082 },
1083 },
1084 },
1085 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1086 # Operation resources.
1087 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1088 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1089 # group of operations results from a `bulkInsert` API request.
1090 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1091 # `update`, or `delete`, and so on.
1092 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1093 # There is no requirement that this be linear or support any granularity of
1094 # operations. This should not be used to guess when the operation will be
1095 # complete. This number should monotonically increase as the operation
1096 # progresses.
1097 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1098 # applicable when performing regional operations.
1099 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1100 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1101 # this field will contain information on all underlying zonal actions and
1102 # their state.
1103 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1104 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1105 # Example key: zones/us-central1-a
1106 &quot;a_key&quot;: {
1107 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1108 # populated.
1109 # different programming environments, including REST APIs and RPC APIs. It is
1110 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1111 # three pieces of data: error code, error message, and error details.
1112 #
1113 # You can find out more about this error model and how to work with it in the
1114 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1115 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1116 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1117 # message types for APIs to use.
1118 {
1119 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1120 },
1121 ],
1122 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1123 # user-facing error message should be localized and sent in the
1124 # google.rpc.Status.details field, or localized by the client.
1125 },
1126 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1127 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1128 },
1129 },
1130 },
1131 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1132 # This value is inRFC3339
1133 # text format.
1134 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1135 # following:
1136 # `PENDING`, `RUNNING`, or `DONE`.
1137 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1138 # operation.
1139 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1140 # of the target resource.
1141 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1142 # operations related to creating a snapshot, this points to the disk
1143 # that the snapshot was created from.
1144 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1145 # `[email protected]` or
1146 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1147 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1148 # operation, this field will be populated.
1149 {
1150 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1151 # Engine returns NO_RESULTS_ON_PAGE if there
1152 # are no results in the response.
1153 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1154 # value format. For example:
1155 #
1156 # &quot;data&quot;: [
1157 # {
1158 # &quot;key&quot;: &quot;scope&quot;,
1159 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1160 # }
1161 {
1162 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1163 # returned. For example, for warnings where there are no results in a list
1164 # request for a particular zone, this key might be scope and
1165 # the key value might be the zone name. Other examples might be a key
1166 # indicating a deprecated resource and a suggested replacement, or a
1167 # warning about invalid network settings (for example, if an instance
1168 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1169 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1170 },
1171 ],
1172 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1173 },
1174 ],
1175 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1176 # applicable when performing per-zone operations.
1177 }</pre>
1178 </div>
1179
1180 <div class="method">
1181 <code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</code>
1182 <pre>Detach a list of network endpoints from the specified network endpoint
1183 group.
1184
1185 Args:
1186 project: string, Project ID for this request. (required)
1187 zone: string, The name of the zone where
1188 the network endpoint group is located. It should comply with RFC1035. (required)
1189 networkEndpointGroup: string, The name of the network endpoint group where you are removing network
1190 endpoints. It should comply with RFC1035. (required)
1191 body: object, The request body.
1192 The object takes the form of:
1193
1194 {
1195 &quot;networkEndpoints&quot;: [ # The list of network endpoints to be detached.
1196 { # The network endpoint.
1197 &quot;annotations&quot;: { # Optional metadata defined as annotations on the network endpoint.
1198 &quot;a_key&quot;: &quot;A String&quot;,
1199 },
1200 &quot;clientDestinationPort&quot;: 42, # Represents the port number to which PSC consumer sends packets.
1201 #
1202 # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type.
1203 &quot;fqdn&quot;: &quot;A String&quot;, # Optional fully qualified domain name of network endpoint. This can only be
1204 # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT.
1205 &quot;instance&quot;: &quot;A String&quot;, # The name or a URL of VM instance of this network endpoint.
1206 # Optional, the field presence depends on the network endpoint type. The
1207 # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT.
1208 #
1209 # The instance must be in the same zone of network endpoint group (for zonal
1210 # NEGs) or in the zone within the region of the NEG (for regional NEGs).
1211 # If the ipAddress is specified, it must belongs to the VM
1212 # instance.
1213 #
1214 # The name must be 1-63 characters long, and comply withRFC1035
1215 # or be a valid URL pointing to an existing instance.
1216 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional IPv4 address of network endpoint. The IP address must belong to a
1217 # VM in Compute Engine (either the primary IP or as part of an aliased IP
1218 # range). If the IP address is not specified, then the primary IP address for
1219 # the VM instance in the network that the network endpoint group belongs to
1220 # will be used.
1221 #
1222 # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP
1223 # address of the attached VM instance that matches the subnetwork of the NEG.
1224 # The primary internal IP address from any NIC of a multi-NIC VM instance can
1225 # be added to a NEG as long as it matches the NEG subnetwork.
1226 &quot;ipv6Address&quot;: &quot;A String&quot;, # Optional IPv6 address of network endpoint.
1227 &quot;port&quot;: 42, # Optional port number of network endpoint. If not specified, the
1228 # defaultPort for the network endpoint group will be used.
1229 #
1230 # This field can not be set for network endpoints of typeGCE_VM_IP.
1231 },
1232 ],
1233 }
1234
1235 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1236 that if you must retry your request, the server will know to ignore the
1237 request if it has already been completed.
1238
1239 For example, consider a situation where you make an initial request and
1240 the request times out. If you make the request again with the same
1241 request ID, the server can check if original operation with the same
1242 request ID was received, and if so, will ignore the second request. This
1243 prevents clients from accidentally creating duplicate commitments.
1244
1245 The request ID must be
1246 a valid UUID with the exception that zero UUID is not supported
1247 (00000000-0000-0000-0000-000000000000).
1248 x__xgafv: string, V1 error format.
1249 Allowed values
1250 1 - v1 error format
1251 2 - v2 error format
1252
1253 Returns:
1254 An object of the form:
1255
1256 { # Represents an Operation resource.
1257 #
1258 # Google Compute Engine has three Operation resources:
1259 #
1260 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1261 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1262 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1263 #
1264 # You can use an operation resource to manage asynchronous API requests.
1265 # For more information, readHandling
1266 # API responses.
1267 #
1268 # Operations can be global, regional or zonal.
1269 #
1270 # - For global operations, use the `globalOperations`
1271 # resource.
1272 # - For regional operations, use the
1273 # `regionOperations` resource.
1274 # - For zonal operations, use
1275 # the `zoneOperations` resource.
1276 #
1277 #
1278 #
1279 # For more information, read
1280 # Global, Regional, and Zonal Resources.
1281 #
1282 # Note that completed Operation resources have a limited
1283 # retention period.
1284 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1285 # Not present otherwise.
1286 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1287 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1288 # set when the operation is created.
1289 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1290 # text format.
1291 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1292 # this field will be populated.
1293 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1294 # operation.
1295 {
1296 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1297 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1298 # details. There is a set of defined message types to use for providing
1299 # details.The syntax depends on the error code. For example,
1300 # QuotaExceededInfo will have details when the error code is
1301 # QUOTA_EXCEEDED.
1302 {
1303 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1304 #
1305 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1306 # is not enabled:
1307 #
1308 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1309 # &quot;domain&quot;: &quot;googleapis.com&quot;
1310 # &quot;metadata&quot;: {
1311 # &quot;resource&quot;: &quot;projects/123&quot;,
1312 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1313 # }
1314 # }
1315 #
1316 # This response indicates that the pubsub.googleapis.com API is not enabled.
1317 #
1318 # Example of an error that is returned when attempting to create a Spanner
1319 # instance in a region that is out of stock:
1320 #
1321 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1322 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1323 # &quot;metadata&quot;: {
1324 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1325 # }
1326 # }
1327 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1328 # is typically the registered service name of the tool or product that
1329 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1330 # generated by some common infrastructure, the error domain must be a
1331 # globally unique value that identifies the infrastructure. For Google API
1332 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1333 &quot;metadatas&quot;: { # Additional structured details about this error.
1334 #
1335 # Keys must match a regular expression of `a-z+` but should
1336 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1337 # length. When identifying the current value of an exceeded limit, the units
1338 # should be contained in the key, not the value. For example, rather than
1339 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1340 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1341 # instances that can be created in a single (batch) request.
1342 &quot;a_key&quot;: &quot;A String&quot;,
1343 },
1344 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1345 # proximate cause of the error. Error reasons are unique within a particular
1346 # domain of errors. This should be at most 63 characters and match a
1347 # regular expression of `A-Z+[A-Z0-9]`, which represents
1348 # UPPER_SNAKE_CASE.
1349 },
1350 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1351 #
1352 # For example, if a quota check failed with an error indicating the calling
1353 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1354 # directly to the right place in the developer console to flip the bit.
1355 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1356 { # Describes a URL link.
1357 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1358 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1359 },
1360 ],
1361 },
1362 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1363 # which can be attached to an RPC error.
1364 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1365 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1366 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1367 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1368 },
1369 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1370 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1371 &quot;a_key&quot;: &quot;A String&quot;,
1372 },
1373 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1374 # type or metric.
1375 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1376 # or metric.
1377 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1378 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1379 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1380 },
1381 },
1382 ],
1383 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1384 # This property is optional.
1385 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1386 },
1387 ],
1388 },
1389 &quot;getVersionOperationMetadata&quot;: {
1390 &quot;inlineSbomInfo&quot;: {
1391 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1392 # appropriate identifiers.
1393 &quot;a_key&quot;: &quot;A String&quot;,
1394 },
1395 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1396 # identifiers.
1397 &quot;a_key&quot;: &quot;A String&quot;,
1398 },
1399 },
1400 },
1401 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1402 # message that was returned, such as `NOT FOUND`.
1403 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1404 # status code that was returned. For example, a `404` means the
1405 # resource was not found.
1406 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1407 # defined by the server.
1408 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1409 # This value is inRFC3339
1410 # text format.
1411 &quot;instancesBulkInsertOperationMetadata&quot;: {
1412 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1413 # Example key: zones/us-central1-a
1414 &quot;a_key&quot;: {
1415 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1416 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1417 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1418 # error.
1419 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1420 # if the flow is rolling forward or rolling back.
1421 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1422 },
1423 },
1424 },
1425 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1426 # Operation resources.
1427 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1428 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1429 # group of operations results from a `bulkInsert` API request.
1430 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1431 # `update`, or `delete`, and so on.
1432 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1433 # There is no requirement that this be linear or support any granularity of
1434 # operations. This should not be used to guess when the operation will be
1435 # complete. This number should monotonically increase as the operation
1436 # progresses.
1437 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1438 # applicable when performing regional operations.
1439 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1440 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1441 # this field will contain information on all underlying zonal actions and
1442 # their state.
1443 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1444 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1445 # Example key: zones/us-central1-a
1446 &quot;a_key&quot;: {
1447 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1448 # populated.
1449 # different programming environments, including REST APIs and RPC APIs. It is
1450 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1451 # three pieces of data: error code, error message, and error details.
1452 #
1453 # You can find out more about this error model and how to work with it in the
1454 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1455 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1456 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1457 # message types for APIs to use.
1458 {
1459 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1460 },
1461 ],
1462 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1463 # user-facing error message should be localized and sent in the
1464 # google.rpc.Status.details field, or localized by the client.
1465 },
1466 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1467 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1468 },
1469 },
1470 },
1471 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1472 # This value is inRFC3339
1473 # text format.
1474 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1475 # following:
1476 # `PENDING`, `RUNNING`, or `DONE`.
1477 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1478 # operation.
1479 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1480 # of the target resource.
1481 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1482 # operations related to creating a snapshot, this points to the disk
1483 # that the snapshot was created from.
1484 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1485 # `[email protected]` or
1486 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1487 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1488 # operation, this field will be populated.
1489 {
1490 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1491 # Engine returns NO_RESULTS_ON_PAGE if there
1492 # are no results in the response.
1493 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1494 # value format. For example:
1495 #
1496 # &quot;data&quot;: [
1497 # {
1498 # &quot;key&quot;: &quot;scope&quot;,
1499 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1500 # }
1501 {
1502 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1503 # returned. For example, for warnings where there are no results in a list
1504 # request for a particular zone, this key might be scope and
1505 # the key value might be the zone name. Other examples might be a key
1506 # indicating a deprecated resource and a suggested replacement, or a
1507 # warning about invalid network settings (for example, if an instance
1508 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1509 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1510 },
1511 ],
1512 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1513 },
1514 ],
1515 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1516 # applicable when performing per-zone operations.
1517 }</pre>
1518 </div>
1519
1520 <div class="method">
1521 <code class="details" id="get">get(project, zone, networkEndpointGroup, x__xgafv=None)</code>
1522 <pre>Returns the specified network endpoint group.
1523
1524 Args:
1525 project: string, Project ID for this request. (required)
1526 zone: string, The name of the zone where
1527 the network endpoint group is located. It should comply with RFC1035. (required)
1528 networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required)
1529 x__xgafv: string, V1 error format.
1530 Allowed values
1531 1 - v1 error format
1532 2 - v2 error format
1533
1534 Returns:
1535 An object of the form:
1536
1537 { # Represents a collection of network endpoints.
1538 #
1539 # A network endpoint group (NEG) defines how a set of endpoints should be
1540 # reached, whether they are reachable, and where they are located.
1541 # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
1542 #
1543 # Note: Use the following APIs to manage network endpoint groups:
1544 #
1545 # -
1546 # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
1547 # NEGs): zonal
1548 # API
1549 # -
1550 # To manage NEGs with regional scope (such as regional internet NEGs,
1551 # serverless NEGs, Private Service Connect NEGs): regional
1552 # API
1553 # -
1554 # To manage NEGs with global scope (such as global internet NEGs):global
1555 # API
1556 &quot;annotations&quot;: { # Optional. Metadata defined as annotations on the network endpoint group.
1557 &quot;a_key&quot;: &quot;A String&quot;,
1558 },
1559 &quot;appEngine&quot;: { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
1560 # The service is optional, may be provided explicitly or in the
1561 # URL mask. The version is optional and can only be provided
1562 # explicitly or in the URL mask when service is present.
1563 #
1564 # Note: App Engine service must be in the same project and located in the
1565 # same region as the Serverless NEG.
1566 &quot;service&quot;: &quot;A String&quot;, # Optional serving service.
1567 #
1568 # The service name is case-sensitive and must be 1-63
1569 # characters long.
1570 #
1571 # Example value: default, my-service.
1572 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1573 # mask is one of the main components of the Cloud Function.
1574 #
1575 # A template to parse service and version fields
1576 # from a request URL. URL mask allows for routing to multiple App Engine
1577 # services without having to create multiple Network Endpoint Groups and
1578 # backend services.
1579 #
1580 # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same
1581 # Serverless NEG with URL mask&lt;service&gt;-dot-appname.appspot.com/&lt;version&gt;.
1582 # The URL mask will parse them to { service = &quot;foo1&quot;, version = &quot;v1&quot;
1583 # } and { service = &quot;foo1&quot;, version = &quot;v2&quot; }
1584 # respectively.
1585 &quot;version&quot;: &quot;A String&quot;, # Optional serving version.
1586 #
1587 # The version name is case-sensitive and must be 1-100
1588 # characters long.
1589 #
1590 # Example value: v1, v2.
1591 },
1592 &quot;cloudFunction&quot;: { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
1593 # The function must be provided explicitly or in the URL mask.
1594 #
1595 # Note: Cloud Function must be in the same project and located in the same
1596 # region as the Serverless NEG.
1597 &quot;function&quot;: &quot;A String&quot;, # A user-defined name of the Cloud Function.
1598 #
1599 # The function name is case-sensitive and must be 1-63
1600 # characters long.
1601 #
1602 # Example value: func1.
1603 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1604 # mask is one of the main components of the Cloud Function.
1605 #
1606 # A template to parse function field from a request URL. URL
1607 # mask allows for routing to multiple Cloud Functions without having to
1608 # create multiple Network Endpoint Groups and backend services.
1609 #
1610 # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same
1611 # Serverless NEG with URL mask /&lt;function&gt;. The URL
1612 # mask will parse them to { function = &quot;function1&quot; } and{ function = &quot;function2&quot; } respectively.
1613 },
1614 &quot;cloudRun&quot;: { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
1615 # The service must be provided explicitly or in the URL mask.
1616 # The tag is optional, may be provided explicitly or in the URL
1617 # mask.
1618 #
1619 # Note: Cloud Run service must be in the same project and located in the same
1620 # region as the Serverless NEG.
1621 &quot;service&quot;: &quot;A String&quot;, # Cloud Run service is the main resource of Cloud Run.
1622 #
1623 # The service must be 1-63 characters long, and comply withRFC1035.
1624 #
1625 # Example value: &quot;run-service&quot;.
1626 &quot;tag&quot;: &quot;A String&quot;, # Optional Cloud Run tag represents the &quot;named-revision&quot; to provide additional
1627 # fine-grained traffic routing information.
1628 #
1629 # The tag must be 1-63 characters long, and comply withRFC1035.
1630 #
1631 # Example value: &quot;revision-0010&quot;.
1632 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1633 # mask is one of the main components of the Cloud Function.
1634 #
1635 # A template to parse &lt;service&gt; and&lt;tag&gt; fields from a request URL. URL mask allows for
1636 # routing to multiple Run services without having to create multiple
1637 # network endpoint groups and backend services.
1638 #
1639 # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless
1640 # Network Endpoint Group (NEG) with URL mask&lt;tag&gt;.domain.com/&lt;service&gt;. The URL mask will
1641 # parse them to { service=&quot;bar1&quot;, tag=&quot;foo1&quot; } and {
1642 # service=&quot;bar2&quot;, tag=&quot;foo2&quot; } respectively.
1643 },
1644 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1645 # text format.
1646 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
1647 # endpoint.
1648 #
1649 # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
1650 # field must not be specified.
1651 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1652 # create the resource.
1653 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1654 # defined by the server.
1655 &quot;kind&quot;: &quot;compute#networkEndpointGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.
1656 &quot;loadBalancer&quot;: { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load
1657 # balancing.
1658 # [Deprecated] This field is deprecated.
1659 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
1660 # endpoint.
1661 #
1662 # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
1663 # field must not be specified.
1664 # [Deprecated] This field is deprecated.
1665 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
1666 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
1667 # if this field is not specified, a default network will be used.
1668 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
1669 # global NEGs.
1670 # For all other network endpoint types, this field is required.
1671 # [Deprecated] This field is deprecated.
1672 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
1673 # belong.
1674 # [Deprecated] This field is deprecated.
1675 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
1676 # where the network endpoint group is located.
1677 # [Deprecated] This field is deprecated.
1678 },
1679 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1680 # The name must be 1-63 characters long, and comply withRFC1035.
1681 # Specifically, the name must be 1-63 characters long and match the regular
1682 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1683 # character must be a lowercase letter, and all following characters must be
1684 # a dash, lowercase letter, or digit, except the last character, which cannot
1685 # be a dash.
1686 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
1687 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
1688 # if this field is not specified, a default network will be used.
1689 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
1690 # global NEGs.
1691 # For all other network endpoint types, this field is required.
1692 &quot;networkEndpointType&quot;: &quot;A String&quot;, # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.
1693 &quot;pscData&quot;: { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
1694 # type PRIVATE_SERVICE_CONNECT.
1695 &quot;consumerPscAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] Address allocated from given subnetwork for PSC. This IP
1696 # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in
1697 # L7 PSC-XLB.
1698 &quot;producerPort&quot;: 42, # The psc producer port is used to connect PSC NEG with specific port on
1699 # the PSC Producer side; should only be used for the
1700 # PRIVATE_SERVICE_CONNECT NEG type
1701 &quot;pscConnectionId&quot;: &quot;A String&quot;, # Output only. [Output Only] The PSC connection id of the PSC Network Endpoint Group
1702 # Consumer.
1703 &quot;pscConnectionStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The connection status of the PSC Forwarding Rule.
1704 },
1705 &quot;pscTargetService&quot;: &quot;A String&quot;, # The target service url used to set up private service connection to
1706 # a Google API or a PSC Producer Service Attachment.
1707 # An example value is: asia-northeast3-cloudkms.googleapis.com.
1708 #
1709 # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
1710 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
1711 # where the network endpoint group is located.
1712 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1713 &quot;serverlessDeployment&quot;: { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set.
1714 #
1715 # Note: The target backend service must be in the same project and located in
1716 # the same region as the Serverless NEG.
1717 &quot;platform&quot;: &quot;A String&quot;, # The platform of the backend target(s) of this NEG.
1718 # The only supported value is
1719 # API Gateway: apigateway.googleapis.com.
1720 &quot;resource&quot;: &quot;A String&quot;, # The user-defined name of the workload/instance. This value must be
1721 # provided explicitly or in the urlMask. The resource
1722 # identified by this value is platform-specific and is as follows:
1723 #
1724 #
1725 #
1726 # 1. API Gateway: The gateway ID
1727 # 2. App Engine: The service name
1728 # 3. Cloud Functions: The function name
1729 # 4. Cloud Run: The service name
1730 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1731 # mask is one of the main components of the Cloud Function.
1732 #
1733 # A template to parse platform-specific fields from a request URL. URL mask
1734 # allows for routing to multiple resources on the same serverless platform
1735 # without having to create multiple Network Endpoint Groups and backend
1736 # resources. The fields parsed by this template are platform-specific and
1737 # are as follows:
1738 #
1739 #
1740 #
1741 # 1. API Gateway: The gateway ID
1742 # 2. App Engine: The service and version
1743 # 3. Cloud Functions: The function name
1744 # 4. Cloud Run: The service and tag
1745 &quot;version&quot;: &quot;A String&quot;, # The optional resource version. The version identified by this value is
1746 # platform-specific and is follows:
1747 #
1748 #
1749 #
1750 # 1. API Gateway: Unused
1751 # 2. App Engine: The service version
1752 # 3. Cloud Functions: Unused
1753 # 4. Cloud Run: The service tag
1754 },
1755 &quot;size&quot;: 42, # Output only. [Output only] Number of network endpoints in the network endpoint group.
1756 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
1757 # belong.
1758 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
1759 # where the network endpoint group is located.
1760 }</pre>
1761 </div>
1762
1763 <div class="method">
1764 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
1765 <pre>Creates a network endpoint group in the specified project using the
1766 parameters that are included in the request.
1767
1768 Note: Use the following APIs to manage network endpoint groups:
1769
1770 -
1771 To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
1772 NEGs): zonal
1773 API
1774 -
1775 To manage NEGs with regional scope (such as regional internet NEGs,
1776 serverless NEGs, Private Service Connect NEGs): regional
1777 API
1778 -
1779 To manage NEGs with global scope (such as global internet NEGs):global
1780 API
1781
1782 Args:
1783 project: string, Project ID for this request. (required)
1784 zone: string, The name of the zone where
1785 you want to create the network endpoint group. It should comply with
1786 RFC1035. (required)
1787 body: object, The request body.
1788 The object takes the form of:
1789
1790 { # Represents a collection of network endpoints.
1791 #
1792 # A network endpoint group (NEG) defines how a set of endpoints should be
1793 # reached, whether they are reachable, and where they are located.
1794 # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
1795 #
1796 # Note: Use the following APIs to manage network endpoint groups:
1797 #
1798 # -
1799 # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
1800 # NEGs): zonal
1801 # API
1802 # -
1803 # To manage NEGs with regional scope (such as regional internet NEGs,
1804 # serverless NEGs, Private Service Connect NEGs): regional
1805 # API
1806 # -
1807 # To manage NEGs with global scope (such as global internet NEGs):global
1808 # API
1809 &quot;annotations&quot;: { # Optional. Metadata defined as annotations on the network endpoint group.
1810 &quot;a_key&quot;: &quot;A String&quot;,
1811 },
1812 &quot;appEngine&quot;: { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
1813 # The service is optional, may be provided explicitly or in the
1814 # URL mask. The version is optional and can only be provided
1815 # explicitly or in the URL mask when service is present.
1816 #
1817 # Note: App Engine service must be in the same project and located in the
1818 # same region as the Serverless NEG.
1819 &quot;service&quot;: &quot;A String&quot;, # Optional serving service.
1820 #
1821 # The service name is case-sensitive and must be 1-63
1822 # characters long.
1823 #
1824 # Example value: default, my-service.
1825 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1826 # mask is one of the main components of the Cloud Function.
1827 #
1828 # A template to parse service and version fields
1829 # from a request URL. URL mask allows for routing to multiple App Engine
1830 # services without having to create multiple Network Endpoint Groups and
1831 # backend services.
1832 #
1833 # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same
1834 # Serverless NEG with URL mask&lt;service&gt;-dot-appname.appspot.com/&lt;version&gt;.
1835 # The URL mask will parse them to { service = &quot;foo1&quot;, version = &quot;v1&quot;
1836 # } and { service = &quot;foo1&quot;, version = &quot;v2&quot; }
1837 # respectively.
1838 &quot;version&quot;: &quot;A String&quot;, # Optional serving version.
1839 #
1840 # The version name is case-sensitive and must be 1-100
1841 # characters long.
1842 #
1843 # Example value: v1, v2.
1844 },
1845 &quot;cloudFunction&quot;: { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
1846 # The function must be provided explicitly or in the URL mask.
1847 #
1848 # Note: Cloud Function must be in the same project and located in the same
1849 # region as the Serverless NEG.
1850 &quot;function&quot;: &quot;A String&quot;, # A user-defined name of the Cloud Function.
1851 #
1852 # The function name is case-sensitive and must be 1-63
1853 # characters long.
1854 #
1855 # Example value: func1.
1856 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1857 # mask is one of the main components of the Cloud Function.
1858 #
1859 # A template to parse function field from a request URL. URL
1860 # mask allows for routing to multiple Cloud Functions without having to
1861 # create multiple Network Endpoint Groups and backend services.
1862 #
1863 # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same
1864 # Serverless NEG with URL mask /&lt;function&gt;. The URL
1865 # mask will parse them to { function = &quot;function1&quot; } and{ function = &quot;function2&quot; } respectively.
1866 },
1867 &quot;cloudRun&quot;: { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
1868 # The service must be provided explicitly or in the URL mask.
1869 # The tag is optional, may be provided explicitly or in the URL
1870 # mask.
1871 #
1872 # Note: Cloud Run service must be in the same project and located in the same
1873 # region as the Serverless NEG.
1874 &quot;service&quot;: &quot;A String&quot;, # Cloud Run service is the main resource of Cloud Run.
1875 #
1876 # The service must be 1-63 characters long, and comply withRFC1035.
1877 #
1878 # Example value: &quot;run-service&quot;.
1879 &quot;tag&quot;: &quot;A String&quot;, # Optional Cloud Run tag represents the &quot;named-revision&quot; to provide additional
1880 # fine-grained traffic routing information.
1881 #
1882 # The tag must be 1-63 characters long, and comply withRFC1035.
1883 #
1884 # Example value: &quot;revision-0010&quot;.
1885 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1886 # mask is one of the main components of the Cloud Function.
1887 #
1888 # A template to parse &lt;service&gt; and&lt;tag&gt; fields from a request URL. URL mask allows for
1889 # routing to multiple Run services without having to create multiple
1890 # network endpoint groups and backend services.
1891 #
1892 # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless
1893 # Network Endpoint Group (NEG) with URL mask&lt;tag&gt;.domain.com/&lt;service&gt;. The URL mask will
1894 # parse them to { service=&quot;bar1&quot;, tag=&quot;foo1&quot; } and {
1895 # service=&quot;bar2&quot;, tag=&quot;foo2&quot; } respectively.
1896 },
1897 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1898 # text format.
1899 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
1900 # endpoint.
1901 #
1902 # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
1903 # field must not be specified.
1904 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1905 # create the resource.
1906 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1907 # defined by the server.
1908 &quot;kind&quot;: &quot;compute#networkEndpointGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.
1909 &quot;loadBalancer&quot;: { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load
1910 # balancing.
1911 # [Deprecated] This field is deprecated.
1912 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
1913 # endpoint.
1914 #
1915 # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
1916 # field must not be specified.
1917 # [Deprecated] This field is deprecated.
1918 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
1919 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
1920 # if this field is not specified, a default network will be used.
1921 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
1922 # global NEGs.
1923 # For all other network endpoint types, this field is required.
1924 # [Deprecated] This field is deprecated.
1925 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
1926 # belong.
1927 # [Deprecated] This field is deprecated.
1928 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
1929 # where the network endpoint group is located.
1930 # [Deprecated] This field is deprecated.
1931 },
1932 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1933 # The name must be 1-63 characters long, and comply withRFC1035.
1934 # Specifically, the name must be 1-63 characters long and match the regular
1935 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1936 # character must be a lowercase letter, and all following characters must be
1937 # a dash, lowercase letter, or digit, except the last character, which cannot
1938 # be a dash.
1939 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
1940 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
1941 # if this field is not specified, a default network will be used.
1942 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
1943 # global NEGs.
1944 # For all other network endpoint types, this field is required.
1945 &quot;networkEndpointType&quot;: &quot;A String&quot;, # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.
1946 &quot;pscData&quot;: { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
1947 # type PRIVATE_SERVICE_CONNECT.
1948 &quot;consumerPscAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] Address allocated from given subnetwork for PSC. This IP
1949 # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in
1950 # L7 PSC-XLB.
1951 &quot;producerPort&quot;: 42, # The psc producer port is used to connect PSC NEG with specific port on
1952 # the PSC Producer side; should only be used for the
1953 # PRIVATE_SERVICE_CONNECT NEG type
1954 &quot;pscConnectionId&quot;: &quot;A String&quot;, # Output only. [Output Only] The PSC connection id of the PSC Network Endpoint Group
1955 # Consumer.
1956 &quot;pscConnectionStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The connection status of the PSC Forwarding Rule.
1957 },
1958 &quot;pscTargetService&quot;: &quot;A String&quot;, # The target service url used to set up private service connection to
1959 # a Google API or a PSC Producer Service Attachment.
1960 # An example value is: asia-northeast3-cloudkms.googleapis.com.
1961 #
1962 # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
1963 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
1964 # where the network endpoint group is located.
1965 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1966 &quot;serverlessDeployment&quot;: { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set.
1967 #
1968 # Note: The target backend service must be in the same project and located in
1969 # the same region as the Serverless NEG.
1970 &quot;platform&quot;: &quot;A String&quot;, # The platform of the backend target(s) of this NEG.
1971 # The only supported value is
1972 # API Gateway: apigateway.googleapis.com.
1973 &quot;resource&quot;: &quot;A String&quot;, # The user-defined name of the workload/instance. This value must be
1974 # provided explicitly or in the urlMask. The resource
1975 # identified by this value is platform-specific and is as follows:
1976 #
1977 #
1978 #
1979 # 1. API Gateway: The gateway ID
1980 # 2. App Engine: The service name
1981 # 3. Cloud Functions: The function name
1982 # 4. Cloud Run: The service name
1983 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
1984 # mask is one of the main components of the Cloud Function.
1985 #
1986 # A template to parse platform-specific fields from a request URL. URL mask
1987 # allows for routing to multiple resources on the same serverless platform
1988 # without having to create multiple Network Endpoint Groups and backend
1989 # resources. The fields parsed by this template are platform-specific and
1990 # are as follows:
1991 #
1992 #
1993 #
1994 # 1. API Gateway: The gateway ID
1995 # 2. App Engine: The service and version
1996 # 3. Cloud Functions: The function name
1997 # 4. Cloud Run: The service and tag
1998 &quot;version&quot;: &quot;A String&quot;, # The optional resource version. The version identified by this value is
1999 # platform-specific and is follows:
2000 #
2001 #
2002 #
2003 # 1. API Gateway: Unused
2004 # 2. App Engine: The service version
2005 # 3. Cloud Functions: Unused
2006 # 4. Cloud Run: The service tag
2007 },
2008 &quot;size&quot;: 42, # Output only. [Output only] Number of network endpoints in the network endpoint group.
2009 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
2010 # belong.
2011 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
2012 # where the network endpoint group is located.
2013 }
2014
2015 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2016 that if you must retry your request, the server will know to ignore the
2017 request if it has already been completed.
2018
2019 For example, consider a situation where you make an initial request and
2020 the request times out. If you make the request again with the same
2021 request ID, the server can check if original operation with the same
2022 request ID was received, and if so, will ignore the second request. This
2023 prevents clients from accidentally creating duplicate commitments.
2024
2025 The request ID must be
2026 a valid UUID with the exception that zero UUID is not supported
2027 (00000000-0000-0000-0000-000000000000).
2028 x__xgafv: string, V1 error format.
2029 Allowed values
2030 1 - v1 error format
2031 2 - v2 error format
2032
2033 Returns:
2034 An object of the form:
2035
2036 { # Represents an Operation resource.
2037 #
2038 # Google Compute Engine has three Operation resources:
2039 #
2040 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2041 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2042 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2043 #
2044 # You can use an operation resource to manage asynchronous API requests.
2045 # For more information, readHandling
2046 # API responses.
2047 #
2048 # Operations can be global, regional or zonal.
2049 #
2050 # - For global operations, use the `globalOperations`
2051 # resource.
2052 # - For regional operations, use the
2053 # `regionOperations` resource.
2054 # - For zonal operations, use
2055 # the `zoneOperations` resource.
2056 #
2057 #
2058 #
2059 # For more information, read
2060 # Global, Regional, and Zonal Resources.
2061 #
2062 # Note that completed Operation resources have a limited
2063 # retention period.
2064 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2065 # Not present otherwise.
2066 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2067 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2068 # set when the operation is created.
2069 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2070 # text format.
2071 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2072 # this field will be populated.
2073 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2074 # operation.
2075 {
2076 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2077 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2078 # details. There is a set of defined message types to use for providing
2079 # details.The syntax depends on the error code. For example,
2080 # QuotaExceededInfo will have details when the error code is
2081 # QUOTA_EXCEEDED.
2082 {
2083 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2084 #
2085 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2086 # is not enabled:
2087 #
2088 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2089 # &quot;domain&quot;: &quot;googleapis.com&quot;
2090 # &quot;metadata&quot;: {
2091 # &quot;resource&quot;: &quot;projects/123&quot;,
2092 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2093 # }
2094 # }
2095 #
2096 # This response indicates that the pubsub.googleapis.com API is not enabled.
2097 #
2098 # Example of an error that is returned when attempting to create a Spanner
2099 # instance in a region that is out of stock:
2100 #
2101 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2102 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2103 # &quot;metadata&quot;: {
2104 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2105 # }
2106 # }
2107 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2108 # is typically the registered service name of the tool or product that
2109 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2110 # generated by some common infrastructure, the error domain must be a
2111 # globally unique value that identifies the infrastructure. For Google API
2112 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2113 &quot;metadatas&quot;: { # Additional structured details about this error.
2114 #
2115 # Keys must match a regular expression of `a-z+` but should
2116 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2117 # length. When identifying the current value of an exceeded limit, the units
2118 # should be contained in the key, not the value. For example, rather than
2119 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2120 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2121 # instances that can be created in a single (batch) request.
2122 &quot;a_key&quot;: &quot;A String&quot;,
2123 },
2124 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2125 # proximate cause of the error. Error reasons are unique within a particular
2126 # domain of errors. This should be at most 63 characters and match a
2127 # regular expression of `A-Z+[A-Z0-9]`, which represents
2128 # UPPER_SNAKE_CASE.
2129 },
2130 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2131 #
2132 # For example, if a quota check failed with an error indicating the calling
2133 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2134 # directly to the right place in the developer console to flip the bit.
2135 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2136 { # Describes a URL link.
2137 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2138 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2139 },
2140 ],
2141 },
2142 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2143 # which can be attached to an RPC error.
2144 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2145 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2146 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2147 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2148 },
2149 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2150 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2151 &quot;a_key&quot;: &quot;A String&quot;,
2152 },
2153 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2154 # type or metric.
2155 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2156 # or metric.
2157 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2158 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2159 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2160 },
2161 },
2162 ],
2163 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2164 # This property is optional.
2165 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2166 },
2167 ],
2168 },
2169 &quot;getVersionOperationMetadata&quot;: {
2170 &quot;inlineSbomInfo&quot;: {
2171 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2172 # appropriate identifiers.
2173 &quot;a_key&quot;: &quot;A String&quot;,
2174 },
2175 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2176 # identifiers.
2177 &quot;a_key&quot;: &quot;A String&quot;,
2178 },
2179 },
2180 },
2181 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2182 # message that was returned, such as `NOT FOUND`.
2183 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2184 # status code that was returned. For example, a `404` means the
2185 # resource was not found.
2186 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2187 # defined by the server.
2188 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2189 # This value is inRFC3339
2190 # text format.
2191 &quot;instancesBulkInsertOperationMetadata&quot;: {
2192 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2193 # Example key: zones/us-central1-a
2194 &quot;a_key&quot;: {
2195 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2196 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2197 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2198 # error.
2199 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2200 # if the flow is rolling forward or rolling back.
2201 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2202 },
2203 },
2204 },
2205 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2206 # Operation resources.
2207 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2208 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2209 # group of operations results from a `bulkInsert` API request.
2210 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2211 # `update`, or `delete`, and so on.
2212 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2213 # There is no requirement that this be linear or support any granularity of
2214 # operations. This should not be used to guess when the operation will be
2215 # complete. This number should monotonically increase as the operation
2216 # progresses.
2217 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2218 # applicable when performing regional operations.
2219 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2220 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2221 # this field will contain information on all underlying zonal actions and
2222 # their state.
2223 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2224 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2225 # Example key: zones/us-central1-a
2226 &quot;a_key&quot;: {
2227 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2228 # populated.
2229 # different programming environments, including REST APIs and RPC APIs. It is
2230 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2231 # three pieces of data: error code, error message, and error details.
2232 #
2233 # You can find out more about this error model and how to work with it in the
2234 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2235 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2236 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2237 # message types for APIs to use.
2238 {
2239 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2240 },
2241 ],
2242 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2243 # user-facing error message should be localized and sent in the
2244 # google.rpc.Status.details field, or localized by the client.
2245 },
2246 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2247 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2248 },
2249 },
2250 },
2251 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2252 # This value is inRFC3339
2253 # text format.
2254 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2255 # following:
2256 # `PENDING`, `RUNNING`, or `DONE`.
2257 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2258 # operation.
2259 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2260 # of the target resource.
2261 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2262 # operations related to creating a snapshot, this points to the disk
2263 # that the snapshot was created from.
2264 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2265 # `[email protected]` or
2266 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2267 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2268 # operation, this field will be populated.
2269 {
2270 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2271 # Engine returns NO_RESULTS_ON_PAGE if there
2272 # are no results in the response.
2273 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2274 # value format. For example:
2275 #
2276 # &quot;data&quot;: [
2277 # {
2278 # &quot;key&quot;: &quot;scope&quot;,
2279 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2280 # }
2281 {
2282 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2283 # returned. For example, for warnings where there are no results in a list
2284 # request for a particular zone, this key might be scope and
2285 # the key value might be the zone name. Other examples might be a key
2286 # indicating a deprecated resource and a suggested replacement, or a
2287 # warning about invalid network settings (for example, if an instance
2288 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2289 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2290 },
2291 ],
2292 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2293 },
2294 ],
2295 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2296 # applicable when performing per-zone operations.
2297 }</pre>
2298 </div>
2299
2300 <div class="method">
2301 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2302 <pre>Retrieves the list of network endpoint groups that are located in the
2303 specified project and zone.
2304
2305 Args:
2306 project: string, Project ID for this request. (required)
2307 zone: string, The name of thezone
2308 where the network endpoint group is located. It should comply with RFC1035. (required)
2309 filter: string, A filter expression that filters resources listed in the response. Most
2310 Compute resources support two types of filter expressions:
2311 expressions that support regular expressions and expressions that follow
2312 API improvement proposal AIP-160.
2313 These two types of filter expressions cannot be mixed in one request.
2314
2315 If you want to use AIP-160, your expression must specify the field name, an
2316 operator, and the value that you want to use for filtering. The value
2317 must be a string, a number, or a boolean. The operator
2318 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2319
2320 For example, if you are filtering Compute Engine instances, you can
2321 exclude instances named `example-instance` by specifying
2322 `name != example-instance`.
2323
2324 The `:*` comparison can be used to test whether a key has been defined.
2325 For example, to find all objects with `owner` label use:
2326 ```
2327 labels.owner:*
2328 ```
2329
2330 You can also filter nested fields. For example, you could specify
2331 `scheduling.automaticRestart = false` to include instances only
2332 if they are not scheduled for automatic restarts. You can use filtering
2333 on nested fields to filter based onresource labels.
2334
2335 To filter on multiple expressions, provide each separate expression within
2336 parentheses. For example:
2337 ```
2338 (scheduling.automaticRestart = true)
2339 (cpuPlatform = &quot;Intel Skylake&quot;)
2340 ```
2341 By default, each expression is an `AND` expression. However, you
2342 can include `AND` and `OR` expressions explicitly.
2343 For example:
2344 ```
2345 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2346 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2347 (scheduling.automaticRestart = true)
2348 ```
2349
2350 If you want to use a regular expression, use the `eq` (equal) or `ne`
2351 (not equal) operator against a single un-parenthesized expression with or
2352 without quotes or against multiple parenthesized expressions. Examples:
2353
2354 `fieldname eq unquoted literal`
2355 `fieldname eq &#x27;single quoted literal&#x27;`
2356 `fieldname eq &quot;double quoted literal&quot;`
2357 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2358
2359 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2360 The literal value must match the entire field.
2361
2362 For example, to filter for instances that do not end with name &quot;instance&quot;,
2363 you would use `name ne .*instance`.
2364
2365 You cannot combine constraints on multiple fields using regular
2366 expressions.
2367 maxResults: integer, The maximum number of results per page that should be returned.
2368 If the number of available results is larger than `maxResults`,
2369 Compute Engine returns a `nextPageToken` that can be used to get
2370 the next page of results in subsequent list requests. Acceptable values are
2371 `0` to `500`, inclusive. (Default: `500`)
2372 orderBy: string, Sorts list results by a certain order. By default, results
2373 are returned in alphanumerical order based on the resource name.
2374
2375 You can also sort results in descending order based on the creation
2376 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2377 results based on the `creationTimestamp` field in
2378 reverse chronological order (newest result first). Use this to sort
2379 resources like operations so that the newest operation is returned first.
2380
2381 Currently, only sorting by `name` or
2382 `creationTimestamp desc` is supported.
2383 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2384 `nextPageToken` returned by a previous list request to get
2385 the next page of results.
2386 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2387 of failure. The default value is false.
2388
2389 For example, when partial success behavior is enabled, aggregatedList for a
2390 single zone scope either returns all resources in the zone or no resources,
2391 with an error code.
2392 x__xgafv: string, V1 error format.
2393 Allowed values
2394 1 - v1 error format
2395 2 - v2 error format
2396
2397 Returns:
2398 An object of the form:
2399
2400 {
2401 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2402 &quot;items&quot;: [ # A list of NetworkEndpointGroup resources.
2403 { # Represents a collection of network endpoints.
2404 #
2405 # A network endpoint group (NEG) defines how a set of endpoints should be
2406 # reached, whether they are reachable, and where they are located.
2407 # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
2408 #
2409 # Note: Use the following APIs to manage network endpoint groups:
2410 #
2411 # -
2412 # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
2413 # NEGs): zonal
2414 # API
2415 # -
2416 # To manage NEGs with regional scope (such as regional internet NEGs,
2417 # serverless NEGs, Private Service Connect NEGs): regional
2418 # API
2419 # -
2420 # To manage NEGs with global scope (such as global internet NEGs):global
2421 # API
2422 &quot;annotations&quot;: { # Optional. Metadata defined as annotations on the network endpoint group.
2423 &quot;a_key&quot;: &quot;A String&quot;,
2424 },
2425 &quot;appEngine&quot;: { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
2426 # The service is optional, may be provided explicitly or in the
2427 # URL mask. The version is optional and can only be provided
2428 # explicitly or in the URL mask when service is present.
2429 #
2430 # Note: App Engine service must be in the same project and located in the
2431 # same region as the Serverless NEG.
2432 &quot;service&quot;: &quot;A String&quot;, # Optional serving service.
2433 #
2434 # The service name is case-sensitive and must be 1-63
2435 # characters long.
2436 #
2437 # Example value: default, my-service.
2438 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
2439 # mask is one of the main components of the Cloud Function.
2440 #
2441 # A template to parse service and version fields
2442 # from a request URL. URL mask allows for routing to multiple App Engine
2443 # services without having to create multiple Network Endpoint Groups and
2444 # backend services.
2445 #
2446 # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same
2447 # Serverless NEG with URL mask&lt;service&gt;-dot-appname.appspot.com/&lt;version&gt;.
2448 # The URL mask will parse them to { service = &quot;foo1&quot;, version = &quot;v1&quot;
2449 # } and { service = &quot;foo1&quot;, version = &quot;v2&quot; }
2450 # respectively.
2451 &quot;version&quot;: &quot;A String&quot;, # Optional serving version.
2452 #
2453 # The version name is case-sensitive and must be 1-100
2454 # characters long.
2455 #
2456 # Example value: v1, v2.
2457 },
2458 &quot;cloudFunction&quot;: { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
2459 # The function must be provided explicitly or in the URL mask.
2460 #
2461 # Note: Cloud Function must be in the same project and located in the same
2462 # region as the Serverless NEG.
2463 &quot;function&quot;: &quot;A String&quot;, # A user-defined name of the Cloud Function.
2464 #
2465 # The function name is case-sensitive and must be 1-63
2466 # characters long.
2467 #
2468 # Example value: func1.
2469 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
2470 # mask is one of the main components of the Cloud Function.
2471 #
2472 # A template to parse function field from a request URL. URL
2473 # mask allows for routing to multiple Cloud Functions without having to
2474 # create multiple Network Endpoint Groups and backend services.
2475 #
2476 # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same
2477 # Serverless NEG with URL mask /&lt;function&gt;. The URL
2478 # mask will parse them to { function = &quot;function1&quot; } and{ function = &quot;function2&quot; } respectively.
2479 },
2480 &quot;cloudRun&quot;: { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set.
2481 # The service must be provided explicitly or in the URL mask.
2482 # The tag is optional, may be provided explicitly or in the URL
2483 # mask.
2484 #
2485 # Note: Cloud Run service must be in the same project and located in the same
2486 # region as the Serverless NEG.
2487 &quot;service&quot;: &quot;A String&quot;, # Cloud Run service is the main resource of Cloud Run.
2488 #
2489 # The service must be 1-63 characters long, and comply withRFC1035.
2490 #
2491 # Example value: &quot;run-service&quot;.
2492 &quot;tag&quot;: &quot;A String&quot;, # Optional Cloud Run tag represents the &quot;named-revision&quot; to provide additional
2493 # fine-grained traffic routing information.
2494 #
2495 # The tag must be 1-63 characters long, and comply withRFC1035.
2496 #
2497 # Example value: &quot;revision-0010&quot;.
2498 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
2499 # mask is one of the main components of the Cloud Function.
2500 #
2501 # A template to parse &lt;service&gt; and&lt;tag&gt; fields from a request URL. URL mask allows for
2502 # routing to multiple Run services without having to create multiple
2503 # network endpoint groups and backend services.
2504 #
2505 # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless
2506 # Network Endpoint Group (NEG) with URL mask&lt;tag&gt;.domain.com/&lt;service&gt;. The URL mask will
2507 # parse them to { service=&quot;bar1&quot;, tag=&quot;foo1&quot; } and {
2508 # service=&quot;bar2&quot;, tag=&quot;foo2&quot; } respectively.
2509 },
2510 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2511 # text format.
2512 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
2513 # endpoint.
2514 #
2515 # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
2516 # field must not be specified.
2517 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2518 # create the resource.
2519 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2520 # defined by the server.
2521 &quot;kind&quot;: &quot;compute#networkEndpointGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.
2522 &quot;loadBalancer&quot;: { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load
2523 # balancing.
2524 # [Deprecated] This field is deprecated.
2525 &quot;defaultPort&quot;: 42, # The default port used if the port number is not specified in the network
2526 # endpoint.
2527 #
2528 # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this
2529 # field must not be specified.
2530 # [Deprecated] This field is deprecated.
2531 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
2532 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
2533 # if this field is not specified, a default network will be used.
2534 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
2535 # global NEGs.
2536 # For all other network endpoint types, this field is required.
2537 # [Deprecated] This field is deprecated.
2538 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
2539 # belong.
2540 # [Deprecated] This field is deprecated.
2541 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
2542 # where the network endpoint group is located.
2543 # [Deprecated] This field is deprecated.
2544 },
2545 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
2546 # The name must be 1-63 characters long, and comply withRFC1035.
2547 # Specifically, the name must be 1-63 characters long and match the regular
2548 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2549 # character must be a lowercase letter, and all following characters must be
2550 # a dash, lowercase letter, or digit, except the last character, which cannot
2551 # be a dash.
2552 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which all network endpoints in the NEG belong.
2553 # For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,
2554 # if this field is not specified, a default network will be used.
2555 # This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for
2556 # global NEGs.
2557 # For all other network endpoint types, this field is required.
2558 &quot;networkEndpointType&quot;: &quot;A String&quot;, # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.
2559 &quot;pscData&quot;: { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
2560 # type PRIVATE_SERVICE_CONNECT.
2561 &quot;consumerPscAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] Address allocated from given subnetwork for PSC. This IP
2562 # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in
2563 # L7 PSC-XLB.
2564 &quot;producerPort&quot;: 42, # The psc producer port is used to connect PSC NEG with specific port on
2565 # the PSC Producer side; should only be used for the
2566 # PRIVATE_SERVICE_CONNECT NEG type
2567 &quot;pscConnectionId&quot;: &quot;A String&quot;, # Output only. [Output Only] The PSC connection id of the PSC Network Endpoint Group
2568 # Consumer.
2569 &quot;pscConnectionStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The connection status of the PSC Forwarding Rule.
2570 },
2571 &quot;pscTargetService&quot;: &quot;A String&quot;, # The target service url used to set up private service connection to
2572 # a Google API or a PSC Producer Service Attachment.
2573 # An example value is: asia-northeast3-cloudkms.googleapis.com.
2574 #
2575 # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.
2576 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
2577 # where the network endpoint group is located.
2578 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2579 &quot;serverlessDeployment&quot;: { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set.
2580 #
2581 # Note: The target backend service must be in the same project and located in
2582 # the same region as the Serverless NEG.
2583 &quot;platform&quot;: &quot;A String&quot;, # The platform of the backend target(s) of this NEG.
2584 # The only supported value is
2585 # API Gateway: apigateway.googleapis.com.
2586 &quot;resource&quot;: &quot;A String&quot;, # The user-defined name of the workload/instance. This value must be
2587 # provided explicitly or in the urlMask. The resource
2588 # identified by this value is platform-specific and is as follows:
2589 #
2590 #
2591 #
2592 # 1. API Gateway: The gateway ID
2593 # 2. App Engine: The service name
2594 # 3. Cloud Functions: The function name
2595 # 4. Cloud Run: The service name
2596 &quot;urlMask&quot;: &quot;A String&quot;, # An URL
2597 # mask is one of the main components of the Cloud Function.
2598 #
2599 # A template to parse platform-specific fields from a request URL. URL mask
2600 # allows for routing to multiple resources on the same serverless platform
2601 # without having to create multiple Network Endpoint Groups and backend
2602 # resources. The fields parsed by this template are platform-specific and
2603 # are as follows:
2604 #
2605 #
2606 #
2607 # 1. API Gateway: The gateway ID
2608 # 2. App Engine: The service and version
2609 # 3. Cloud Functions: The function name
2610 # 4. Cloud Run: The service and tag
2611 &quot;version&quot;: &quot;A String&quot;, # The optional resource version. The version identified by this value is
2612 # platform-specific and is follows:
2613 #
2614 #
2615 #
2616 # 1. API Gateway: Unused
2617 # 2. App Engine: The service version
2618 # 3. Cloud Functions: Unused
2619 # 4. Cloud Run: The service tag
2620 },
2621 &quot;size&quot;: 42, # Output only. [Output only] Number of network endpoints in the network endpoint group.
2622 &quot;subnetwork&quot;: &quot;A String&quot;, # Optional URL of the subnetwork to which all network endpoints in the NEG
2623 # belong.
2624 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
2625 # where the network endpoint group is located.
2626 },
2627 ],
2628 &quot;kind&quot;: &quot;compute#networkEndpointGroupList&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupList for network endpoint group
2629 # lists.
2630 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2631 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2632 # the query parameter pageToken in the next list request.
2633 # Subsequent list requests will have their own nextPageToken to
2634 # continue paging through the results.
2635 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2636 &quot;warning&quot;: { # [Output Only] Informational warning message.
2637 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2638 # Engine returns NO_RESULTS_ON_PAGE if there
2639 # are no results in the response.
2640 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2641 # value format. For example:
2642 #
2643 # &quot;data&quot;: [
2644 # {
2645 # &quot;key&quot;: &quot;scope&quot;,
2646 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2647 # }
2648 {
2649 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2650 # returned. For example, for warnings where there are no results in a list
2651 # request for a particular zone, this key might be scope and
2652 # the key value might be the zone name. Other examples might be a key
2653 # indicating a deprecated resource and a suggested replacement, or a
2654 # warning about invalid network settings (for example, if an instance
2655 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2656 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2657 },
2658 ],
2659 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2660 },
2661 }</pre>
2662 </div>
2663
2664 <div class="method">
2665 <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2666 <pre>Lists the network endpoints in the specified network endpoint group.
2667
2668 Args:
2669 project: string, Project ID for this request. (required)
2670 zone: string, The name of the zone where
2671 the network endpoint group is located. It should comply with RFC1035. (required)
2672 networkEndpointGroup: string, The name of the network endpoint group from which you want to generate a
2673 list of included network endpoints. It should comply with RFC1035. (required)
2674 body: object, The request body.
2675 The object takes the form of:
2676
2677 {
2678 &quot;endpointFilters&quot;: [ # Optional list of endpoints to query.
2679 # This is a more efficient but also limited version of filter parameter.
2680 # Endpoints in the filter must have ip_address and port fields populated,
2681 # other fields are not supported.
2682 {
2683 &quot;networkEndpoint&quot;: { # The network endpoint.
2684 &quot;annotations&quot;: { # Optional metadata defined as annotations on the network endpoint.
2685 &quot;a_key&quot;: &quot;A String&quot;,
2686 },
2687 &quot;clientDestinationPort&quot;: 42, # Represents the port number to which PSC consumer sends packets.
2688 #
2689 # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type.
2690 &quot;fqdn&quot;: &quot;A String&quot;, # Optional fully qualified domain name of network endpoint. This can only be
2691 # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT.
2692 &quot;instance&quot;: &quot;A String&quot;, # The name or a URL of VM instance of this network endpoint.
2693 # Optional, the field presence depends on the network endpoint type. The
2694 # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT.
2695 #
2696 # The instance must be in the same zone of network endpoint group (for zonal
2697 # NEGs) or in the zone within the region of the NEG (for regional NEGs).
2698 # If the ipAddress is specified, it must belongs to the VM
2699 # instance.
2700 #
2701 # The name must be 1-63 characters long, and comply withRFC1035
2702 # or be a valid URL pointing to an existing instance.
2703 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional IPv4 address of network endpoint. The IP address must belong to a
2704 # VM in Compute Engine (either the primary IP or as part of an aliased IP
2705 # range). If the IP address is not specified, then the primary IP address for
2706 # the VM instance in the network that the network endpoint group belongs to
2707 # will be used.
2708 #
2709 # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP
2710 # address of the attached VM instance that matches the subnetwork of the NEG.
2711 # The primary internal IP address from any NIC of a multi-NIC VM instance can
2712 # be added to a NEG as long as it matches the NEG subnetwork.
2713 &quot;ipv6Address&quot;: &quot;A String&quot;, # Optional IPv6 address of network endpoint.
2714 &quot;port&quot;: 42, # Optional port number of network endpoint. If not specified, the
2715 # defaultPort for the network endpoint group will be used.
2716 #
2717 # This field can not be set for network endpoints of typeGCE_VM_IP.
2718 },
2719 },
2720 ],
2721 &quot;healthStatus&quot;: &quot;A String&quot;, # Optional query parameter for showing the health status of each network
2722 # endpoint. Valid options are SKIP or SHOW. If you
2723 # don&#x27;t specify this parameter, the health status of network endpoints will
2724 # not be provided.
2725 }
2726
2727 filter: string, A filter expression that filters resources listed in the response. Most
2728 Compute resources support two types of filter expressions:
2729 expressions that support regular expressions and expressions that follow
2730 API improvement proposal AIP-160.
2731 These two types of filter expressions cannot be mixed in one request.
2732
2733 If you want to use AIP-160, your expression must specify the field name, an
2734 operator, and the value that you want to use for filtering. The value
2735 must be a string, a number, or a boolean. The operator
2736 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2737
2738 For example, if you are filtering Compute Engine instances, you can
2739 exclude instances named `example-instance` by specifying
2740 `name != example-instance`.
2741
2742 The `:*` comparison can be used to test whether a key has been defined.
2743 For example, to find all objects with `owner` label use:
2744 ```
2745 labels.owner:*
2746 ```
2747
2748 You can also filter nested fields. For example, you could specify
2749 `scheduling.automaticRestart = false` to include instances only
2750 if they are not scheduled for automatic restarts. You can use filtering
2751 on nested fields to filter based onresource labels.
2752
2753 To filter on multiple expressions, provide each separate expression within
2754 parentheses. For example:
2755 ```
2756 (scheduling.automaticRestart = true)
2757 (cpuPlatform = &quot;Intel Skylake&quot;)
2758 ```
2759 By default, each expression is an `AND` expression. However, you
2760 can include `AND` and `OR` expressions explicitly.
2761 For example:
2762 ```
2763 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2764 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2765 (scheduling.automaticRestart = true)
2766 ```
2767
2768 If you want to use a regular expression, use the `eq` (equal) or `ne`
2769 (not equal) operator against a single un-parenthesized expression with or
2770 without quotes or against multiple parenthesized expressions. Examples:
2771
2772 `fieldname eq unquoted literal`
2773 `fieldname eq &#x27;single quoted literal&#x27;`
2774 `fieldname eq &quot;double quoted literal&quot;`
2775 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2776
2777 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2778 The literal value must match the entire field.
2779
2780 For example, to filter for instances that do not end with name &quot;instance&quot;,
2781 you would use `name ne .*instance`.
2782
2783 You cannot combine constraints on multiple fields using regular
2784 expressions.
2785 maxResults: integer, The maximum number of results per page that should be returned.
2786 If the number of available results is larger than `maxResults`,
2787 Compute Engine returns a `nextPageToken` that can be used to get
2788 the next page of results in subsequent list requests. Acceptable values are
2789 `0` to `500`, inclusive. (Default: `500`)
2790 orderBy: string, Sorts list results by a certain order. By default, results
2791 are returned in alphanumerical order based on the resource name.
2792
2793 You can also sort results in descending order based on the creation
2794 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2795 results based on the `creationTimestamp` field in
2796 reverse chronological order (newest result first). Use this to sort
2797 resources like operations so that the newest operation is returned first.
2798
2799 Currently, only sorting by `name` or
2800 `creationTimestamp desc` is supported.
2801 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2802 `nextPageToken` returned by a previous list request to get
2803 the next page of results.
2804 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2805 of failure. The default value is false.
2806
2807 For example, when partial success behavior is enabled, aggregatedList for a
2808 single zone scope either returns all resources in the zone or no resources,
2809 with an error code.
2810 x__xgafv: string, V1 error format.
2811 Allowed values
2812 1 - v1 error format
2813 2 - v2 error format
2814
2815 Returns:
2816 An object of the form:
2817
2818 {
2819 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2820 &quot;items&quot;: [ # A list of NetworkEndpointWithHealthStatus resources.
2821 {
2822 &quot;healths&quot;: [ # Output only. [Output only] The health status of network endpoint.
2823 #
2824 # Optional. Displayed only if the network endpoint has centralized health
2825 # checking configured.
2826 {
2827 &quot;backendService&quot;: { # URL of the backend service associated with the health state of the network
2828 # endpoint.
2829 &quot;backendService&quot;: &quot;A String&quot;,
2830 },
2831 &quot;forwardingRule&quot;: { # URL of the forwarding rule associated with the health state of the network
2832 # endpoint.
2833 &quot;forwardingRule&quot;: &quot;A String&quot;,
2834 },
2835 &quot;healthCheck&quot;: { # A full or valid partial URL to a health check. For example, the following are # URL of the health check associated with the health state of the network
2836 # endpoint.
2837 # valid URLs:
2838 #
2839 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
2840 # - projects/project-id/global/httpHealthChecks/health-check
2841 # - global/httpHealthChecks/health-check
2842 &quot;healthCheck&quot;: &quot;A String&quot;,
2843 },
2844 &quot;healthCheckService&quot;: { # A full or valid partial URL to a health check service. For example, the # URL of the health check service associated with the health state of the
2845 # network endpoint.
2846 # following are valid URLs:
2847 #
2848 # - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service
2849 # - projects/project-id/regions/us-west1/healthCheckServices/health-check-service
2850 # - regions/us-west1/healthCheckServices/health-check-service
2851 &quot;healthCheckService&quot;: &quot;A String&quot;,
2852 },
2853 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the network endpoint determined based on the health checks
2854 # configured.
2855 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the ipv6 network endpoint determined based on the health
2856 # checks configured.
2857 },
2858 ],
2859 &quot;networkEndpoint&quot;: { # The network endpoint. # Output only. [Output only] The network endpoint.
2860 &quot;annotations&quot;: { # Optional metadata defined as annotations on the network endpoint.
2861 &quot;a_key&quot;: &quot;A String&quot;,
2862 },
2863 &quot;clientDestinationPort&quot;: 42, # Represents the port number to which PSC consumer sends packets.
2864 #
2865 # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type.
2866 &quot;fqdn&quot;: &quot;A String&quot;, # Optional fully qualified domain name of network endpoint. This can only be
2867 # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT.
2868 &quot;instance&quot;: &quot;A String&quot;, # The name or a URL of VM instance of this network endpoint.
2869 # Optional, the field presence depends on the network endpoint type. The
2870 # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT.
2871 #
2872 # The instance must be in the same zone of network endpoint group (for zonal
2873 # NEGs) or in the zone within the region of the NEG (for regional NEGs).
2874 # If the ipAddress is specified, it must belongs to the VM
2875 # instance.
2876 #
2877 # The name must be 1-63 characters long, and comply withRFC1035
2878 # or be a valid URL pointing to an existing instance.
2879 &quot;ipAddress&quot;: &quot;A String&quot;, # Optional IPv4 address of network endpoint. The IP address must belong to a
2880 # VM in Compute Engine (either the primary IP or as part of an aliased IP
2881 # range). If the IP address is not specified, then the primary IP address for
2882 # the VM instance in the network that the network endpoint group belongs to
2883 # will be used.
2884 #
2885 # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP
2886 # address of the attached VM instance that matches the subnetwork of the NEG.
2887 # The primary internal IP address from any NIC of a multi-NIC VM instance can
2888 # be added to a NEG as long as it matches the NEG subnetwork.
2889 &quot;ipv6Address&quot;: &quot;A String&quot;, # Optional IPv6 address of network endpoint.
2890 &quot;port&quot;: 42, # Optional port number of network endpoint. If not specified, the
2891 # defaultPort for the network endpoint group will be used.
2892 #
2893 # This field can not be set for network endpoints of typeGCE_VM_IP.
2894 },
2895 },
2896 ],
2897 &quot;kind&quot;: &quot;compute#networkEndpointGroupsListNetworkEndpoints&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupsListNetworkEndpoints for the list
2898 # of network endpoints in the specified network endpoint group.
2899 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2900 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2901 # the query parameter pageToken in the next list request.
2902 # Subsequent list requests will have their own nextPageToken to
2903 # continue paging through the results.
2904 &quot;warning&quot;: { # [Output Only] Informational warning message.
2905 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2906 # Engine returns NO_RESULTS_ON_PAGE if there
2907 # are no results in the response.
2908 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2909 # value format. For example:
2910 #
2911 # &quot;data&quot;: [
2912 # {
2913 # &quot;key&quot;: &quot;scope&quot;,
2914 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2915 # }
2916 {
2917 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2918 # returned. For example, for warnings where there are no results in a list
2919 # request for a particular zone, this key might be scope and
2920 # the key value might be the zone name. Other examples might be a key
2921 # indicating a deprecated resource and a suggested replacement, or a
2922 # warning about invalid network settings (for example, if an instance
2923 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2924 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2925 },
2926 ],
2927 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2928 },
2929 }</pre>
2930 </div>
2931
2932 <div class="method">
2933 <code class="details" id="listNetworkEndpoints_next">listNetworkEndpoints_next()</code>
2934 <pre>Retrieves the next page of results.
2935
2936 Args:
2937 previous_request: The request for the previous page. (required)
2938 previous_response: The response from the request for the previous page. (required)
2939
2940 Returns:
2941 A request object that you can call &#x27;execute()&#x27; on to request the next
2942 page. Returns None if there are no more items in the collection.
2943 </pre>
2944 </div>
2945
2946 <div class="method">
2947 <code class="details" id="list_next">list_next()</code>
2948 <pre>Retrieves the next page of results.
2949
2950 Args:
2951 previous_request: The request for the previous page. (required)
2952 previous_response: The response from the request for the previous page. (required)
2953
2954 Returns:
2955 A request object that you can call &#x27;execute()&#x27; on to request the next
2956 page. Returns None if there are no more items in the collection.
2957 </pre>
2958 </div>
2959
2960 <div class="method">
2961 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
2962 <pre>Returns permissions that a caller has on the specified resource.
2963
2964 Args:
2965 project: string, Project ID for this request. (required)
2966 zone: string, The name of the zone for this request. (required)
2967 resource: string, Name or id of the resource for this request. (required)
2968 body: object, The request body.
2969 The object takes the form of:
2970
2971 {
2972 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2973 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2974 &quot;A String&quot;,
2975 ],
2976 }
2977
2978 x__xgafv: string, V1 error format.
2979 Allowed values
2980 1 - v1 error format
2981 2 - v2 error format
2982
2983 Returns:
2984 An object of the form:
2985
2986 {
2987 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2988 # allowed.
2989 &quot;A String&quot;,
2990 ],
2991 }</pre>
2992 </div>
2993
2994 </body></html>