Debian Codegraph @

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