Debian Codegraph @

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