Debian Codegraph @

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