Debian Codegraph @

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