Debian Codegraph @

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