Debian Codegraph @

docs/dyn/compute_v1.regionNetworkEndpointGroups.html

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