Debian Codegraph @

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