Debian Codegraph @

docs/dyn/compute_alpha.globalNetworkEndpointGroups.html

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