Debian Codegraph @

docs/dyn/compute_beta.subnetworks.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_beta.html">Compute Engine API</a> . <a href="compute_beta.subnetworks.html">subnetworks</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, views=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves an aggregated list of subnetworks.</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="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, subnetwork, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified subnetwork.</p>
89 <p class="toc_element">
90 <code><a href="#expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Expands the IP CIDR range of the subnetwork to a specified value.</p>
92 <p class="toc_element">
93 <code><a href="#get">get(project, region, subnetwork, views=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the specified subnetwork.</p>
95 <p class="toc_element">
96 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
98 <p class="toc_element">
99 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Creates a subnetwork in the specified project using the data</p>
101 <p class="toc_element">
102 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, views=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Retrieves a list of subnetworks available to the specified</p>
104 <p class="toc_element">
105 <code><a href="#listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProject=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves an aggregated list of all usable subnetworks in the project.</p>
107 <p class="toc_element">
108 <code><a href="#listUsable_next">listUsable_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="#patch">patch(project, region, subnetwork, body=None, drainTimeoutSeconds=None, requestId=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Patches the specified subnetwork with the data included in the request.</p>
116 <p class="toc_element">
117 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Sets the access control policy on the specified resource.</p>
119 <p class="toc_element">
120 <code><a href="#setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Set whether VMs in this subnet can access Google services without assigning</p>
122 <p class="toc_element">
123 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
125 <h3>Method Details</h3>
126 <div class="method">
127 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)</code>
128 <pre>Retrieves an aggregated list of subnetworks.
129
130 To prevent failure, Google recommends that you set the
131 `returnPartialSuccess` parameter to `true`.
132
133 Args:
134 project: string, Project ID for this request. (required)
135 filter: string, A filter expression that filters resources listed in the response. Most
136 Compute resources support two types of filter expressions:
137 expressions that support regular expressions and expressions that follow
138 API improvement proposal AIP-160.
139 These two types of filter expressions cannot be mixed in one request.
140
141 If you want to use AIP-160, your expression must specify the field name, an
142 operator, and the value that you want to use for filtering. The value
143 must be a string, a number, or a boolean. The operator
144 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
145
146 For example, if you are filtering Compute Engine instances, you can
147 exclude instances named `example-instance` by specifying
148 `name != example-instance`.
149
150 The `:*` comparison can be used to test whether a key has been defined.
151 For example, to find all objects with `owner` label use:
152 ```
153 labels.owner:*
154 ```
155
156 You can also filter nested fields. For example, you could specify
157 `scheduling.automaticRestart = false` to include instances only
158 if they are not scheduled for automatic restarts. You can use filtering
159 on nested fields to filter based onresource labels.
160
161 To filter on multiple expressions, provide each separate expression within
162 parentheses. For example:
163 ```
164 (scheduling.automaticRestart = true)
165 (cpuPlatform = &quot;Intel Skylake&quot;)
166 ```
167 By default, each expression is an `AND` expression. However, you
168 can include `AND` and `OR` expressions explicitly.
169 For example:
170 ```
171 (cpuPlatform = &quot;Intel Skylake&quot;) OR
172 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
173 (scheduling.automaticRestart = true)
174 ```
175
176 If you want to use a regular expression, use the `eq` (equal) or `ne`
177 (not equal) operator against a single un-parenthesized expression with or
178 without quotes or against multiple parenthesized expressions. Examples:
179
180 `fieldname eq unquoted literal`
181 `fieldname eq &#x27;single quoted literal&#x27;`
182 `fieldname eq &quot;double quoted literal&quot;`
183 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
184
185 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
186 The literal value must match the entire field.
187
188 For example, to filter for instances that do not end with name &quot;instance&quot;,
189 you would use `name ne .*instance`.
190
191 You cannot combine constraints on multiple fields using regular
192 expressions.
193 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
194 global) should be included in the response. For new resource types added
195 after this field, the flag has no effect as new resource types will always
196 include every visible scope for each scope type in response. For resource
197 types which predate this field, if this flag is omitted or false, only
198 scopes of the scope types where the resource type is expected to be found
199 will be included.
200 maxResults: integer, The maximum number of results per page that should be returned.
201 If the number of available results is larger than `maxResults`,
202 Compute Engine returns a `nextPageToken` that can be used to get
203 the next page of results in subsequent list requests. Acceptable values are
204 `0` to `500`, inclusive. (Default: `500`)
205 orderBy: string, Sorts list results by a certain order. By default, results
206 are returned in alphanumerical order based on the resource name.
207
208 You can also sort results in descending order based on the creation
209 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
210 results based on the `creationTimestamp` field in
211 reverse chronological order (newest result first). Use this to sort
212 resources like operations so that the newest operation is returned first.
213
214 Currently, only sorting by `name` or
215 `creationTimestamp desc` is supported.
216 pageToken: string, Specifies a page token to use. Set `pageToken` to the
217 `nextPageToken` returned by a previous list request to get
218 the next page of results.
219 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
220 of failure. The default value is false.
221
222 For example, when partial success behavior is enabled, aggregatedList for a
223 single zone scope either returns all resources in the zone or no resources,
224 with an error code.
225 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
226 aggregated list request is invoked for subnetworks list-usable api.
227 views: string, Defines the extra views returned back in the subnetwork resource.
228 Supported values:
229
230 - WITH_UTILIZATION: Utilization data is included in the
231 response. (repeated)
232 Allowed values
233 DEFAULT -
234 WITH_UTILIZATION - Utilization data is included in the response.
235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240 Returns:
241 An object of the form:
242
243 {
244 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
245 &quot;items&quot;: { # A list of SubnetworksScopedList resources.
246 &quot;a_key&quot;: { # Name of the scope containing this set of Subnetworks.
247 &quot;subnetworks&quot;: [ # A list of subnetworks contained in this scope.
248 { # Represents a Subnetwork resource.
249 #
250 # A subnetwork (also known as a subnet) is a logical partition of a Virtual
251 # Private Cloud network with one primary IP range and zero or more secondary
252 # IP ranges. For more information, read
253 # Virtual Private Cloud (VPC) Network.
254 &quot;allowSubnetCidrRoutesOverlap&quot;: True or False, # Whether this subnetwork&#x27;s ranges can conflict with existing custom routes.
255 # Setting this to true allows this subnetwork&#x27;s primary and secondary ranges
256 # to overlap with (and contain) custom routes that have already been
257 # configured on the corresponding network.
258 #
259 # For example if a static route has range 10.1.0.0/16, a subnet
260 # range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
261 #
262 # Overlapping is only allowed on subnetwork operations; routes
263 # whose ranges conflict with this subnetwork&#x27;s ranges won&#x27;t be allowed unless
264 # route.allow_conflicting_subnetworks is set to true.
265 #
266 # Typically packets destined to IPs within the subnetwork (which may contain
267 # private/sensitive data) are prevented from leaving the virtual network.
268 # Setting this field to true will disable this feature.
269 #
270 # The default value is false and applies to all existing subnetworks and
271 # automatically created subnetworks.
272 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
273 # text format.
274 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
275 # create the resource. This field can be set only at resource creation time.
276 &quot;enableFlowLogs&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
277 # explicitly set, it will not appear in get listings. If not set
278 # the default behavior is determined by the org policy, if there is no org
279 # policy specified, then it will default to disabled. This field isn&#x27;t
280 # supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.
281 &quot;externalIpv6Prefix&quot;: &quot;A String&quot;, # The external IPv6 address range that is owned by this
282 # subnetwork.
283 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
284 # This field is used in optimistic locking. This field will be ignored when
285 # inserting a Subnetwork. An up-to-date fingerprint must be
286 # provided in order to update the Subnetwork, otherwise the
287 # request will fail with error 412 conditionNotMet.
288 #
289 # To see the latest fingerprint, make a get() request to
290 # retrieve a Subnetwork.
291 &quot;gatewayAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] The gateway address for default routes to reach destination
292 # addresses outside this subnetwork.
293 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
294 # defined by the server.
295 &quot;internalIpv6Prefix&quot;: &quot;A String&quot;, # The internal IPv6 address range that is owned by this
296 # subnetwork.
297 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of internal addresses that are owned by this subnetwork.
298 # Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
299 # be unique and non-overlapping within a network. Only IPv4 is supported.
300 # This field is set at resource creation time. The range can be any range
301 # listed in theValid
302 # ranges list. The range can be expanded after creation usingexpandIpCidrRange.
303 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to the source of IP, like a PublicDelegatedPrefix
304 # (PDP) for BYOIP. The PDP must be a sub-PDP in
305 # EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
306 # mode.
307 #
308 # Use one of the following formats to specify a sub-PDP when creating a dual
309 # stack or IPv6-only subnetwork with external access using BYOIP:
310 #
311 # -
312 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
313 # -
314 # Partial URL, as in
315 #
316 #
317 # - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
318 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
319 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The access type of IPv6 address this subnet holds. It&#x27;s immutable and can
320 # only be specified during creation or the first time the subnet is updated
321 # into IPV4_IPV6 dual stack.
322 &quot;ipv6CidrRange&quot;: &quot;A String&quot;, # Output only. [Output Only] This field is for internal use.
323 &quot;ipv6GceEndpoint&quot;: &quot;A String&quot;, # Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the
324 # following:
325 #
326 # - VM_ONLY: The subnetwork can be used for creating instances and
327 # IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6
328 # ranges from a public delegated prefix and cannot be used to create NetLb.
329 # - VM_AND_FR: The subnetwork can be used for creating both VM
330 # instances and Forwarding Rules. It can also be used to reserve IPv6
331 # addresses with both VM and FR endpoint types. Such a subnetwork gets its
332 # IPv6 range from Google IP Pool directly.
333 &quot;kind&quot;: &quot;compute#subnetwork&quot;, # Output only. [Output Only] Type of the resource. Always compute#subnetwork
334 # for Subnetwork resources.
335 &quot;logConfig&quot;: { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork.
336 # If logging is enabled, logs are exported to Cloud Logging.
337 &quot;aggregationInterval&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logging for this subnetwork is enabled.
338 # Toggles the aggregation interval for collecting flow logs. Increasing the
339 # interval time will reduce the amount of generated flow logs for long
340 # lasting connections. Default is an interval of 5 seconds per connection.
341 &quot;enable&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
342 # explicitly set, it will not appear in get listings. If not
343 # set the default behavior is determined by the org policy, if there is no
344 # org policy specified, then it will default to disabled.
345 # Flow logging isn&#x27;t supported if the subnet purpose field is
346 # set to REGIONAL_MANAGED_PROXY.
347 &quot;filterExpr&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
348 # The filter expression is used to define which VPC flow logs should be
349 # exported to Cloud Logging.
350 &quot;flowSampling&quot;: 3.14, # Can only be specified if VPC flow logging for this subnetwork is enabled.
351 # The value of the field must be in [0, 1]. Set the sampling rate of VPC
352 # flow logs within the subnetwork where 1.0 means all collected logs are
353 # reported and 0.0 means no logs are reported. Default is 0.5 unless
354 # otherwise specified by the org policy, which means half of all collected
355 # logs are reported.
356 &quot;metadata&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
357 # Configures whether all, none or a subset of metadata fields should be
358 # added to the reported VPC flow logs. Default isEXCLUDE_ALL_METADATA.
359 &quot;metadataFields&quot;: [ # Can only be specified if VPC flow logs for this subnetwork is enabled and
360 # &quot;metadata&quot; was set to CUSTOM_METADATA.
361 &quot;A String&quot;,
362 ],
363 },
364 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
365 # the resource. The name must be 1-63 characters long, and comply withRFC1035.
366 # Specifically, the name must be 1-63 characters long and match the regular
367 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
368 # character must be a lowercase letter, and all following characters must
369 # be a dash, lowercase letter, or digit, except the last character, which
370 # cannot be a dash.
371 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this subnetwork belongs, provided by the
372 # client when initially creating the subnetwork. This field can be set only
373 # at resource creation time.
374 &quot;params&quot;: { # Additional subnetwork parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
375 # as part of resource payload.
376 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
377 # Tag keys and values have the same definition as resource
378 # manager tags. The field is allowed for INSERT
379 # only. The keys/values to set on the resource should be specified in
380 # either ID { : } or Namespaced format
381 # { : }.
382 # For example the following are valid inputs:
383 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
384 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
385 # Note:
386 # * Invalid combinations of ID &amp; namespaced format is not supported. For
387 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
388 &quot;a_key&quot;: &quot;A String&quot;,
389 },
390 },
391 &quot;privateIpGoogleAccess&quot;: True or False, # Whether the VMs in this subnet can access Google services without assigned
392 # external IP addresses. This field can be both set at resource creation
393 # time and updated using setPrivateIpGoogleAccess.
394 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # This field is for internal use.
395 #
396 # This field can be both set at resource creation time and updated usingpatch.
397 &quot;purpose&quot;: &quot;A String&quot;,
398 &quot;region&quot;: &quot;A String&quot;, # URL of the region where the Subnetwork resides. This
399 # field can be set only at resource creation time.
400 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range.
401 &quot;resolveSubnetMask&quot;: &quot;A String&quot;, # Configures subnet mask resolution for this subnetwork.
402 &quot;role&quot;: &quot;A String&quot;, # The role of subnetwork. Currently, this field is only used when
403 # purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
404 # subnetwork is one that is currently being used for Envoy-based load
405 # balancers in a region. A BACKUP subnetwork is one that is
406 # ready to be promoted to ACTIVE or is currently draining.
407 # This field can be updated with a patch request.
408 &quot;secondaryIpRanges&quot;: [ # An array of configurations for secondary IP ranges for VM instances
409 # contained in this subnetwork. The primary IP of such VM must belong to the
410 # primary ipCidrRange of the subnetwork. The alias IPs may belong to either
411 # primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.
412 { # Represents a secondary IP range of a subnetwork.
413 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of IP addresses belonging to this subnetwork secondary range.
414 # Provide this property when you create the subnetwork. Ranges must be
415 # unique and non-overlapping with all primary and secondary IP ranges
416 # within a network. Both IPv4 and IPv6 ranges are supported. For IPv4,
417 # the range can be any range listed in theValid
418 # ranges list.
419 #
420 # For IPv6:
421 # The range must have a /64 prefix length.
422 # The range must be omitted, for auto-allocation from Google-defined ULA
423 # IPv6 range.
424 # For BYOGUA internal IPv6 secondary range, the range may be specified
425 # along with the `ipCollection` field.
426 # If an `ipCollection` is specified, the requested ip_cidr_range must lie
427 # within the range of the PDP referenced by the `ipCollection` field for
428 # allocation.
429 # If `ipCollection` field is specified, but ip_cidr_range is not,
430 # the range is auto-allocated from the PDP referenced by the `ipCollection`
431 # field.
432 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to a Public Delegated Prefix (PDP) for BYOIP.
433 # This field should be specified for configuring BYOGUA internal IPv6
434 # secondary range.
435 # When specified along with the ip_cidr_range, the ip_cidr_range must lie
436 # within the PDP referenced by the `ipCollection` field.
437 # When specified without the ip_cidr_range, the range is auto-allocated
438 # from the PDP referenced by the `ipCollection` field.
439 &quot;ipVersion&quot;: &quot;A String&quot;,
440 &quot;rangeName&quot;: &quot;A String&quot;, # The name associated with this subnetwork secondary range, used when adding
441 # an alias IP/IPv6 range to a VM instance.
442 # The name must be 1-63 characters long, and comply withRFC1035.
443 # The name must be unique within the subnetwork.
444 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range. Only IPv4 is supported.
445 },
446 ],
447 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
448 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for the subnet. If set to IPV4_ONLY, new VMs
449 # in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
450 # IPv6 addresses. If not specified, IPV4_ONLY is used.
451 #
452 # This field can be both set at resource creation time and updated usingpatch.
453 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the subnetwork, which can be one of the
454 # following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
455 # purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
456 # connections to the load balancer are being drained. A subnetwork that is
457 # draining cannot be used or modified until it reaches a status ofREADY
458 &quot;systemReservedExternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of external IPv6 network ranges reserved from
459 # the subnetwork&#x27;s external IPv6 range for system use.
460 &quot;A String&quot;,
461 ],
462 &quot;systemReservedInternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from
463 # the subnetwork&#x27;s internal IPv6 range for system use.
464 &quot;A String&quot;,
465 ],
466 &quot;utilizationDetails&quot;: { # The current IP utilization of all subnetwork ranges. Contains the total # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains
467 # the total number of allocated and free IPs in each range.
468 # number of allocated and free IPs in each range.
469 &quot;externalIpv6InstanceUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
470 &quot;totalAllocatedIp&quot;: {
471 &quot;high&quot;: &quot;A String&quot;,
472 &quot;low&quot;: &quot;A String&quot;,
473 },
474 &quot;totalFreeIp&quot;: {
475 &quot;high&quot;: &quot;A String&quot;,
476 &quot;low&quot;: &quot;A String&quot;,
477 },
478 },
479 &quot;externalIpv6LbUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
480 &quot;totalAllocatedIp&quot;: {
481 &quot;high&quot;: &quot;A String&quot;,
482 &quot;low&quot;: &quot;A String&quot;,
483 },
484 &quot;totalFreeIp&quot;: {
485 &quot;high&quot;: &quot;A String&quot;,
486 &quot;low&quot;: &quot;A String&quot;,
487 },
488 },
489 &quot;internalIpv6Utilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
490 &quot;totalAllocatedIp&quot;: {
491 &quot;high&quot;: &quot;A String&quot;,
492 &quot;low&quot;: &quot;A String&quot;,
493 },
494 &quot;totalFreeIp&quot;: {
495 &quot;high&quot;: &quot;A String&quot;,
496 &quot;low&quot;: &quot;A String&quot;,
497 },
498 },
499 &quot;ipv4Utilizations&quot;: [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name
500 # will be empty.
501 { # The IPV4 utilization of a single IP range.
502 &quot;rangeName&quot;: &quot;A String&quot;, # Will be set for secondary range. Empty for primary IPv4 range.
503 &quot;totalAllocatedIp&quot;: &quot;A String&quot;,
504 &quot;totalFreeIp&quot;: &quot;A String&quot;,
505 },
506 ],
507 },
508 },
509 ],
510 &quot;warning&quot;: { # An informational warning that appears when the list of addresses
511 # is empty.
512 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
513 # Engine returns NO_RESULTS_ON_PAGE if there
514 # are no results in the response.
515 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
516 # value format. For example:
517 #
518 # &quot;data&quot;: [
519 # {
520 # &quot;key&quot;: &quot;scope&quot;,
521 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
522 # }
523 {
524 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
525 # returned. For example, for warnings where there are no results in a list
526 # request for a particular zone, this key might be scope and
527 # the key value might be the zone name. Other examples might be a key
528 # indicating a deprecated resource and a suggested replacement, or a
529 # warning about invalid network settings (for example, if an instance
530 # attempts to perform IP forwarding but is not enabled for IP forwarding).
531 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
532 },
533 ],
534 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
535 },
536 },
537 },
538 &quot;kind&quot;: &quot;compute#subnetworkAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#subnetworkAggregatedList for aggregated lists of
539 # subnetworks.
540 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
541 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
542 # the query parameter pageToken in the next list request.
543 # Subsequent list requests will have their own nextPageToken to
544 # continue paging through the results.
545 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
546 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
547 &quot;A String&quot;,
548 ],
549 &quot;warning&quot;: { # [Output Only] Informational warning message.
550 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
551 # Engine returns NO_RESULTS_ON_PAGE if there
552 # are no results in the response.
553 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
554 # value format. For example:
555 #
556 # &quot;data&quot;: [
557 # {
558 # &quot;key&quot;: &quot;scope&quot;,
559 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
560 # }
561 {
562 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
563 # returned. For example, for warnings where there are no results in a list
564 # request for a particular zone, this key might be scope and
565 # the key value might be the zone name. Other examples might be a key
566 # indicating a deprecated resource and a suggested replacement, or a
567 # warning about invalid network settings (for example, if an instance
568 # attempts to perform IP forwarding but is not enabled for IP forwarding).
569 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
570 },
571 ],
572 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
573 },
574 }</pre>
575 </div>
576
577 <div class="method">
578 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
579 <pre>Retrieves the next page of results.
580
581 Args:
582 previous_request: The request for the previous page. (required)
583 previous_response: The response from the request for the previous page. (required)
584
585 Returns:
586 A request object that you can call &#x27;execute()&#x27; on to request the next
587 page. Returns None if there are no more items in the collection.
588 </pre>
589 </div>
590
591 <div class="method">
592 <code class="details" id="close">close()</code>
593 <pre>Close httplib2 connections.</pre>
594 </div>
595
596 <div class="method">
597 <code class="details" id="delete">delete(project, region, subnetwork, requestId=None, x__xgafv=None)</code>
598 <pre>Deletes the specified subnetwork.
599
600 Args:
601 project: string, Project ID for this request. (required)
602 region: string, Name of the region scoping this request. (required)
603 subnetwork: string, Name of the Subnetwork resource to delete. (required)
604 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
605 that if you must retry your request, the server will know to ignore the
606 request if it has already been completed.
607
608 For example, consider a situation where you make an initial request and
609 the request times out. If you make the request again with the same
610 request ID, the server can check if original operation with the same
611 request ID was received, and if so, will ignore the second request. This
612 prevents clients from accidentally creating duplicate commitments.
613
614 The request ID must be
615 a valid UUID with the exception that zero UUID is not supported
616 (00000000-0000-0000-0000-000000000000).
617 x__xgafv: string, V1 error format.
618 Allowed values
619 1 - v1 error format
620 2 - v2 error format
621
622 Returns:
623 An object of the form:
624
625 { # Represents an Operation resource.
626 #
627 # Google Compute Engine has three Operation resources:
628 #
629 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
630 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
631 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
632 #
633 # You can use an operation resource to manage asynchronous API requests.
634 # For more information, readHandling
635 # API responses.
636 #
637 # Operations can be global, regional or zonal.
638 #
639 # - For global operations, use the `globalOperations`
640 # resource.
641 # - For regional operations, use the
642 # `regionOperations` resource.
643 # - For zonal operations, use
644 # the `zoneOperations` resource.
645 #
646 #
647 #
648 # For more information, read
649 # Global, Regional, and Zonal Resources.
650 #
651 # Note that completed Operation resources have a limited
652 # retention period.
653 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
654 # Not present otherwise.
655 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
656 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
657 # set when the operation is created.
658 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
659 # text format.
660 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
661 # this field will be populated.
662 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
663 # operation.
664 {
665 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
666 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
667 # details. There is a set of defined message types to use for providing
668 # details.The syntax depends on the error code. For example,
669 # QuotaExceededInfo will have details when the error code is
670 # QUOTA_EXCEEDED.
671 {
672 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
673 #
674 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
675 # is not enabled:
676 #
677 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
678 # &quot;domain&quot;: &quot;googleapis.com&quot;
679 # &quot;metadata&quot;: {
680 # &quot;resource&quot;: &quot;projects/123&quot;,
681 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
682 # }
683 # }
684 #
685 # This response indicates that the pubsub.googleapis.com API is not enabled.
686 #
687 # Example of an error that is returned when attempting to create a Spanner
688 # instance in a region that is out of stock:
689 #
690 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
691 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
692 # &quot;metadata&quot;: {
693 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
694 # }
695 # }
696 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
697 # is typically the registered service name of the tool or product that
698 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
699 # generated by some common infrastructure, the error domain must be a
700 # globally unique value that identifies the infrastructure. For Google API
701 # infrastructure, the error domain is &quot;googleapis.com&quot;.
702 &quot;metadatas&quot;: { # Additional structured details about this error.
703 #
704 # Keys must match a regular expression of `a-z+` but should
705 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
706 # length. When identifying the current value of an exceeded limit, the units
707 # should be contained in the key, not the value. For example, rather than
708 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
709 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
710 # instances that can be created in a single (batch) request.
711 &quot;a_key&quot;: &quot;A String&quot;,
712 },
713 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
714 # proximate cause of the error. Error reasons are unique within a particular
715 # domain of errors. This should be at most 63 characters and match a
716 # regular expression of `A-Z+[A-Z0-9]`, which represents
717 # UPPER_SNAKE_CASE.
718 },
719 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
720 #
721 # For example, if a quota check failed with an error indicating the calling
722 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
723 # directly to the right place in the developer console to flip the bit.
724 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
725 { # Describes a URL link.
726 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
727 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
728 },
729 ],
730 },
731 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
732 # which can be attached to an RPC error.
733 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
734 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
735 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
736 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
737 },
738 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
739 &quot;dimensions&quot;: { # The map holding related quota dimensions.
740 &quot;a_key&quot;: &quot;A String&quot;,
741 },
742 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
743 # type or metric.
744 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
745 # or metric.
746 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
747 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
748 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
749 },
750 },
751 ],
752 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
753 # This property is optional.
754 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
755 },
756 ],
757 },
758 &quot;getVersionOperationMetadata&quot;: {
759 &quot;inlineSbomInfo&quot;: {
760 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
761 # appropriate identifiers.
762 &quot;a_key&quot;: &quot;A String&quot;,
763 },
764 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
765 # identifiers.
766 &quot;a_key&quot;: &quot;A String&quot;,
767 },
768 },
769 },
770 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
771 # message that was returned, such as `NOT FOUND`.
772 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
773 # status code that was returned. For example, a `404` means the
774 # resource was not found.
775 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
776 # defined by the server.
777 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
778 # This value is inRFC3339
779 # text format.
780 &quot;instancesBulkInsertOperationMetadata&quot;: {
781 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
782 # Example key: zones/us-central1-a
783 &quot;a_key&quot;: {
784 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
785 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
786 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
787 # error.
788 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
789 # if the flow is rolling forward or rolling back.
790 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
791 },
792 },
793 },
794 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
795 # Operation resources.
796 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
797 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
798 # group of operations results from a `bulkInsert` API request.
799 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
800 # `update`, or `delete`, and so on.
801 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
802 # There is no requirement that this be linear or support any granularity of
803 # operations. This should not be used to guess when the operation will be
804 # complete. This number should monotonically increase as the operation
805 # progresses.
806 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
807 # applicable when performing regional operations.
808 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
809 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
810 # this field will contain information on all underlying zonal actions and
811 # their state.
812 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
813 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
814 # Example key: zones/us-central1-a
815 &quot;a_key&quot;: {
816 &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
817 # populated.
818 # different programming environments, including REST APIs and RPC APIs. It is
819 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
820 # three pieces of data: error code, error message, and error details.
821 #
822 # You can find out more about this error model and how to work with it in the
823 # [API Design Guide](https://cloud.google.com/apis/design/errors).
824 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
825 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
826 # message types for APIs to use.
827 {
828 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
829 },
830 ],
831 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
832 # user-facing error message should be localized and sent in the
833 # google.rpc.Status.details field, or localized by the client.
834 },
835 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
836 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
837 },
838 },
839 },
840 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
841 # This value is inRFC3339
842 # text format.
843 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
844 # following:
845 # `PENDING`, `RUNNING`, or `DONE`.
846 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
847 # operation.
848 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
849 # of the target resource.
850 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
851 # operations related to creating a snapshot, this points to the disk
852 # that the snapshot was created from.
853 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
854 # `[email protected]` or
855 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
856 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
857 # operation, this field will be populated.
858 {
859 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
860 # Engine returns NO_RESULTS_ON_PAGE if there
861 # are no results in the response.
862 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
863 # value format. For example:
864 #
865 # &quot;data&quot;: [
866 # {
867 # &quot;key&quot;: &quot;scope&quot;,
868 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
869 # }
870 {
871 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
872 # returned. For example, for warnings where there are no results in a list
873 # request for a particular zone, this key might be scope and
874 # the key value might be the zone name. Other examples might be a key
875 # indicating a deprecated resource and a suggested replacement, or a
876 # warning about invalid network settings (for example, if an instance
877 # attempts to perform IP forwarding but is not enabled for IP forwarding).
878 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
879 },
880 ],
881 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
882 },
883 ],
884 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
885 # applicable when performing per-zone operations.
886 }</pre>
887 </div>
888
889 <div class="method">
890 <code class="details" id="expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body=None, requestId=None, x__xgafv=None)</code>
891 <pre>Expands the IP CIDR range of the subnetwork to a specified value.
892
893 Args:
894 project: string, Project ID for this request. (required)
895 region: string, Name of the region scoping this request. (required)
896 subnetwork: string, Name of the Subnetwork resource to update. (required)
897 body: object, The request body.
898 The object takes the form of:
899
900 {
901 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP (in CIDR format or netmask) of internal addresses that are legal on
902 # this Subnetwork. This range should be disjoint from other subnetworks
903 # within this network. This range can only be larger than (i.e. a superset
904 # of) the range previously defined before the update.
905 }
906
907 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
908 that if you must retry your request, the server will know to ignore the
909 request if it has already been completed.
910
911 For example, consider a situation where you make an initial request and
912 the request times out. If you make the request again with the same
913 request ID, the server can check if original operation with the same
914 request ID was received, and if so, will ignore the second request. This
915 prevents clients from accidentally creating duplicate commitments.
916
917 The request ID must be
918 a valid UUID with the exception that zero UUID is not supported
919 (00000000-0000-0000-0000-000000000000).
920 x__xgafv: string, V1 error format.
921 Allowed values
922 1 - v1 error format
923 2 - v2 error format
924
925 Returns:
926 An object of the form:
927
928 { # Represents an Operation resource.
929 #
930 # Google Compute Engine has three Operation resources:
931 #
932 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
933 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
934 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
935 #
936 # You can use an operation resource to manage asynchronous API requests.
937 # For more information, readHandling
938 # API responses.
939 #
940 # Operations can be global, regional or zonal.
941 #
942 # - For global operations, use the `globalOperations`
943 # resource.
944 # - For regional operations, use the
945 # `regionOperations` resource.
946 # - For zonal operations, use
947 # the `zoneOperations` resource.
948 #
949 #
950 #
951 # For more information, read
952 # Global, Regional, and Zonal Resources.
953 #
954 # Note that completed Operation resources have a limited
955 # retention period.
956 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
957 # Not present otherwise.
958 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
959 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
960 # set when the operation is created.
961 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
962 # text format.
963 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
964 # this field will be populated.
965 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
966 # operation.
967 {
968 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
969 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
970 # details. There is a set of defined message types to use for providing
971 # details.The syntax depends on the error code. For example,
972 # QuotaExceededInfo will have details when the error code is
973 # QUOTA_EXCEEDED.
974 {
975 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
976 #
977 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
978 # is not enabled:
979 #
980 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
981 # &quot;domain&quot;: &quot;googleapis.com&quot;
982 # &quot;metadata&quot;: {
983 # &quot;resource&quot;: &quot;projects/123&quot;,
984 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
985 # }
986 # }
987 #
988 # This response indicates that the pubsub.googleapis.com API is not enabled.
989 #
990 # Example of an error that is returned when attempting to create a Spanner
991 # instance in a region that is out of stock:
992 #
993 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
994 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
995 # &quot;metadata&quot;: {
996 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
997 # }
998 # }
999 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1000 # is typically the registered service name of the tool or product that
1001 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1002 # generated by some common infrastructure, the error domain must be a
1003 # globally unique value that identifies the infrastructure. For Google API
1004 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1005 &quot;metadatas&quot;: { # Additional structured details about this error.
1006 #
1007 # Keys must match a regular expression of `a-z+` but should
1008 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1009 # length. When identifying the current value of an exceeded limit, the units
1010 # should be contained in the key, not the value. For example, rather than
1011 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1012 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1013 # instances that can be created in a single (batch) request.
1014 &quot;a_key&quot;: &quot;A String&quot;,
1015 },
1016 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1017 # proximate cause of the error. Error reasons are unique within a particular
1018 # domain of errors. This should be at most 63 characters and match a
1019 # regular expression of `A-Z+[A-Z0-9]`, which represents
1020 # UPPER_SNAKE_CASE.
1021 },
1022 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1023 #
1024 # For example, if a quota check failed with an error indicating the calling
1025 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1026 # directly to the right place in the developer console to flip the bit.
1027 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1028 { # Describes a URL link.
1029 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1030 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1031 },
1032 ],
1033 },
1034 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1035 # which can be attached to an RPC error.
1036 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1037 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1038 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1039 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1040 },
1041 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1042 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1043 &quot;a_key&quot;: &quot;A String&quot;,
1044 },
1045 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1046 # type or metric.
1047 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1048 # or metric.
1049 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1050 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1051 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1052 },
1053 },
1054 ],
1055 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1056 # This property is optional.
1057 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1058 },
1059 ],
1060 },
1061 &quot;getVersionOperationMetadata&quot;: {
1062 &quot;inlineSbomInfo&quot;: {
1063 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1064 # appropriate identifiers.
1065 &quot;a_key&quot;: &quot;A String&quot;,
1066 },
1067 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1068 # identifiers.
1069 &quot;a_key&quot;: &quot;A String&quot;,
1070 },
1071 },
1072 },
1073 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1074 # message that was returned, such as `NOT FOUND`.
1075 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1076 # status code that was returned. For example, a `404` means the
1077 # resource was not found.
1078 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1079 # defined by the server.
1080 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1081 # This value is inRFC3339
1082 # text format.
1083 &quot;instancesBulkInsertOperationMetadata&quot;: {
1084 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1085 # Example key: zones/us-central1-a
1086 &quot;a_key&quot;: {
1087 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1088 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1089 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1090 # error.
1091 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1092 # if the flow is rolling forward or rolling back.
1093 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1094 },
1095 },
1096 },
1097 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1098 # Operation resources.
1099 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1100 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1101 # group of operations results from a `bulkInsert` API request.
1102 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1103 # `update`, or `delete`, and so on.
1104 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1105 # There is no requirement that this be linear or support any granularity of
1106 # operations. This should not be used to guess when the operation will be
1107 # complete. This number should monotonically increase as the operation
1108 # progresses.
1109 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1110 # applicable when performing regional operations.
1111 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1112 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1113 # this field will contain information on all underlying zonal actions and
1114 # their state.
1115 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1116 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1117 # Example key: zones/us-central1-a
1118 &quot;a_key&quot;: {
1119 &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
1120 # populated.
1121 # different programming environments, including REST APIs and RPC APIs. It is
1122 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1123 # three pieces of data: error code, error message, and error details.
1124 #
1125 # You can find out more about this error model and how to work with it in the
1126 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1127 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1128 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1129 # message types for APIs to use.
1130 {
1131 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1132 },
1133 ],
1134 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1135 # user-facing error message should be localized and sent in the
1136 # google.rpc.Status.details field, or localized by the client.
1137 },
1138 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1139 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1140 },
1141 },
1142 },
1143 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1144 # This value is inRFC3339
1145 # text format.
1146 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1147 # following:
1148 # `PENDING`, `RUNNING`, or `DONE`.
1149 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1150 # operation.
1151 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1152 # of the target resource.
1153 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1154 # operations related to creating a snapshot, this points to the disk
1155 # that the snapshot was created from.
1156 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1157 # `[email protected]` or
1158 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1159 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1160 # operation, this field will be populated.
1161 {
1162 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1163 # Engine returns NO_RESULTS_ON_PAGE if there
1164 # are no results in the response.
1165 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1166 # value format. For example:
1167 #
1168 # &quot;data&quot;: [
1169 # {
1170 # &quot;key&quot;: &quot;scope&quot;,
1171 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1172 # }
1173 {
1174 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1175 # returned. For example, for warnings where there are no results in a list
1176 # request for a particular zone, this key might be scope and
1177 # the key value might be the zone name. Other examples might be a key
1178 # indicating a deprecated resource and a suggested replacement, or a
1179 # warning about invalid network settings (for example, if an instance
1180 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1181 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1182 },
1183 ],
1184 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1185 },
1186 ],
1187 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1188 # applicable when performing per-zone operations.
1189 }</pre>
1190 </div>
1191
1192 <div class="method">
1193 <code class="details" id="get">get(project, region, subnetwork, views=None, x__xgafv=None)</code>
1194 <pre>Returns the specified subnetwork.
1195
1196 Args:
1197 project: string, Project ID for this request. (required)
1198 region: string, Name of the region scoping this request. (required)
1199 subnetwork: string, Name of the Subnetwork resource to return. (required)
1200 views: string, Defines the extra views returned back in the subnetwork resource.
1201 Supported values:
1202
1203 - WITH_UTILIZATION: Utilization data is included in the
1204 response. (repeated)
1205 Allowed values
1206 DEFAULT -
1207 WITH_UTILIZATION - Utilization data is included in the response.
1208 x__xgafv: string, V1 error format.
1209 Allowed values
1210 1 - v1 error format
1211 2 - v2 error format
1212
1213 Returns:
1214 An object of the form:
1215
1216 { # Represents a Subnetwork resource.
1217 #
1218 # A subnetwork (also known as a subnet) is a logical partition of a Virtual
1219 # Private Cloud network with one primary IP range and zero or more secondary
1220 # IP ranges. For more information, read
1221 # Virtual Private Cloud (VPC) Network.
1222 &quot;allowSubnetCidrRoutesOverlap&quot;: True or False, # Whether this subnetwork&#x27;s ranges can conflict with existing custom routes.
1223 # Setting this to true allows this subnetwork&#x27;s primary and secondary ranges
1224 # to overlap with (and contain) custom routes that have already been
1225 # configured on the corresponding network.
1226 #
1227 # For example if a static route has range 10.1.0.0/16, a subnet
1228 # range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
1229 #
1230 # Overlapping is only allowed on subnetwork operations; routes
1231 # whose ranges conflict with this subnetwork&#x27;s ranges won&#x27;t be allowed unless
1232 # route.allow_conflicting_subnetworks is set to true.
1233 #
1234 # Typically packets destined to IPs within the subnetwork (which may contain
1235 # private/sensitive data) are prevented from leaving the virtual network.
1236 # Setting this field to true will disable this feature.
1237 #
1238 # The default value is false and applies to all existing subnetworks and
1239 # automatically created subnetworks.
1240 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1241 # text format.
1242 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1243 # create the resource. This field can be set only at resource creation time.
1244 &quot;enableFlowLogs&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
1245 # explicitly set, it will not appear in get listings. If not set
1246 # the default behavior is determined by the org policy, if there is no org
1247 # policy specified, then it will default to disabled. This field isn&#x27;t
1248 # supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.
1249 &quot;externalIpv6Prefix&quot;: &quot;A String&quot;, # The external IPv6 address range that is owned by this
1250 # subnetwork.
1251 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1252 # This field is used in optimistic locking. This field will be ignored when
1253 # inserting a Subnetwork. An up-to-date fingerprint must be
1254 # provided in order to update the Subnetwork, otherwise the
1255 # request will fail with error 412 conditionNotMet.
1256 #
1257 # To see the latest fingerprint, make a get() request to
1258 # retrieve a Subnetwork.
1259 &quot;gatewayAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] The gateway address for default routes to reach destination
1260 # addresses outside this subnetwork.
1261 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1262 # defined by the server.
1263 &quot;internalIpv6Prefix&quot;: &quot;A String&quot;, # The internal IPv6 address range that is owned by this
1264 # subnetwork.
1265 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of internal addresses that are owned by this subnetwork.
1266 # Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
1267 # be unique and non-overlapping within a network. Only IPv4 is supported.
1268 # This field is set at resource creation time. The range can be any range
1269 # listed in theValid
1270 # ranges list. The range can be expanded after creation usingexpandIpCidrRange.
1271 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to the source of IP, like a PublicDelegatedPrefix
1272 # (PDP) for BYOIP. The PDP must be a sub-PDP in
1273 # EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
1274 # mode.
1275 #
1276 # Use one of the following formats to specify a sub-PDP when creating a dual
1277 # stack or IPv6-only subnetwork with external access using BYOIP:
1278 #
1279 # -
1280 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
1281 # -
1282 # Partial URL, as in
1283 #
1284 #
1285 # - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
1286 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
1287 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The access type of IPv6 address this subnet holds. It&#x27;s immutable and can
1288 # only be specified during creation or the first time the subnet is updated
1289 # into IPV4_IPV6 dual stack.
1290 &quot;ipv6CidrRange&quot;: &quot;A String&quot;, # Output only. [Output Only] This field is for internal use.
1291 &quot;ipv6GceEndpoint&quot;: &quot;A String&quot;, # Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the
1292 # following:
1293 #
1294 # - VM_ONLY: The subnetwork can be used for creating instances and
1295 # IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6
1296 # ranges from a public delegated prefix and cannot be used to create NetLb.
1297 # - VM_AND_FR: The subnetwork can be used for creating both VM
1298 # instances and Forwarding Rules. It can also be used to reserve IPv6
1299 # addresses with both VM and FR endpoint types. Such a subnetwork gets its
1300 # IPv6 range from Google IP Pool directly.
1301 &quot;kind&quot;: &quot;compute#subnetwork&quot;, # Output only. [Output Only] Type of the resource. Always compute#subnetwork
1302 # for Subnetwork resources.
1303 &quot;logConfig&quot;: { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork.
1304 # If logging is enabled, logs are exported to Cloud Logging.
1305 &quot;aggregationInterval&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logging for this subnetwork is enabled.
1306 # Toggles the aggregation interval for collecting flow logs. Increasing the
1307 # interval time will reduce the amount of generated flow logs for long
1308 # lasting connections. Default is an interval of 5 seconds per connection.
1309 &quot;enable&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
1310 # explicitly set, it will not appear in get listings. If not
1311 # set the default behavior is determined by the org policy, if there is no
1312 # org policy specified, then it will default to disabled.
1313 # Flow logging isn&#x27;t supported if the subnet purpose field is
1314 # set to REGIONAL_MANAGED_PROXY.
1315 &quot;filterExpr&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
1316 # The filter expression is used to define which VPC flow logs should be
1317 # exported to Cloud Logging.
1318 &quot;flowSampling&quot;: 3.14, # Can only be specified if VPC flow logging for this subnetwork is enabled.
1319 # The value of the field must be in [0, 1]. Set the sampling rate of VPC
1320 # flow logs within the subnetwork where 1.0 means all collected logs are
1321 # reported and 0.0 means no logs are reported. Default is 0.5 unless
1322 # otherwise specified by the org policy, which means half of all collected
1323 # logs are reported.
1324 &quot;metadata&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
1325 # Configures whether all, none or a subset of metadata fields should be
1326 # added to the reported VPC flow logs. Default isEXCLUDE_ALL_METADATA.
1327 &quot;metadataFields&quot;: [ # Can only be specified if VPC flow logs for this subnetwork is enabled and
1328 # &quot;metadata&quot; was set to CUSTOM_METADATA.
1329 &quot;A String&quot;,
1330 ],
1331 },
1332 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1333 # the resource. The name must be 1-63 characters long, and comply withRFC1035.
1334 # Specifically, the name must be 1-63 characters long and match the regular
1335 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1336 # character must be a lowercase letter, and all following characters must
1337 # be a dash, lowercase letter, or digit, except the last character, which
1338 # cannot be a dash.
1339 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this subnetwork belongs, provided by the
1340 # client when initially creating the subnetwork. This field can be set only
1341 # at resource creation time.
1342 &quot;params&quot;: { # Additional subnetwork parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1343 # as part of resource payload.
1344 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1345 # Tag keys and values have the same definition as resource
1346 # manager tags. The field is allowed for INSERT
1347 # only. The keys/values to set on the resource should be specified in
1348 # either ID { : } or Namespaced format
1349 # { : }.
1350 # For example the following are valid inputs:
1351 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1352 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1353 # Note:
1354 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1355 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1356 &quot;a_key&quot;: &quot;A String&quot;,
1357 },
1358 },
1359 &quot;privateIpGoogleAccess&quot;: True or False, # Whether the VMs in this subnet can access Google services without assigned
1360 # external IP addresses. This field can be both set at resource creation
1361 # time and updated using setPrivateIpGoogleAccess.
1362 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # This field is for internal use.
1363 #
1364 # This field can be both set at resource creation time and updated usingpatch.
1365 &quot;purpose&quot;: &quot;A String&quot;,
1366 &quot;region&quot;: &quot;A String&quot;, # URL of the region where the Subnetwork resides. This
1367 # field can be set only at resource creation time.
1368 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range.
1369 &quot;resolveSubnetMask&quot;: &quot;A String&quot;, # Configures subnet mask resolution for this subnetwork.
1370 &quot;role&quot;: &quot;A String&quot;, # The role of subnetwork. Currently, this field is only used when
1371 # purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
1372 # subnetwork is one that is currently being used for Envoy-based load
1373 # balancers in a region. A BACKUP subnetwork is one that is
1374 # ready to be promoted to ACTIVE or is currently draining.
1375 # This field can be updated with a patch request.
1376 &quot;secondaryIpRanges&quot;: [ # An array of configurations for secondary IP ranges for VM instances
1377 # contained in this subnetwork. The primary IP of such VM must belong to the
1378 # primary ipCidrRange of the subnetwork. The alias IPs may belong to either
1379 # primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.
1380 { # Represents a secondary IP range of a subnetwork.
1381 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of IP addresses belonging to this subnetwork secondary range.
1382 # Provide this property when you create the subnetwork. Ranges must be
1383 # unique and non-overlapping with all primary and secondary IP ranges
1384 # within a network. Both IPv4 and IPv6 ranges are supported. For IPv4,
1385 # the range can be any range listed in theValid
1386 # ranges list.
1387 #
1388 # For IPv6:
1389 # The range must have a /64 prefix length.
1390 # The range must be omitted, for auto-allocation from Google-defined ULA
1391 # IPv6 range.
1392 # For BYOGUA internal IPv6 secondary range, the range may be specified
1393 # along with the `ipCollection` field.
1394 # If an `ipCollection` is specified, the requested ip_cidr_range must lie
1395 # within the range of the PDP referenced by the `ipCollection` field for
1396 # allocation.
1397 # If `ipCollection` field is specified, but ip_cidr_range is not,
1398 # the range is auto-allocated from the PDP referenced by the `ipCollection`
1399 # field.
1400 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to a Public Delegated Prefix (PDP) for BYOIP.
1401 # This field should be specified for configuring BYOGUA internal IPv6
1402 # secondary range.
1403 # When specified along with the ip_cidr_range, the ip_cidr_range must lie
1404 # within the PDP referenced by the `ipCollection` field.
1405 # When specified without the ip_cidr_range, the range is auto-allocated
1406 # from the PDP referenced by the `ipCollection` field.
1407 &quot;ipVersion&quot;: &quot;A String&quot;,
1408 &quot;rangeName&quot;: &quot;A String&quot;, # The name associated with this subnetwork secondary range, used when adding
1409 # an alias IP/IPv6 range to a VM instance.
1410 # The name must be 1-63 characters long, and comply withRFC1035.
1411 # The name must be unique within the subnetwork.
1412 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range. Only IPv4 is supported.
1413 },
1414 ],
1415 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1416 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for the subnet. If set to IPV4_ONLY, new VMs
1417 # in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
1418 # IPv6 addresses. If not specified, IPV4_ONLY is used.
1419 #
1420 # This field can be both set at resource creation time and updated usingpatch.
1421 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the subnetwork, which can be one of the
1422 # following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
1423 # purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
1424 # connections to the load balancer are being drained. A subnetwork that is
1425 # draining cannot be used or modified until it reaches a status ofREADY
1426 &quot;systemReservedExternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of external IPv6 network ranges reserved from
1427 # the subnetwork&#x27;s external IPv6 range for system use.
1428 &quot;A String&quot;,
1429 ],
1430 &quot;systemReservedInternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from
1431 # the subnetwork&#x27;s internal IPv6 range for system use.
1432 &quot;A String&quot;,
1433 ],
1434 &quot;utilizationDetails&quot;: { # The current IP utilization of all subnetwork ranges. Contains the total # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains
1435 # the total number of allocated and free IPs in each range.
1436 # number of allocated and free IPs in each range.
1437 &quot;externalIpv6InstanceUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
1438 &quot;totalAllocatedIp&quot;: {
1439 &quot;high&quot;: &quot;A String&quot;,
1440 &quot;low&quot;: &quot;A String&quot;,
1441 },
1442 &quot;totalFreeIp&quot;: {
1443 &quot;high&quot;: &quot;A String&quot;,
1444 &quot;low&quot;: &quot;A String&quot;,
1445 },
1446 },
1447 &quot;externalIpv6LbUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
1448 &quot;totalAllocatedIp&quot;: {
1449 &quot;high&quot;: &quot;A String&quot;,
1450 &quot;low&quot;: &quot;A String&quot;,
1451 },
1452 &quot;totalFreeIp&quot;: {
1453 &quot;high&quot;: &quot;A String&quot;,
1454 &quot;low&quot;: &quot;A String&quot;,
1455 },
1456 },
1457 &quot;internalIpv6Utilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
1458 &quot;totalAllocatedIp&quot;: {
1459 &quot;high&quot;: &quot;A String&quot;,
1460 &quot;low&quot;: &quot;A String&quot;,
1461 },
1462 &quot;totalFreeIp&quot;: {
1463 &quot;high&quot;: &quot;A String&quot;,
1464 &quot;low&quot;: &quot;A String&quot;,
1465 },
1466 },
1467 &quot;ipv4Utilizations&quot;: [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name
1468 # will be empty.
1469 { # The IPV4 utilization of a single IP range.
1470 &quot;rangeName&quot;: &quot;A String&quot;, # Will be set for secondary range. Empty for primary IPv4 range.
1471 &quot;totalAllocatedIp&quot;: &quot;A String&quot;,
1472 &quot;totalFreeIp&quot;: &quot;A String&quot;,
1473 },
1474 ],
1475 },
1476 }</pre>
1477 </div>
1478
1479 <div class="method">
1480 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1481 <pre>Gets the access control policy for a resource. May be empty if no such
1482 policy or resource exists.
1483
1484 Args:
1485 project: string, Project ID for this request. (required)
1486 region: string, The name of the region for this request. (required)
1487 resource: string, Name or id of the resource for this request. (required)
1488 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1489 x__xgafv: string, V1 error format.
1490 Allowed values
1491 1 - v1 error format
1492 2 - v2 error format
1493
1494 Returns:
1495 An object of the form:
1496
1497 { # An Identity and Access Management (IAM) policy, which specifies access
1498 # controls for Google Cloud resources.
1499 #
1500 #
1501 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1502 # `members`, or principals, to a single `role`. Principals can be user
1503 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1504 # `role` is a named list of permissions; each `role` can be an IAM predefined
1505 # role or a user-created custom role.
1506 #
1507 # For some types of Google Cloud resources, a `binding` can also specify a
1508 # `condition`, which is a logical expression that allows access to a resource
1509 # only if the expression evaluates to `true`. A condition can add constraints
1510 # based on attributes of the request, the resource, or both. To learn which
1511 # resources support conditions in their IAM policies, see the
1512 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1513 #
1514 # **JSON example:**
1515 #
1516 # ```
1517 # {
1518 # &quot;bindings&quot;: [
1519 # {
1520 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1521 # &quot;members&quot;: [
1522 # &quot;user:[email protected]&quot;,
1523 # &quot;group:[email protected]&quot;,
1524 # &quot;domain:google.com&quot;,
1525 # &quot;serviceAccount:[email protected]&quot;
1526 # ]
1527 # },
1528 # {
1529 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1530 # &quot;members&quot;: [
1531 # &quot;user:[email protected]&quot;
1532 # ],
1533 # &quot;condition&quot;: {
1534 # &quot;title&quot;: &quot;expirable access&quot;,
1535 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1536 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1537 # }
1538 # }
1539 # ],
1540 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1541 # &quot;version&quot;: 3
1542 # }
1543 # ```
1544 #
1545 # **YAML example:**
1546 #
1547 # ```
1548 # bindings:
1549 # - members:
1550 # - user:[email protected]
1551 # - group:[email protected]
1552 # - domain:google.com
1553 # - serviceAccount:[email protected]
1554 # role: roles/resourcemanager.organizationAdmin
1555 # - members:
1556 # - user:[email protected]
1557 # role: roles/resourcemanager.organizationViewer
1558 # condition:
1559 # title: expirable access
1560 # description: Does not grant access after Sep 2020
1561 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1562 # etag: BwWWja0YfJA=
1563 # version: 3
1564 # ```
1565 #
1566 # For a description of IAM and its features, see the
1567 # [IAM documentation](https://cloud.google.com/iam/docs/).
1568 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1569 { # Specifies the audit configuration for a service.
1570 # The configuration determines which permission types are logged, and what
1571 # identities, if any, are exempted from logging.
1572 # An AuditConfig must have one or more AuditLogConfigs.
1573 #
1574 # If there are AuditConfigs for both `allServices` and a specific service,
1575 # the union of the two AuditConfigs is used for that service: the log_types
1576 # specified in each AuditConfig are enabled, and the exempted_members in each
1577 # AuditLogConfig are exempted.
1578 #
1579 # Example Policy with multiple AuditConfigs:
1580 #
1581 # {
1582 # &quot;audit_configs&quot;: [
1583 # {
1584 # &quot;service&quot;: &quot;allServices&quot;,
1585 # &quot;audit_log_configs&quot;: [
1586 # {
1587 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1588 # &quot;exempted_members&quot;: [
1589 # &quot;user:[email protected]&quot;
1590 # ]
1591 # },
1592 # {
1593 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1594 # },
1595 # {
1596 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1597 # }
1598 # ]
1599 # },
1600 # {
1601 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1602 # &quot;audit_log_configs&quot;: [
1603 # {
1604 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1605 # },
1606 # {
1607 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1608 # &quot;exempted_members&quot;: [
1609 # &quot;user:[email protected]&quot;
1610 # ]
1611 # }
1612 # ]
1613 # }
1614 # ]
1615 # }
1616 #
1617 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1618 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1619 # `[email protected]` from DATA_WRITE logging.
1620 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1621 { # Provides the configuration for logging a type of permissions.
1622 # Example:
1623 #
1624 # {
1625 # &quot;audit_log_configs&quot;: [
1626 # {
1627 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1628 # &quot;exempted_members&quot;: [
1629 # &quot;user:[email protected]&quot;
1630 # ]
1631 # },
1632 # {
1633 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1634 # }
1635 # ]
1636 # }
1637 #
1638 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1639 # [email protected] from DATA_READ logging.
1640 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1641 # permission.
1642 # Follows the same format of Binding.members.
1643 &quot;A String&quot;,
1644 ],
1645 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1646 },
1647 ],
1648 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1649 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1650 # `allServices` is a special value that covers all services.
1651 },
1652 ],
1653 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1654 # may specify a `condition` that determines how and when the `bindings` are
1655 # applied. Each of the `bindings` must contain at least one principal.
1656 #
1657 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1658 # of these principals can be Google groups. Each occurrence of a principal
1659 # counts towards these limits. For example, if the `bindings` grant 50
1660 # different roles to `user:[email protected]`, and not to any other
1661 # principal, then you can add another 1,450 principals to the `bindings` in
1662 # the `Policy`.
1663 { # Associates `members`, or principals, with a `role`.
1664 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1665 #
1666 # If the condition evaluates to `true`, then this binding applies to the
1667 # current request.
1668 #
1669 # If the condition evaluates to `false`, then this binding does not apply to
1670 # the current request. However, a different role binding might grant the same
1671 # role to one or more of the principals in this binding.
1672 #
1673 # To learn which resources support conditions in their IAM policies, see the
1674 # [IAM
1675 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1676 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1677 # are documented at https://github.com/google/cel-spec.
1678 #
1679 # Example (Comparison):
1680 #
1681 # title: &quot;Summary size limit&quot;
1682 # description: &quot;Determines if a summary is less than 100 chars&quot;
1683 # expression: &quot;document.summary.size() &lt; 100&quot;
1684 #
1685 # Example (Equality):
1686 #
1687 # title: &quot;Requestor is owner&quot;
1688 # description: &quot;Determines if requestor is the document owner&quot;
1689 # expression: &quot;document.owner == request.auth.claims.email&quot;
1690 #
1691 # Example (Logic):
1692 #
1693 # title: &quot;Public documents&quot;
1694 # description: &quot;Determine whether the document should be publicly visible&quot;
1695 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1696 #
1697 # Example (Data Manipulation):
1698 #
1699 # title: &quot;Notification string&quot;
1700 # description: &quot;Create a notification string with a timestamp.&quot;
1701 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1702 #
1703 # The exact variables and functions that may be referenced within an expression
1704 # are determined by the service that evaluates it. See the service
1705 # documentation for additional information.
1706 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1707 # describes the expression, e.g. when hovered over it in a UI.
1708 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1709 # syntax.
1710 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1711 # reporting, e.g. a file name and a position in the file.
1712 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1713 # its purpose. This can be used e.g. in UIs which allow to enter the
1714 # expression.
1715 },
1716 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1717 # `members` can have the following values:
1718 #
1719 # * `allUsers`: A special identifier that represents anyone who is
1720 # on the internet; with or without a Google account.
1721 #
1722 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1723 # who is authenticated with a Google account or a service account.
1724 # Does not include identities that come from external identity providers
1725 # (IdPs) through identity federation.
1726 #
1727 # * `user:{emailid}`: An email address that represents a specific Google
1728 # account. For example, `[email protected]` .
1729 #
1730 #
1731 # * `serviceAccount:{emailid}`: An email address that represents a Google
1732 # service account. For example,
1733 # `[email protected]`.
1734 #
1735 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1736 # identifier for a
1737 # [Kubernetes service
1738 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1739 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1740 #
1741 # * `group:{emailid}`: An email address that represents a Google group.
1742 # For example, `[email protected]`.
1743 #
1744 #
1745 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1746 # users of that domain. For example, `google.com` or `example.com`.
1747 #
1748 #
1749 #
1750 #
1751 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1752 # A single identity in a workforce identity pool.
1753 #
1754 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1755 # All workforce identities in a group.
1756 #
1757 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1758 # All workforce identities with a specific attribute value.
1759 #
1760 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1761 # All identities in a workforce identity pool.
1762 #
1763 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1764 # A single identity in a workload identity pool.
1765 #
1766 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1767 # A workload identity pool group.
1768 #
1769 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1770 # All identities in a workload identity pool with a certain attribute.
1771 #
1772 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1773 # All identities in a workload identity pool.
1774 #
1775 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1776 # identifier) representing a user that has been recently deleted. For
1777 # example, `[email protected]?uid=123456789012345678901`. If the user is
1778 # recovered, this value reverts to `user:{emailid}` and the recovered user
1779 # retains the role in the binding.
1780 #
1781 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1782 # unique identifier) representing a service account that has been recently
1783 # deleted. For example,
1784 # `[email protected]?uid=123456789012345678901`.
1785 # If the service account is undeleted, this value reverts to
1786 # `serviceAccount:{emailid}` and the undeleted service account retains the
1787 # role in the binding.
1788 #
1789 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1790 # identifier) representing a Google group that has been recently
1791 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1792 # the group is recovered, this value reverts to `group:{emailid}` and the
1793 # recovered group retains the role in the binding.
1794 #
1795 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1796 # Deleted single identity in a workforce identity pool. For example,
1797 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1798 &quot;A String&quot;,
1799 ],
1800 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1801 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1802 #
1803 # For an overview of the IAM roles and permissions, see the
1804 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1805 # a list of the available pre-defined roles, see
1806 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1807 },
1808 ],
1809 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1810 # prevent simultaneous updates of a policy from overwriting each other.
1811 # It is strongly suggested that systems make use of the `etag` in the
1812 # read-modify-write cycle to perform policy updates in order to avoid race
1813 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1814 # systems are expected to put that etag in the request to `setIamPolicy` to
1815 # ensure that their change will be applied to the same version of the policy.
1816 #
1817 # **Important:** If you use IAM Conditions, you must include the `etag` field
1818 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1819 # you to overwrite a version `3` policy with a version `1` policy, and all of
1820 # the conditions in the version `3` policy are lost.
1821 &quot;version&quot;: 42, # Specifies the format of the policy.
1822 #
1823 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1824 # are rejected.
1825 #
1826 # Any operation that affects conditional role bindings must specify version
1827 # `3`. This requirement applies to the following operations:
1828 #
1829 # * Getting a policy that includes a conditional role binding
1830 # * Adding a conditional role binding to a policy
1831 # * Changing a conditional role binding in a policy
1832 # * Removing any role binding, with or without a condition, from a policy
1833 # that includes conditions
1834 #
1835 # **Important:** If you use IAM Conditions, you must include the `etag` field
1836 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1837 # you to overwrite a version `3` policy with a version `1` policy, and all of
1838 # the conditions in the version `3` policy are lost.
1839 #
1840 # If a policy does not include any conditions, operations on that policy may
1841 # specify any valid version or leave the field unset.
1842 #
1843 # To learn which resources support conditions in their IAM policies, see the
1844 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1845 }</pre>
1846 </div>
1847
1848 <div class="method">
1849 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
1850 <pre>Creates a subnetwork in the specified project using the data
1851 included in the request.
1852
1853 Args:
1854 project: string, Project ID for this request. (required)
1855 region: string, Name of the region scoping this request. (required)
1856 body: object, The request body.
1857 The object takes the form of:
1858
1859 { # Represents a Subnetwork resource.
1860 #
1861 # A subnetwork (also known as a subnet) is a logical partition of a Virtual
1862 # Private Cloud network with one primary IP range and zero or more secondary
1863 # IP ranges. For more information, read
1864 # Virtual Private Cloud (VPC) Network.
1865 &quot;allowSubnetCidrRoutesOverlap&quot;: True or False, # Whether this subnetwork&#x27;s ranges can conflict with existing custom routes.
1866 # Setting this to true allows this subnetwork&#x27;s primary and secondary ranges
1867 # to overlap with (and contain) custom routes that have already been
1868 # configured on the corresponding network.
1869 #
1870 # For example if a static route has range 10.1.0.0/16, a subnet
1871 # range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
1872 #
1873 # Overlapping is only allowed on subnetwork operations; routes
1874 # whose ranges conflict with this subnetwork&#x27;s ranges won&#x27;t be allowed unless
1875 # route.allow_conflicting_subnetworks is set to true.
1876 #
1877 # Typically packets destined to IPs within the subnetwork (which may contain
1878 # private/sensitive data) are prevented from leaving the virtual network.
1879 # Setting this field to true will disable this feature.
1880 #
1881 # The default value is false and applies to all existing subnetworks and
1882 # automatically created subnetworks.
1883 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1884 # text format.
1885 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1886 # create the resource. This field can be set only at resource creation time.
1887 &quot;enableFlowLogs&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
1888 # explicitly set, it will not appear in get listings. If not set
1889 # the default behavior is determined by the org policy, if there is no org
1890 # policy specified, then it will default to disabled. This field isn&#x27;t
1891 # supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.
1892 &quot;externalIpv6Prefix&quot;: &quot;A String&quot;, # The external IPv6 address range that is owned by this
1893 # subnetwork.
1894 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1895 # This field is used in optimistic locking. This field will be ignored when
1896 # inserting a Subnetwork. An up-to-date fingerprint must be
1897 # provided in order to update the Subnetwork, otherwise the
1898 # request will fail with error 412 conditionNotMet.
1899 #
1900 # To see the latest fingerprint, make a get() request to
1901 # retrieve a Subnetwork.
1902 &quot;gatewayAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] The gateway address for default routes to reach destination
1903 # addresses outside this subnetwork.
1904 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1905 # defined by the server.
1906 &quot;internalIpv6Prefix&quot;: &quot;A String&quot;, # The internal IPv6 address range that is owned by this
1907 # subnetwork.
1908 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of internal addresses that are owned by this subnetwork.
1909 # Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
1910 # be unique and non-overlapping within a network. Only IPv4 is supported.
1911 # This field is set at resource creation time. The range can be any range
1912 # listed in theValid
1913 # ranges list. The range can be expanded after creation usingexpandIpCidrRange.
1914 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to the source of IP, like a PublicDelegatedPrefix
1915 # (PDP) for BYOIP. The PDP must be a sub-PDP in
1916 # EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
1917 # mode.
1918 #
1919 # Use one of the following formats to specify a sub-PDP when creating a dual
1920 # stack or IPv6-only subnetwork with external access using BYOIP:
1921 #
1922 # -
1923 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
1924 # -
1925 # Partial URL, as in
1926 #
1927 #
1928 # - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
1929 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
1930 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The access type of IPv6 address this subnet holds. It&#x27;s immutable and can
1931 # only be specified during creation or the first time the subnet is updated
1932 # into IPV4_IPV6 dual stack.
1933 &quot;ipv6CidrRange&quot;: &quot;A String&quot;, # Output only. [Output Only] This field is for internal use.
1934 &quot;ipv6GceEndpoint&quot;: &quot;A String&quot;, # Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the
1935 # following:
1936 #
1937 # - VM_ONLY: The subnetwork can be used for creating instances and
1938 # IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6
1939 # ranges from a public delegated prefix and cannot be used to create NetLb.
1940 # - VM_AND_FR: The subnetwork can be used for creating both VM
1941 # instances and Forwarding Rules. It can also be used to reserve IPv6
1942 # addresses with both VM and FR endpoint types. Such a subnetwork gets its
1943 # IPv6 range from Google IP Pool directly.
1944 &quot;kind&quot;: &quot;compute#subnetwork&quot;, # Output only. [Output Only] Type of the resource. Always compute#subnetwork
1945 # for Subnetwork resources.
1946 &quot;logConfig&quot;: { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork.
1947 # If logging is enabled, logs are exported to Cloud Logging.
1948 &quot;aggregationInterval&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logging for this subnetwork is enabled.
1949 # Toggles the aggregation interval for collecting flow logs. Increasing the
1950 # interval time will reduce the amount of generated flow logs for long
1951 # lasting connections. Default is an interval of 5 seconds per connection.
1952 &quot;enable&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
1953 # explicitly set, it will not appear in get listings. If not
1954 # set the default behavior is determined by the org policy, if there is no
1955 # org policy specified, then it will default to disabled.
1956 # Flow logging isn&#x27;t supported if the subnet purpose field is
1957 # set to REGIONAL_MANAGED_PROXY.
1958 &quot;filterExpr&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
1959 # The filter expression is used to define which VPC flow logs should be
1960 # exported to Cloud Logging.
1961 &quot;flowSampling&quot;: 3.14, # Can only be specified if VPC flow logging for this subnetwork is enabled.
1962 # The value of the field must be in [0, 1]. Set the sampling rate of VPC
1963 # flow logs within the subnetwork where 1.0 means all collected logs are
1964 # reported and 0.0 means no logs are reported. Default is 0.5 unless
1965 # otherwise specified by the org policy, which means half of all collected
1966 # logs are reported.
1967 &quot;metadata&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
1968 # Configures whether all, none or a subset of metadata fields should be
1969 # added to the reported VPC flow logs. Default isEXCLUDE_ALL_METADATA.
1970 &quot;metadataFields&quot;: [ # Can only be specified if VPC flow logs for this subnetwork is enabled and
1971 # &quot;metadata&quot; was set to CUSTOM_METADATA.
1972 &quot;A String&quot;,
1973 ],
1974 },
1975 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1976 # the resource. The name must be 1-63 characters long, and comply withRFC1035.
1977 # Specifically, the name must be 1-63 characters long and match the regular
1978 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1979 # character must be a lowercase letter, and all following characters must
1980 # be a dash, lowercase letter, or digit, except the last character, which
1981 # cannot be a dash.
1982 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this subnetwork belongs, provided by the
1983 # client when initially creating the subnetwork. This field can be set only
1984 # at resource creation time.
1985 &quot;params&quot;: { # Additional subnetwork parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1986 # as part of resource payload.
1987 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1988 # Tag keys and values have the same definition as resource
1989 # manager tags. The field is allowed for INSERT
1990 # only. The keys/values to set on the resource should be specified in
1991 # either ID { : } or Namespaced format
1992 # { : }.
1993 # For example the following are valid inputs:
1994 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1995 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1996 # Note:
1997 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1998 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1999 &quot;a_key&quot;: &quot;A String&quot;,
2000 },
2001 },
2002 &quot;privateIpGoogleAccess&quot;: True or False, # Whether the VMs in this subnet can access Google services without assigned
2003 # external IP addresses. This field can be both set at resource creation
2004 # time and updated using setPrivateIpGoogleAccess.
2005 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # This field is for internal use.
2006 #
2007 # This field can be both set at resource creation time and updated usingpatch.
2008 &quot;purpose&quot;: &quot;A String&quot;,
2009 &quot;region&quot;: &quot;A String&quot;, # URL of the region where the Subnetwork resides. This
2010 # field can be set only at resource creation time.
2011 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range.
2012 &quot;resolveSubnetMask&quot;: &quot;A String&quot;, # Configures subnet mask resolution for this subnetwork.
2013 &quot;role&quot;: &quot;A String&quot;, # The role of subnetwork. Currently, this field is only used when
2014 # purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
2015 # subnetwork is one that is currently being used for Envoy-based load
2016 # balancers in a region. A BACKUP subnetwork is one that is
2017 # ready to be promoted to ACTIVE or is currently draining.
2018 # This field can be updated with a patch request.
2019 &quot;secondaryIpRanges&quot;: [ # An array of configurations for secondary IP ranges for VM instances
2020 # contained in this subnetwork. The primary IP of such VM must belong to the
2021 # primary ipCidrRange of the subnetwork. The alias IPs may belong to either
2022 # primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.
2023 { # Represents a secondary IP range of a subnetwork.
2024 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of IP addresses belonging to this subnetwork secondary range.
2025 # Provide this property when you create the subnetwork. Ranges must be
2026 # unique and non-overlapping with all primary and secondary IP ranges
2027 # within a network. Both IPv4 and IPv6 ranges are supported. For IPv4,
2028 # the range can be any range listed in theValid
2029 # ranges list.
2030 #
2031 # For IPv6:
2032 # The range must have a /64 prefix length.
2033 # The range must be omitted, for auto-allocation from Google-defined ULA
2034 # IPv6 range.
2035 # For BYOGUA internal IPv6 secondary range, the range may be specified
2036 # along with the `ipCollection` field.
2037 # If an `ipCollection` is specified, the requested ip_cidr_range must lie
2038 # within the range of the PDP referenced by the `ipCollection` field for
2039 # allocation.
2040 # If `ipCollection` field is specified, but ip_cidr_range is not,
2041 # the range is auto-allocated from the PDP referenced by the `ipCollection`
2042 # field.
2043 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to a Public Delegated Prefix (PDP) for BYOIP.
2044 # This field should be specified for configuring BYOGUA internal IPv6
2045 # secondary range.
2046 # When specified along with the ip_cidr_range, the ip_cidr_range must lie
2047 # within the PDP referenced by the `ipCollection` field.
2048 # When specified without the ip_cidr_range, the range is auto-allocated
2049 # from the PDP referenced by the `ipCollection` field.
2050 &quot;ipVersion&quot;: &quot;A String&quot;,
2051 &quot;rangeName&quot;: &quot;A String&quot;, # The name associated with this subnetwork secondary range, used when adding
2052 # an alias IP/IPv6 range to a VM instance.
2053 # The name must be 1-63 characters long, and comply withRFC1035.
2054 # The name must be unique within the subnetwork.
2055 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range. Only IPv4 is supported.
2056 },
2057 ],
2058 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2059 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for the subnet. If set to IPV4_ONLY, new VMs
2060 # in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
2061 # IPv6 addresses. If not specified, IPV4_ONLY is used.
2062 #
2063 # This field can be both set at resource creation time and updated usingpatch.
2064 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the subnetwork, which can be one of the
2065 # following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
2066 # purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
2067 # connections to the load balancer are being drained. A subnetwork that is
2068 # draining cannot be used or modified until it reaches a status ofREADY
2069 &quot;systemReservedExternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of external IPv6 network ranges reserved from
2070 # the subnetwork&#x27;s external IPv6 range for system use.
2071 &quot;A String&quot;,
2072 ],
2073 &quot;systemReservedInternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from
2074 # the subnetwork&#x27;s internal IPv6 range for system use.
2075 &quot;A String&quot;,
2076 ],
2077 &quot;utilizationDetails&quot;: { # The current IP utilization of all subnetwork ranges. Contains the total # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains
2078 # the total number of allocated and free IPs in each range.
2079 # number of allocated and free IPs in each range.
2080 &quot;externalIpv6InstanceUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
2081 &quot;totalAllocatedIp&quot;: {
2082 &quot;high&quot;: &quot;A String&quot;,
2083 &quot;low&quot;: &quot;A String&quot;,
2084 },
2085 &quot;totalFreeIp&quot;: {
2086 &quot;high&quot;: &quot;A String&quot;,
2087 &quot;low&quot;: &quot;A String&quot;,
2088 },
2089 },
2090 &quot;externalIpv6LbUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
2091 &quot;totalAllocatedIp&quot;: {
2092 &quot;high&quot;: &quot;A String&quot;,
2093 &quot;low&quot;: &quot;A String&quot;,
2094 },
2095 &quot;totalFreeIp&quot;: {
2096 &quot;high&quot;: &quot;A String&quot;,
2097 &quot;low&quot;: &quot;A String&quot;,
2098 },
2099 },
2100 &quot;internalIpv6Utilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
2101 &quot;totalAllocatedIp&quot;: {
2102 &quot;high&quot;: &quot;A String&quot;,
2103 &quot;low&quot;: &quot;A String&quot;,
2104 },
2105 &quot;totalFreeIp&quot;: {
2106 &quot;high&quot;: &quot;A String&quot;,
2107 &quot;low&quot;: &quot;A String&quot;,
2108 },
2109 },
2110 &quot;ipv4Utilizations&quot;: [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name
2111 # will be empty.
2112 { # The IPV4 utilization of a single IP range.
2113 &quot;rangeName&quot;: &quot;A String&quot;, # Will be set for secondary range. Empty for primary IPv4 range.
2114 &quot;totalAllocatedIp&quot;: &quot;A String&quot;,
2115 &quot;totalFreeIp&quot;: &quot;A String&quot;,
2116 },
2117 ],
2118 },
2119 }
2120
2121 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2122 that if you must retry your request, the server will know to ignore the
2123 request if it has already been completed.
2124
2125 For example, consider a situation where you make an initial request and
2126 the request times out. If you make the request again with the same
2127 request ID, the server can check if original operation with the same
2128 request ID was received, and if so, will ignore the second request. This
2129 prevents clients from accidentally creating duplicate commitments.
2130
2131 The request ID must be
2132 a valid UUID with the exception that zero UUID is not supported
2133 (00000000-0000-0000-0000-000000000000).
2134 x__xgafv: string, V1 error format.
2135 Allowed values
2136 1 - v1 error format
2137 2 - v2 error format
2138
2139 Returns:
2140 An object of the form:
2141
2142 { # Represents an Operation resource.
2143 #
2144 # Google Compute Engine has three Operation resources:
2145 #
2146 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2147 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2148 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2149 #
2150 # You can use an operation resource to manage asynchronous API requests.
2151 # For more information, readHandling
2152 # API responses.
2153 #
2154 # Operations can be global, regional or zonal.
2155 #
2156 # - For global operations, use the `globalOperations`
2157 # resource.
2158 # - For regional operations, use the
2159 # `regionOperations` resource.
2160 # - For zonal operations, use
2161 # the `zoneOperations` resource.
2162 #
2163 #
2164 #
2165 # For more information, read
2166 # Global, Regional, and Zonal Resources.
2167 #
2168 # Note that completed Operation resources have a limited
2169 # retention period.
2170 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2171 # Not present otherwise.
2172 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2173 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2174 # set when the operation is created.
2175 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2176 # text format.
2177 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2178 # this field will be populated.
2179 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2180 # operation.
2181 {
2182 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2183 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2184 # details. There is a set of defined message types to use for providing
2185 # details.The syntax depends on the error code. For example,
2186 # QuotaExceededInfo will have details when the error code is
2187 # QUOTA_EXCEEDED.
2188 {
2189 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2190 #
2191 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2192 # is not enabled:
2193 #
2194 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2195 # &quot;domain&quot;: &quot;googleapis.com&quot;
2196 # &quot;metadata&quot;: {
2197 # &quot;resource&quot;: &quot;projects/123&quot;,
2198 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2199 # }
2200 # }
2201 #
2202 # This response indicates that the pubsub.googleapis.com API is not enabled.
2203 #
2204 # Example of an error that is returned when attempting to create a Spanner
2205 # instance in a region that is out of stock:
2206 #
2207 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2208 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2209 # &quot;metadata&quot;: {
2210 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2211 # }
2212 # }
2213 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2214 # is typically the registered service name of the tool or product that
2215 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2216 # generated by some common infrastructure, the error domain must be a
2217 # globally unique value that identifies the infrastructure. For Google API
2218 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2219 &quot;metadatas&quot;: { # Additional structured details about this error.
2220 #
2221 # Keys must match a regular expression of `a-z+` but should
2222 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2223 # length. When identifying the current value of an exceeded limit, the units
2224 # should be contained in the key, not the value. For example, rather than
2225 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2226 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2227 # instances that can be created in a single (batch) request.
2228 &quot;a_key&quot;: &quot;A String&quot;,
2229 },
2230 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2231 # proximate cause of the error. Error reasons are unique within a particular
2232 # domain of errors. This should be at most 63 characters and match a
2233 # regular expression of `A-Z+[A-Z0-9]`, which represents
2234 # UPPER_SNAKE_CASE.
2235 },
2236 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2237 #
2238 # For example, if a quota check failed with an error indicating the calling
2239 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2240 # directly to the right place in the developer console to flip the bit.
2241 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2242 { # Describes a URL link.
2243 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2244 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2245 },
2246 ],
2247 },
2248 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2249 # which can be attached to an RPC error.
2250 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2251 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2252 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2253 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2254 },
2255 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2256 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2257 &quot;a_key&quot;: &quot;A String&quot;,
2258 },
2259 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2260 # type or metric.
2261 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2262 # or metric.
2263 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2264 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2265 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2266 },
2267 },
2268 ],
2269 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2270 # This property is optional.
2271 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2272 },
2273 ],
2274 },
2275 &quot;getVersionOperationMetadata&quot;: {
2276 &quot;inlineSbomInfo&quot;: {
2277 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2278 # appropriate identifiers.
2279 &quot;a_key&quot;: &quot;A String&quot;,
2280 },
2281 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2282 # identifiers.
2283 &quot;a_key&quot;: &quot;A String&quot;,
2284 },
2285 },
2286 },
2287 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2288 # message that was returned, such as `NOT FOUND`.
2289 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2290 # status code that was returned. For example, a `404` means the
2291 # resource was not found.
2292 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2293 # defined by the server.
2294 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2295 # This value is inRFC3339
2296 # text format.
2297 &quot;instancesBulkInsertOperationMetadata&quot;: {
2298 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2299 # Example key: zones/us-central1-a
2300 &quot;a_key&quot;: {
2301 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2302 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2303 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2304 # error.
2305 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2306 # if the flow is rolling forward or rolling back.
2307 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2308 },
2309 },
2310 },
2311 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2312 # Operation resources.
2313 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2314 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2315 # group of operations results from a `bulkInsert` API request.
2316 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2317 # `update`, or `delete`, and so on.
2318 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2319 # There is no requirement that this be linear or support any granularity of
2320 # operations. This should not be used to guess when the operation will be
2321 # complete. This number should monotonically increase as the operation
2322 # progresses.
2323 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2324 # applicable when performing regional operations.
2325 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2326 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2327 # this field will contain information on all underlying zonal actions and
2328 # their state.
2329 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2330 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2331 # Example key: zones/us-central1-a
2332 &quot;a_key&quot;: {
2333 &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
2334 # populated.
2335 # different programming environments, including REST APIs and RPC APIs. It is
2336 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2337 # three pieces of data: error code, error message, and error details.
2338 #
2339 # You can find out more about this error model and how to work with it in the
2340 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2341 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2342 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2343 # message types for APIs to use.
2344 {
2345 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2346 },
2347 ],
2348 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2349 # user-facing error message should be localized and sent in the
2350 # google.rpc.Status.details field, or localized by the client.
2351 },
2352 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2353 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2354 },
2355 },
2356 },
2357 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2358 # This value is inRFC3339
2359 # text format.
2360 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2361 # following:
2362 # `PENDING`, `RUNNING`, or `DONE`.
2363 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2364 # operation.
2365 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2366 # of the target resource.
2367 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2368 # operations related to creating a snapshot, this points to the disk
2369 # that the snapshot was created from.
2370 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2371 # `[email protected]` or
2372 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2373 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2374 # operation, this field will be populated.
2375 {
2376 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2377 # Engine returns NO_RESULTS_ON_PAGE if there
2378 # are no results in the response.
2379 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2380 # value format. For example:
2381 #
2382 # &quot;data&quot;: [
2383 # {
2384 # &quot;key&quot;: &quot;scope&quot;,
2385 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2386 # }
2387 {
2388 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2389 # returned. For example, for warnings where there are no results in a list
2390 # request for a particular zone, this key might be scope and
2391 # the key value might be the zone name. Other examples might be a key
2392 # indicating a deprecated resource and a suggested replacement, or a
2393 # warning about invalid network settings (for example, if an instance
2394 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2395 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2396 },
2397 ],
2398 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2399 },
2400 ],
2401 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2402 # applicable when performing per-zone operations.
2403 }</pre>
2404 </div>
2405
2406 <div class="method">
2407 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, views=None, x__xgafv=None)</code>
2408 <pre>Retrieves a list of subnetworks available to the specified
2409 project.
2410
2411 Args:
2412 project: string, Project ID for this request. (required)
2413 region: string, Name of the region scoping this request. (required)
2414 filter: string, A filter expression that filters resources listed in the response. Most
2415 Compute resources support two types of filter expressions:
2416 expressions that support regular expressions and expressions that follow
2417 API improvement proposal AIP-160.
2418 These two types of filter expressions cannot be mixed in one request.
2419
2420 If you want to use AIP-160, your expression must specify the field name, an
2421 operator, and the value that you want to use for filtering. The value
2422 must be a string, a number, or a boolean. The operator
2423 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2424
2425 For example, if you are filtering Compute Engine instances, you can
2426 exclude instances named `example-instance` by specifying
2427 `name != example-instance`.
2428
2429 The `:*` comparison can be used to test whether a key has been defined.
2430 For example, to find all objects with `owner` label use:
2431 ```
2432 labels.owner:*
2433 ```
2434
2435 You can also filter nested fields. For example, you could specify
2436 `scheduling.automaticRestart = false` to include instances only
2437 if they are not scheduled for automatic restarts. You can use filtering
2438 on nested fields to filter based onresource labels.
2439
2440 To filter on multiple expressions, provide each separate expression within
2441 parentheses. For example:
2442 ```
2443 (scheduling.automaticRestart = true)
2444 (cpuPlatform = &quot;Intel Skylake&quot;)
2445 ```
2446 By default, each expression is an `AND` expression. However, you
2447 can include `AND` and `OR` expressions explicitly.
2448 For example:
2449 ```
2450 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2451 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2452 (scheduling.automaticRestart = true)
2453 ```
2454
2455 If you want to use a regular expression, use the `eq` (equal) or `ne`
2456 (not equal) operator against a single un-parenthesized expression with or
2457 without quotes or against multiple parenthesized expressions. Examples:
2458
2459 `fieldname eq unquoted literal`
2460 `fieldname eq &#x27;single quoted literal&#x27;`
2461 `fieldname eq &quot;double quoted literal&quot;`
2462 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2463
2464 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2465 The literal value must match the entire field.
2466
2467 For example, to filter for instances that do not end with name &quot;instance&quot;,
2468 you would use `name ne .*instance`.
2469
2470 You cannot combine constraints on multiple fields using regular
2471 expressions.
2472 maxResults: integer, The maximum number of results per page that should be returned.
2473 If the number of available results is larger than `maxResults`,
2474 Compute Engine returns a `nextPageToken` that can be used to get
2475 the next page of results in subsequent list requests. Acceptable values are
2476 `0` to `500`, inclusive. (Default: `500`)
2477 orderBy: string, Sorts list results by a certain order. By default, results
2478 are returned in alphanumerical order based on the resource name.
2479
2480 You can also sort results in descending order based on the creation
2481 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2482 results based on the `creationTimestamp` field in
2483 reverse chronological order (newest result first). Use this to sort
2484 resources like operations so that the newest operation is returned first.
2485
2486 Currently, only sorting by `name` or
2487 `creationTimestamp desc` is supported.
2488 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2489 `nextPageToken` returned by a previous list request to get
2490 the next page of results.
2491 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2492 of failure. The default value is false.
2493
2494 For example, when partial success behavior is enabled, aggregatedList for a
2495 single zone scope either returns all resources in the zone or no resources,
2496 with an error code.
2497 views: string, Defines the extra views returned back in the subnetwork resource.
2498 Supported values:
2499
2500 - WITH_UTILIZATION: Utilization data is included in the
2501 response. (repeated)
2502 Allowed values
2503 DEFAULT -
2504 WITH_UTILIZATION - Utilization data is included in the response.
2505 x__xgafv: string, V1 error format.
2506 Allowed values
2507 1 - v1 error format
2508 2 - v2 error format
2509
2510 Returns:
2511 An object of the form:
2512
2513 { # Contains a list of Subnetwork resources.
2514 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2515 &quot;items&quot;: [ # A list of Subnetwork resources.
2516 { # Represents a Subnetwork resource.
2517 #
2518 # A subnetwork (also known as a subnet) is a logical partition of a Virtual
2519 # Private Cloud network with one primary IP range and zero or more secondary
2520 # IP ranges. For more information, read
2521 # Virtual Private Cloud (VPC) Network.
2522 &quot;allowSubnetCidrRoutesOverlap&quot;: True or False, # Whether this subnetwork&#x27;s ranges can conflict with existing custom routes.
2523 # Setting this to true allows this subnetwork&#x27;s primary and secondary ranges
2524 # to overlap with (and contain) custom routes that have already been
2525 # configured on the corresponding network.
2526 #
2527 # For example if a static route has range 10.1.0.0/16, a subnet
2528 # range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
2529 #
2530 # Overlapping is only allowed on subnetwork operations; routes
2531 # whose ranges conflict with this subnetwork&#x27;s ranges won&#x27;t be allowed unless
2532 # route.allow_conflicting_subnetworks is set to true.
2533 #
2534 # Typically packets destined to IPs within the subnetwork (which may contain
2535 # private/sensitive data) are prevented from leaving the virtual network.
2536 # Setting this field to true will disable this feature.
2537 #
2538 # The default value is false and applies to all existing subnetworks and
2539 # automatically created subnetworks.
2540 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2541 # text format.
2542 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2543 # create the resource. This field can be set only at resource creation time.
2544 &quot;enableFlowLogs&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
2545 # explicitly set, it will not appear in get listings. If not set
2546 # the default behavior is determined by the org policy, if there is no org
2547 # policy specified, then it will default to disabled. This field isn&#x27;t
2548 # supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.
2549 &quot;externalIpv6Prefix&quot;: &quot;A String&quot;, # The external IPv6 address range that is owned by this
2550 # subnetwork.
2551 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
2552 # This field is used in optimistic locking. This field will be ignored when
2553 # inserting a Subnetwork. An up-to-date fingerprint must be
2554 # provided in order to update the Subnetwork, otherwise the
2555 # request will fail with error 412 conditionNotMet.
2556 #
2557 # To see the latest fingerprint, make a get() request to
2558 # retrieve a Subnetwork.
2559 &quot;gatewayAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] The gateway address for default routes to reach destination
2560 # addresses outside this subnetwork.
2561 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2562 # defined by the server.
2563 &quot;internalIpv6Prefix&quot;: &quot;A String&quot;, # The internal IPv6 address range that is owned by this
2564 # subnetwork.
2565 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of internal addresses that are owned by this subnetwork.
2566 # Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
2567 # be unique and non-overlapping within a network. Only IPv4 is supported.
2568 # This field is set at resource creation time. The range can be any range
2569 # listed in theValid
2570 # ranges list. The range can be expanded after creation usingexpandIpCidrRange.
2571 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to the source of IP, like a PublicDelegatedPrefix
2572 # (PDP) for BYOIP. The PDP must be a sub-PDP in
2573 # EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
2574 # mode.
2575 #
2576 # Use one of the following formats to specify a sub-PDP when creating a dual
2577 # stack or IPv6-only subnetwork with external access using BYOIP:
2578 #
2579 # -
2580 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
2581 # -
2582 # Partial URL, as in
2583 #
2584 #
2585 # - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
2586 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
2587 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The access type of IPv6 address this subnet holds. It&#x27;s immutable and can
2588 # only be specified during creation or the first time the subnet is updated
2589 # into IPV4_IPV6 dual stack.
2590 &quot;ipv6CidrRange&quot;: &quot;A String&quot;, # Output only. [Output Only] This field is for internal use.
2591 &quot;ipv6GceEndpoint&quot;: &quot;A String&quot;, # Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the
2592 # following:
2593 #
2594 # - VM_ONLY: The subnetwork can be used for creating instances and
2595 # IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6
2596 # ranges from a public delegated prefix and cannot be used to create NetLb.
2597 # - VM_AND_FR: The subnetwork can be used for creating both VM
2598 # instances and Forwarding Rules. It can also be used to reserve IPv6
2599 # addresses with both VM and FR endpoint types. Such a subnetwork gets its
2600 # IPv6 range from Google IP Pool directly.
2601 &quot;kind&quot;: &quot;compute#subnetwork&quot;, # Output only. [Output Only] Type of the resource. Always compute#subnetwork
2602 # for Subnetwork resources.
2603 &quot;logConfig&quot;: { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork.
2604 # If logging is enabled, logs are exported to Cloud Logging.
2605 &quot;aggregationInterval&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logging for this subnetwork is enabled.
2606 # Toggles the aggregation interval for collecting flow logs. Increasing the
2607 # interval time will reduce the amount of generated flow logs for long
2608 # lasting connections. Default is an interval of 5 seconds per connection.
2609 &quot;enable&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
2610 # explicitly set, it will not appear in get listings. If not
2611 # set the default behavior is determined by the org policy, if there is no
2612 # org policy specified, then it will default to disabled.
2613 # Flow logging isn&#x27;t supported if the subnet purpose field is
2614 # set to REGIONAL_MANAGED_PROXY.
2615 &quot;filterExpr&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
2616 # The filter expression is used to define which VPC flow logs should be
2617 # exported to Cloud Logging.
2618 &quot;flowSampling&quot;: 3.14, # Can only be specified if VPC flow logging for this subnetwork is enabled.
2619 # The value of the field must be in [0, 1]. Set the sampling rate of VPC
2620 # flow logs within the subnetwork where 1.0 means all collected logs are
2621 # reported and 0.0 means no logs are reported. Default is 0.5 unless
2622 # otherwise specified by the org policy, which means half of all collected
2623 # logs are reported.
2624 &quot;metadata&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
2625 # Configures whether all, none or a subset of metadata fields should be
2626 # added to the reported VPC flow logs. Default isEXCLUDE_ALL_METADATA.
2627 &quot;metadataFields&quot;: [ # Can only be specified if VPC flow logs for this subnetwork is enabled and
2628 # &quot;metadata&quot; was set to CUSTOM_METADATA.
2629 &quot;A String&quot;,
2630 ],
2631 },
2632 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2633 # the resource. The name must be 1-63 characters long, and comply withRFC1035.
2634 # Specifically, the name must be 1-63 characters long and match the regular
2635 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2636 # character must be a lowercase letter, and all following characters must
2637 # be a dash, lowercase letter, or digit, except the last character, which
2638 # cannot be a dash.
2639 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this subnetwork belongs, provided by the
2640 # client when initially creating the subnetwork. This field can be set only
2641 # at resource creation time.
2642 &quot;params&quot;: { # Additional subnetwork parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2643 # as part of resource payload.
2644 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2645 # Tag keys and values have the same definition as resource
2646 # manager tags. The field is allowed for INSERT
2647 # only. The keys/values to set on the resource should be specified in
2648 # either ID { : } or Namespaced format
2649 # { : }.
2650 # For example the following are valid inputs:
2651 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2652 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2653 # Note:
2654 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2655 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2656 &quot;a_key&quot;: &quot;A String&quot;,
2657 },
2658 },
2659 &quot;privateIpGoogleAccess&quot;: True or False, # Whether the VMs in this subnet can access Google services without assigned
2660 # external IP addresses. This field can be both set at resource creation
2661 # time and updated using setPrivateIpGoogleAccess.
2662 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # This field is for internal use.
2663 #
2664 # This field can be both set at resource creation time and updated usingpatch.
2665 &quot;purpose&quot;: &quot;A String&quot;,
2666 &quot;region&quot;: &quot;A String&quot;, # URL of the region where the Subnetwork resides. This
2667 # field can be set only at resource creation time.
2668 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range.
2669 &quot;resolveSubnetMask&quot;: &quot;A String&quot;, # Configures subnet mask resolution for this subnetwork.
2670 &quot;role&quot;: &quot;A String&quot;, # The role of subnetwork. Currently, this field is only used when
2671 # purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
2672 # subnetwork is one that is currently being used for Envoy-based load
2673 # balancers in a region. A BACKUP subnetwork is one that is
2674 # ready to be promoted to ACTIVE or is currently draining.
2675 # This field can be updated with a patch request.
2676 &quot;secondaryIpRanges&quot;: [ # An array of configurations for secondary IP ranges for VM instances
2677 # contained in this subnetwork. The primary IP of such VM must belong to the
2678 # primary ipCidrRange of the subnetwork. The alias IPs may belong to either
2679 # primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.
2680 { # Represents a secondary IP range of a subnetwork.
2681 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of IP addresses belonging to this subnetwork secondary range.
2682 # Provide this property when you create the subnetwork. Ranges must be
2683 # unique and non-overlapping with all primary and secondary IP ranges
2684 # within a network. Both IPv4 and IPv6 ranges are supported. For IPv4,
2685 # the range can be any range listed in theValid
2686 # ranges list.
2687 #
2688 # For IPv6:
2689 # The range must have a /64 prefix length.
2690 # The range must be omitted, for auto-allocation from Google-defined ULA
2691 # IPv6 range.
2692 # For BYOGUA internal IPv6 secondary range, the range may be specified
2693 # along with the `ipCollection` field.
2694 # If an `ipCollection` is specified, the requested ip_cidr_range must lie
2695 # within the range of the PDP referenced by the `ipCollection` field for
2696 # allocation.
2697 # If `ipCollection` field is specified, but ip_cidr_range is not,
2698 # the range is auto-allocated from the PDP referenced by the `ipCollection`
2699 # field.
2700 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to a Public Delegated Prefix (PDP) for BYOIP.
2701 # This field should be specified for configuring BYOGUA internal IPv6
2702 # secondary range.
2703 # When specified along with the ip_cidr_range, the ip_cidr_range must lie
2704 # within the PDP referenced by the `ipCollection` field.
2705 # When specified without the ip_cidr_range, the range is auto-allocated
2706 # from the PDP referenced by the `ipCollection` field.
2707 &quot;ipVersion&quot;: &quot;A String&quot;,
2708 &quot;rangeName&quot;: &quot;A String&quot;, # The name associated with this subnetwork secondary range, used when adding
2709 # an alias IP/IPv6 range to a VM instance.
2710 # The name must be 1-63 characters long, and comply withRFC1035.
2711 # The name must be unique within the subnetwork.
2712 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range. Only IPv4 is supported.
2713 },
2714 ],
2715 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2716 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for the subnet. If set to IPV4_ONLY, new VMs
2717 # in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
2718 # IPv6 addresses. If not specified, IPV4_ONLY is used.
2719 #
2720 # This field can be both set at resource creation time and updated usingpatch.
2721 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the subnetwork, which can be one of the
2722 # following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
2723 # purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
2724 # connections to the load balancer are being drained. A subnetwork that is
2725 # draining cannot be used or modified until it reaches a status ofREADY
2726 &quot;systemReservedExternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of external IPv6 network ranges reserved from
2727 # the subnetwork&#x27;s external IPv6 range for system use.
2728 &quot;A String&quot;,
2729 ],
2730 &quot;systemReservedInternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from
2731 # the subnetwork&#x27;s internal IPv6 range for system use.
2732 &quot;A String&quot;,
2733 ],
2734 &quot;utilizationDetails&quot;: { # The current IP utilization of all subnetwork ranges. Contains the total # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains
2735 # the total number of allocated and free IPs in each range.
2736 # number of allocated and free IPs in each range.
2737 &quot;externalIpv6InstanceUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
2738 &quot;totalAllocatedIp&quot;: {
2739 &quot;high&quot;: &quot;A String&quot;,
2740 &quot;low&quot;: &quot;A String&quot;,
2741 },
2742 &quot;totalFreeIp&quot;: {
2743 &quot;high&quot;: &quot;A String&quot;,
2744 &quot;low&quot;: &quot;A String&quot;,
2745 },
2746 },
2747 &quot;externalIpv6LbUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
2748 &quot;totalAllocatedIp&quot;: {
2749 &quot;high&quot;: &quot;A String&quot;,
2750 &quot;low&quot;: &quot;A String&quot;,
2751 },
2752 &quot;totalFreeIp&quot;: {
2753 &quot;high&quot;: &quot;A String&quot;,
2754 &quot;low&quot;: &quot;A String&quot;,
2755 },
2756 },
2757 &quot;internalIpv6Utilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
2758 &quot;totalAllocatedIp&quot;: {
2759 &quot;high&quot;: &quot;A String&quot;,
2760 &quot;low&quot;: &quot;A String&quot;,
2761 },
2762 &quot;totalFreeIp&quot;: {
2763 &quot;high&quot;: &quot;A String&quot;,
2764 &quot;low&quot;: &quot;A String&quot;,
2765 },
2766 },
2767 &quot;ipv4Utilizations&quot;: [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name
2768 # will be empty.
2769 { # The IPV4 utilization of a single IP range.
2770 &quot;rangeName&quot;: &quot;A String&quot;, # Will be set for secondary range. Empty for primary IPv4 range.
2771 &quot;totalAllocatedIp&quot;: &quot;A String&quot;,
2772 &quot;totalFreeIp&quot;: &quot;A String&quot;,
2773 },
2774 ],
2775 },
2776 },
2777 ],
2778 &quot;kind&quot;: &quot;compute#subnetworkList&quot;, # Output only. [Output Only] Type of resource. Always compute#subnetworkList
2779 # for lists of subnetworks.
2780 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2781 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2782 # the query parameter pageToken in the next list request.
2783 # Subsequent list requests will have their own nextPageToken to
2784 # continue paging through the results.
2785 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2786 &quot;warning&quot;: { # [Output Only] Informational warning message.
2787 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2788 # Engine returns NO_RESULTS_ON_PAGE if there
2789 # are no results in the response.
2790 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2791 # value format. For example:
2792 #
2793 # &quot;data&quot;: [
2794 # {
2795 # &quot;key&quot;: &quot;scope&quot;,
2796 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2797 # }
2798 {
2799 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2800 # returned. For example, for warnings where there are no results in a list
2801 # request for a particular zone, this key might be scope and
2802 # the key value might be the zone name. Other examples might be a key
2803 # indicating a deprecated resource and a suggested replacement, or a
2804 # warning about invalid network settings (for example, if an instance
2805 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2806 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2807 },
2808 ],
2809 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2810 },
2811 }</pre>
2812 </div>
2813
2814 <div class="method">
2815 <code class="details" id="listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProject=None, x__xgafv=None)</code>
2816 <pre>Retrieves an aggregated list of all usable subnetworks in the project.
2817
2818 Args:
2819 project: string, Project ID for this request. (required)
2820 filter: string, A filter expression that filters resources listed in the response. Most
2821 Compute resources support two types of filter expressions:
2822 expressions that support regular expressions and expressions that follow
2823 API improvement proposal AIP-160.
2824 These two types of filter expressions cannot be mixed in one request.
2825
2826 If you want to use AIP-160, your expression must specify the field name, an
2827 operator, and the value that you want to use for filtering. The value
2828 must be a string, a number, or a boolean. The operator
2829 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2830
2831 For example, if you are filtering Compute Engine instances, you can
2832 exclude instances named `example-instance` by specifying
2833 `name != example-instance`.
2834
2835 The `:*` comparison can be used to test whether a key has been defined.
2836 For example, to find all objects with `owner` label use:
2837 ```
2838 labels.owner:*
2839 ```
2840
2841 You can also filter nested fields. For example, you could specify
2842 `scheduling.automaticRestart = false` to include instances only
2843 if they are not scheduled for automatic restarts. You can use filtering
2844 on nested fields to filter based onresource labels.
2845
2846 To filter on multiple expressions, provide each separate expression within
2847 parentheses. For example:
2848 ```
2849 (scheduling.automaticRestart = true)
2850 (cpuPlatform = &quot;Intel Skylake&quot;)
2851 ```
2852 By default, each expression is an `AND` expression. However, you
2853 can include `AND` and `OR` expressions explicitly.
2854 For example:
2855 ```
2856 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2857 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2858 (scheduling.automaticRestart = true)
2859 ```
2860
2861 If you want to use a regular expression, use the `eq` (equal) or `ne`
2862 (not equal) operator against a single un-parenthesized expression with or
2863 without quotes or against multiple parenthesized expressions. Examples:
2864
2865 `fieldname eq unquoted literal`
2866 `fieldname eq &#x27;single quoted literal&#x27;`
2867 `fieldname eq &quot;double quoted literal&quot;`
2868 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2869
2870 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2871 The literal value must match the entire field.
2872
2873 For example, to filter for instances that do not end with name &quot;instance&quot;,
2874 you would use `name ne .*instance`.
2875
2876 You cannot combine constraints on multiple fields using regular
2877 expressions.
2878 maxResults: integer, The maximum number of results per page that should be returned.
2879 If the number of available results is larger than `maxResults`,
2880 Compute Engine returns a `nextPageToken` that can be used to get
2881 the next page of results in subsequent list requests. Acceptable values are
2882 `0` to `500`, inclusive. (Default: `500`)
2883 orderBy: string, Sorts list results by a certain order. By default, results
2884 are returned in alphanumerical order based on the resource name.
2885
2886 You can also sort results in descending order based on the creation
2887 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2888 results based on the `creationTimestamp` field in
2889 reverse chronological order (newest result first). Use this to sort
2890 resources like operations so that the newest operation is returned first.
2891
2892 Currently, only sorting by `name` or
2893 `creationTimestamp desc` is supported.
2894 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2895 `nextPageToken` returned by a previous list request to get
2896 the next page of results.
2897 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2898 of failure. The default value is false.
2899
2900 For example, when partial success behavior is enabled, aggregatedList for a
2901 single zone scope either returns all resources in the zone or no resources,
2902 with an error code.
2903 serviceProject: string, The project id or project number in which the subnetwork is intended to be
2904 used. Only applied for Shared VPC. See [Shared VPC
2905 documentation](https://cloud.google.com/vpc/docs/shared-vpc/)
2906 x__xgafv: string, V1 error format.
2907 Allowed values
2908 1 - v1 error format
2909 2 - v2 error format
2910
2911 Returns:
2912 An object of the form:
2913
2914 {
2915 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2916 # defined by the server.
2917 &quot;items&quot;: [ # [Output] A list of usable subnetwork URLs.
2918 { # Subnetwork which the current user has compute.subnetworks.use permission on.
2919 &quot;externalIpv6Prefix&quot;: &quot;A String&quot;, # Output only. [Output Only] The external IPv6 address range that is assigned to this
2920 # subnetwork.
2921 &quot;internalIpv6Prefix&quot;: &quot;A String&quot;, # Output only. [Output Only] The internal IPv6 address range that is assigned to this
2922 # subnetwork.
2923 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of internal addresses that are owned by this subnetwork.
2924 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The access type of IPv6 address this subnet holds. It&#x27;s immutable and can
2925 # only be specified during creation or the first time the subnet is updated
2926 # into IPV4_IPV6 dual stack.
2927 &quot;network&quot;: &quot;A String&quot;, # Network URL.
2928 &quot;purpose&quot;: &quot;A String&quot;,
2929 &quot;role&quot;: &quot;A String&quot;, # The role of subnetwork. Currently, this field is only used when
2930 # purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
2931 # subnetwork is one that is currently being used for Envoy-based load
2932 # balancers in a region. A BACKUP subnetwork is one that is
2933 # ready to be promoted to ACTIVE or is currently draining.
2934 # This field can be updated with a patch request.
2935 &quot;secondaryIpRanges&quot;: [ # Secondary IP ranges.
2936 { # Secondary IP range of a usable subnetwork.
2937 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of IP addresses belonging to this subnetwork secondary range.
2938 # Can be Ipv4 or Ipv6 range.
2939 &quot;rangeName&quot;: &quot;A String&quot;, # The name associated with this subnetwork secondary range, used when adding
2940 # an alias IP range to a VM instance.
2941 # The name must be 1-63 characters long, and comply withRFC1035.
2942 # The name must be unique within the subnetwork.
2943 },
2944 ],
2945 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for the subnet. If set to IPV4_ONLY, new VMs
2946 # in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
2947 # IPv6 addresses. If not specified, IPV4_ONLY is used.
2948 #
2949 # This field can be both set at resource creation time and updated usingpatch.
2950 &quot;subnetwork&quot;: &quot;A String&quot;, # Subnetwork URL.
2951 },
2952 ],
2953 &quot;kind&quot;: &quot;compute#usableSubnetworksAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableSubnetworksAggregatedList for aggregated lists
2954 # of usable subnetworks.
2955 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2956 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2957 # the query parameter pageToken in the next list request.
2958 # Subsequent list requests will have their own nextPageToken to
2959 # continue paging through the results.
2960 # In special cases listUsable may return 0 subnetworks andnextPageToken which still should be used to get the
2961 # next page of results.
2962 &quot;scopedWarnings&quot;: [ # Output only. [Output Only] Informational warning messages for failures encountered from
2963 # scopes.
2964 {
2965 &quot;scopeName&quot;: &quot;A String&quot;, # Name of the scope containing this set of Subnetworks.
2966 &quot;warning&quot;: { # An informational warning about unreachable scope
2967 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2968 # Engine returns NO_RESULTS_ON_PAGE if there
2969 # are no results in the response.
2970 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2971 # value format. For example:
2972 #
2973 # &quot;data&quot;: [
2974 # {
2975 # &quot;key&quot;: &quot;scope&quot;,
2976 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2977 # }
2978 {
2979 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2980 # returned. For example, for warnings where there are no results in a list
2981 # request for a particular zone, this key might be scope and
2982 # the key value might be the zone name. Other examples might be a key
2983 # indicating a deprecated resource and a suggested replacement, or a
2984 # warning about invalid network settings (for example, if an instance
2985 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2986 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2987 },
2988 ],
2989 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2990 },
2991 },
2992 ],
2993 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2994 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
2995 &quot;A String&quot;,
2996 ],
2997 &quot;warning&quot;: { # [Output Only] Informational warning message.
2998 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2999 # Engine returns NO_RESULTS_ON_PAGE if there
3000 # are no results in the response.
3001 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3002 # value format. For example:
3003 #
3004 # &quot;data&quot;: [
3005 # {
3006 # &quot;key&quot;: &quot;scope&quot;,
3007 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3008 # }
3009 {
3010 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3011 # returned. For example, for warnings where there are no results in a list
3012 # request for a particular zone, this key might be scope and
3013 # the key value might be the zone name. Other examples might be a key
3014 # indicating a deprecated resource and a suggested replacement, or a
3015 # warning about invalid network settings (for example, if an instance
3016 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3017 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3018 },
3019 ],
3020 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3021 },
3022 }</pre>
3023 </div>
3024
3025 <div class="method">
3026 <code class="details" id="listUsable_next">listUsable_next()</code>
3027 <pre>Retrieves the next page of results.
3028
3029 Args:
3030 previous_request: The request for the previous page. (required)
3031 previous_response: The response from the request for the previous page. (required)
3032
3033 Returns:
3034 A request object that you can call &#x27;execute()&#x27; on to request the next
3035 page. Returns None if there are no more items in the collection.
3036 </pre>
3037 </div>
3038
3039 <div class="method">
3040 <code class="details" id="list_next">list_next()</code>
3041 <pre>Retrieves the next page of results.
3042
3043 Args:
3044 previous_request: The request for the previous page. (required)
3045 previous_response: The response from the request for the previous page. (required)
3046
3047 Returns:
3048 A request object that you can call &#x27;execute()&#x27; on to request the next
3049 page. Returns None if there are no more items in the collection.
3050 </pre>
3051 </div>
3052
3053 <div class="method">
3054 <code class="details" id="patch">patch(project, region, subnetwork, body=None, drainTimeoutSeconds=None, requestId=None, x__xgafv=None)</code>
3055 <pre>Patches the specified subnetwork with the data included in the request.
3056 Only certain fields can be updated with a patch request
3057 as indicated in the field descriptions.
3058 You must specify the current fingerprint of the
3059 subnetwork resource being patched.
3060
3061 Args:
3062 project: string, Project ID for this request. (required)
3063 region: string, Name of the region scoping this request. (required)
3064 subnetwork: string, Name of the Subnetwork resource to patch. (required)
3065 body: object, The request body.
3066 The object takes the form of:
3067
3068 { # Represents a Subnetwork resource.
3069 #
3070 # A subnetwork (also known as a subnet) is a logical partition of a Virtual
3071 # Private Cloud network with one primary IP range and zero or more secondary
3072 # IP ranges. For more information, read
3073 # Virtual Private Cloud (VPC) Network.
3074 &quot;allowSubnetCidrRoutesOverlap&quot;: True or False, # Whether this subnetwork&#x27;s ranges can conflict with existing custom routes.
3075 # Setting this to true allows this subnetwork&#x27;s primary and secondary ranges
3076 # to overlap with (and contain) custom routes that have already been
3077 # configured on the corresponding network.
3078 #
3079 # For example if a static route has range 10.1.0.0/16, a subnet
3080 # range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
3081 #
3082 # Overlapping is only allowed on subnetwork operations; routes
3083 # whose ranges conflict with this subnetwork&#x27;s ranges won&#x27;t be allowed unless
3084 # route.allow_conflicting_subnetworks is set to true.
3085 #
3086 # Typically packets destined to IPs within the subnetwork (which may contain
3087 # private/sensitive data) are prevented from leaving the virtual network.
3088 # Setting this field to true will disable this feature.
3089 #
3090 # The default value is false and applies to all existing subnetworks and
3091 # automatically created subnetworks.
3092 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3093 # text format.
3094 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3095 # create the resource. This field can be set only at resource creation time.
3096 &quot;enableFlowLogs&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
3097 # explicitly set, it will not appear in get listings. If not set
3098 # the default behavior is determined by the org policy, if there is no org
3099 # policy specified, then it will default to disabled. This field isn&#x27;t
3100 # supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.
3101 &quot;externalIpv6Prefix&quot;: &quot;A String&quot;, # The external IPv6 address range that is owned by this
3102 # subnetwork.
3103 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
3104 # This field is used in optimistic locking. This field will be ignored when
3105 # inserting a Subnetwork. An up-to-date fingerprint must be
3106 # provided in order to update the Subnetwork, otherwise the
3107 # request will fail with error 412 conditionNotMet.
3108 #
3109 # To see the latest fingerprint, make a get() request to
3110 # retrieve a Subnetwork.
3111 &quot;gatewayAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] The gateway address for default routes to reach destination
3112 # addresses outside this subnetwork.
3113 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3114 # defined by the server.
3115 &quot;internalIpv6Prefix&quot;: &quot;A String&quot;, # The internal IPv6 address range that is owned by this
3116 # subnetwork.
3117 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of internal addresses that are owned by this subnetwork.
3118 # Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
3119 # be unique and non-overlapping within a network. Only IPv4 is supported.
3120 # This field is set at resource creation time. The range can be any range
3121 # listed in theValid
3122 # ranges list. The range can be expanded after creation usingexpandIpCidrRange.
3123 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to the source of IP, like a PublicDelegatedPrefix
3124 # (PDP) for BYOIP. The PDP must be a sub-PDP in
3125 # EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
3126 # mode.
3127 #
3128 # Use one of the following formats to specify a sub-PDP when creating a dual
3129 # stack or IPv6-only subnetwork with external access using BYOIP:
3130 #
3131 # -
3132 # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
3133 # -
3134 # Partial URL, as in
3135 #
3136 #
3137 # - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
3138 # - regions/region/publicDelegatedPrefixes/sub-pdp-name
3139 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # The access type of IPv6 address this subnet holds. It&#x27;s immutable and can
3140 # only be specified during creation or the first time the subnet is updated
3141 # into IPV4_IPV6 dual stack.
3142 &quot;ipv6CidrRange&quot;: &quot;A String&quot;, # Output only. [Output Only] This field is for internal use.
3143 &quot;ipv6GceEndpoint&quot;: &quot;A String&quot;, # Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the
3144 # following:
3145 #
3146 # - VM_ONLY: The subnetwork can be used for creating instances and
3147 # IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6
3148 # ranges from a public delegated prefix and cannot be used to create NetLb.
3149 # - VM_AND_FR: The subnetwork can be used for creating both VM
3150 # instances and Forwarding Rules. It can also be used to reserve IPv6
3151 # addresses with both VM and FR endpoint types. Such a subnetwork gets its
3152 # IPv6 range from Google IP Pool directly.
3153 &quot;kind&quot;: &quot;compute#subnetwork&quot;, # Output only. [Output Only] Type of the resource. Always compute#subnetwork
3154 # for Subnetwork resources.
3155 &quot;logConfig&quot;: { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork.
3156 # If logging is enabled, logs are exported to Cloud Logging.
3157 &quot;aggregationInterval&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logging for this subnetwork is enabled.
3158 # Toggles the aggregation interval for collecting flow logs. Increasing the
3159 # interval time will reduce the amount of generated flow logs for long
3160 # lasting connections. Default is an interval of 5 seconds per connection.
3161 &quot;enable&quot;: True or False, # Whether to enable flow logging for this subnetwork. If this field is not
3162 # explicitly set, it will not appear in get listings. If not
3163 # set the default behavior is determined by the org policy, if there is no
3164 # org policy specified, then it will default to disabled.
3165 # Flow logging isn&#x27;t supported if the subnet purpose field is
3166 # set to REGIONAL_MANAGED_PROXY.
3167 &quot;filterExpr&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
3168 # The filter expression is used to define which VPC flow logs should be
3169 # exported to Cloud Logging.
3170 &quot;flowSampling&quot;: 3.14, # Can only be specified if VPC flow logging for this subnetwork is enabled.
3171 # The value of the field must be in [0, 1]. Set the sampling rate of VPC
3172 # flow logs within the subnetwork where 1.0 means all collected logs are
3173 # reported and 0.0 means no logs are reported. Default is 0.5 unless
3174 # otherwise specified by the org policy, which means half of all collected
3175 # logs are reported.
3176 &quot;metadata&quot;: &quot;A String&quot;, # Can only be specified if VPC flow logs for this subnetwork is enabled.
3177 # Configures whether all, none or a subset of metadata fields should be
3178 # added to the reported VPC flow logs. Default isEXCLUDE_ALL_METADATA.
3179 &quot;metadataFields&quot;: [ # Can only be specified if VPC flow logs for this subnetwork is enabled and
3180 # &quot;metadata&quot; was set to CUSTOM_METADATA.
3181 &quot;A String&quot;,
3182 ],
3183 },
3184 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
3185 # the resource. The name must be 1-63 characters long, and comply withRFC1035.
3186 # Specifically, the name must be 1-63 characters long and match the regular
3187 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3188 # character must be a lowercase letter, and all following characters must
3189 # be a dash, lowercase letter, or digit, except the last character, which
3190 # cannot be a dash.
3191 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this subnetwork belongs, provided by the
3192 # client when initially creating the subnetwork. This field can be set only
3193 # at resource creation time.
3194 &quot;params&quot;: { # Additional subnetwork parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3195 # as part of resource payload.
3196 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3197 # Tag keys and values have the same definition as resource
3198 # manager tags. The field is allowed for INSERT
3199 # only. The keys/values to set on the resource should be specified in
3200 # either ID { : } or Namespaced format
3201 # { : }.
3202 # For example the following are valid inputs:
3203 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3204 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3205 # Note:
3206 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3207 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3208 &quot;a_key&quot;: &quot;A String&quot;,
3209 },
3210 },
3211 &quot;privateIpGoogleAccess&quot;: True or False, # Whether the VMs in this subnet can access Google services without assigned
3212 # external IP addresses. This field can be both set at resource creation
3213 # time and updated using setPrivateIpGoogleAccess.
3214 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # This field is for internal use.
3215 #
3216 # This field can be both set at resource creation time and updated usingpatch.
3217 &quot;purpose&quot;: &quot;A String&quot;,
3218 &quot;region&quot;: &quot;A String&quot;, # URL of the region where the Subnetwork resides. This
3219 # field can be set only at resource creation time.
3220 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range.
3221 &quot;resolveSubnetMask&quot;: &quot;A String&quot;, # Configures subnet mask resolution for this subnetwork.
3222 &quot;role&quot;: &quot;A String&quot;, # The role of subnetwork. Currently, this field is only used when
3223 # purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
3224 # subnetwork is one that is currently being used for Envoy-based load
3225 # balancers in a region. A BACKUP subnetwork is one that is
3226 # ready to be promoted to ACTIVE or is currently draining.
3227 # This field can be updated with a patch request.
3228 &quot;secondaryIpRanges&quot;: [ # An array of configurations for secondary IP ranges for VM instances
3229 # contained in this subnetwork. The primary IP of such VM must belong to the
3230 # primary ipCidrRange of the subnetwork. The alias IPs may belong to either
3231 # primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.
3232 { # Represents a secondary IP range of a subnetwork.
3233 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The range of IP addresses belonging to this subnetwork secondary range.
3234 # Provide this property when you create the subnetwork. Ranges must be
3235 # unique and non-overlapping with all primary and secondary IP ranges
3236 # within a network. Both IPv4 and IPv6 ranges are supported. For IPv4,
3237 # the range can be any range listed in theValid
3238 # ranges list.
3239 #
3240 # For IPv6:
3241 # The range must have a /64 prefix length.
3242 # The range must be omitted, for auto-allocation from Google-defined ULA
3243 # IPv6 range.
3244 # For BYOGUA internal IPv6 secondary range, the range may be specified
3245 # along with the `ipCollection` field.
3246 # If an `ipCollection` is specified, the requested ip_cidr_range must lie
3247 # within the range of the PDP referenced by the `ipCollection` field for
3248 # allocation.
3249 # If `ipCollection` field is specified, but ip_cidr_range is not,
3250 # the range is auto-allocated from the PDP referenced by the `ipCollection`
3251 # field.
3252 &quot;ipCollection&quot;: &quot;A String&quot;, # Reference to a Public Delegated Prefix (PDP) for BYOIP.
3253 # This field should be specified for configuring BYOGUA internal IPv6
3254 # secondary range.
3255 # When specified along with the ip_cidr_range, the ip_cidr_range must lie
3256 # within the PDP referenced by the `ipCollection` field.
3257 # When specified without the ip_cidr_range, the range is auto-allocated
3258 # from the PDP referenced by the `ipCollection` field.
3259 &quot;ipVersion&quot;: &quot;A String&quot;,
3260 &quot;rangeName&quot;: &quot;A String&quot;, # The name associated with this subnetwork secondary range, used when adding
3261 # an alias IP/IPv6 range to a VM instance.
3262 # The name must be 1-63 characters long, and comply withRFC1035.
3263 # The name must be unique within the subnetwork.
3264 &quot;reservedInternalRange&quot;: &quot;A String&quot;, # The URL of the reserved internal range. Only IPv4 is supported.
3265 },
3266 ],
3267 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3268 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for the subnet. If set to IPV4_ONLY, new VMs
3269 # in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
3270 # IPv6 addresses. If not specified, IPV4_ONLY is used.
3271 #
3272 # This field can be both set at resource creation time and updated usingpatch.
3273 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the subnetwork, which can be one of the
3274 # following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
3275 # purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
3276 # connections to the load balancer are being drained. A subnetwork that is
3277 # draining cannot be used or modified until it reaches a status ofREADY
3278 &quot;systemReservedExternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of external IPv6 network ranges reserved from
3279 # the subnetwork&#x27;s external IPv6 range for system use.
3280 &quot;A String&quot;,
3281 ],
3282 &quot;systemReservedInternalIpv6Ranges&quot;: [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from
3283 # the subnetwork&#x27;s internal IPv6 range for system use.
3284 &quot;A String&quot;,
3285 ],
3286 &quot;utilizationDetails&quot;: { # The current IP utilization of all subnetwork ranges. Contains the total # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains
3287 # the total number of allocated and free IPs in each range.
3288 # number of allocated and free IPs in each range.
3289 &quot;externalIpv6InstanceUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
3290 &quot;totalAllocatedIp&quot;: {
3291 &quot;high&quot;: &quot;A String&quot;,
3292 &quot;low&quot;: &quot;A String&quot;,
3293 },
3294 &quot;totalFreeIp&quot;: {
3295 &quot;high&quot;: &quot;A String&quot;,
3296 &quot;low&quot;: &quot;A String&quot;,
3297 },
3298 },
3299 &quot;externalIpv6LbUtilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
3300 &quot;totalAllocatedIp&quot;: {
3301 &quot;high&quot;: &quot;A String&quot;,
3302 &quot;low&quot;: &quot;A String&quot;,
3303 },
3304 &quot;totalFreeIp&quot;: {
3305 &quot;high&quot;: &quot;A String&quot;,
3306 &quot;low&quot;: &quot;A String&quot;,
3307 },
3308 },
3309 &quot;internalIpv6Utilization&quot;: { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
3310 &quot;totalAllocatedIp&quot;: {
3311 &quot;high&quot;: &quot;A String&quot;,
3312 &quot;low&quot;: &quot;A String&quot;,
3313 },
3314 &quot;totalFreeIp&quot;: {
3315 &quot;high&quot;: &quot;A String&quot;,
3316 &quot;low&quot;: &quot;A String&quot;,
3317 },
3318 },
3319 &quot;ipv4Utilizations&quot;: [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name
3320 # will be empty.
3321 { # The IPV4 utilization of a single IP range.
3322 &quot;rangeName&quot;: &quot;A String&quot;, # Will be set for secondary range. Empty for primary IPv4 range.
3323 &quot;totalAllocatedIp&quot;: &quot;A String&quot;,
3324 &quot;totalFreeIp&quot;: &quot;A String&quot;,
3325 },
3326 ],
3327 },
3328 }
3329
3330 drainTimeoutSeconds: integer, The drain timeout specifies the upper bound in seconds on the amount of
3331 time allowed to drain connections from the current ACTIVE subnetwork
3332 to the current BACKUP subnetwork. The drain timeout is only applicable
3333 when the following conditions are true:
3334 - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER
3335 - the subnetwork being patched has role = BACKUP
3336 - the patch request is setting the role to ACTIVE. Note that after this
3337 patch operation the roles of the ACTIVE and BACKUP subnetworks will be
3338 swapped.
3339 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3340 that if you must retry your request, the server will know to ignore the
3341 request if it has already been completed.
3342
3343 For example, consider a situation where you make an initial request and
3344 the request times out. If you make the request again with the same
3345 request ID, the server can check if original operation with the same
3346 request ID was received, and if so, will ignore the second request. This
3347 prevents clients from accidentally creating duplicate commitments.
3348
3349 The request ID must be
3350 a valid UUID with the exception that zero UUID is not supported
3351 (00000000-0000-0000-0000-000000000000).
3352 x__xgafv: string, V1 error format.
3353 Allowed values
3354 1 - v1 error format
3355 2 - v2 error format
3356
3357 Returns:
3358 An object of the form:
3359
3360 { # Represents an Operation resource.
3361 #
3362 # Google Compute Engine has three Operation resources:
3363 #
3364 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
3365 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
3366 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
3367 #
3368 # You can use an operation resource to manage asynchronous API requests.
3369 # For more information, readHandling
3370 # API responses.
3371 #
3372 # Operations can be global, regional or zonal.
3373 #
3374 # - For global operations, use the `globalOperations`
3375 # resource.
3376 # - For regional operations, use the
3377 # `regionOperations` resource.
3378 # - For zonal operations, use
3379 # the `zoneOperations` resource.
3380 #
3381 #
3382 #
3383 # For more information, read
3384 # Global, Regional, and Zonal Resources.
3385 #
3386 # Note that completed Operation resources have a limited
3387 # retention period.
3388 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3389 # Not present otherwise.
3390 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3391 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3392 # set when the operation is created.
3393 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3394 # text format.
3395 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3396 # this field will be populated.
3397 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3398 # operation.
3399 {
3400 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3401 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3402 # details. There is a set of defined message types to use for providing
3403 # details.The syntax depends on the error code. For example,
3404 # QuotaExceededInfo will have details when the error code is
3405 # QUOTA_EXCEEDED.
3406 {
3407 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3408 #
3409 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3410 # is not enabled:
3411 #
3412 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3413 # &quot;domain&quot;: &quot;googleapis.com&quot;
3414 # &quot;metadata&quot;: {
3415 # &quot;resource&quot;: &quot;projects/123&quot;,
3416 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3417 # }
3418 # }
3419 #
3420 # This response indicates that the pubsub.googleapis.com API is not enabled.
3421 #
3422 # Example of an error that is returned when attempting to create a Spanner
3423 # instance in a region that is out of stock:
3424 #
3425 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3426 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3427 # &quot;metadata&quot;: {
3428 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3429 # }
3430 # }
3431 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3432 # is typically the registered service name of the tool or product that
3433 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3434 # generated by some common infrastructure, the error domain must be a
3435 # globally unique value that identifies the infrastructure. For Google API
3436 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3437 &quot;metadatas&quot;: { # Additional structured details about this error.
3438 #
3439 # Keys must match a regular expression of `a-z+` but should
3440 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3441 # length. When identifying the current value of an exceeded limit, the units
3442 # should be contained in the key, not the value. For example, rather than
3443 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3444 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3445 # instances that can be created in a single (batch) request.
3446 &quot;a_key&quot;: &quot;A String&quot;,
3447 },
3448 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3449 # proximate cause of the error. Error reasons are unique within a particular
3450 # domain of errors. This should be at most 63 characters and match a
3451 # regular expression of `A-Z+[A-Z0-9]`, which represents
3452 # UPPER_SNAKE_CASE.
3453 },
3454 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3455 #
3456 # For example, if a quota check failed with an error indicating the calling
3457 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3458 # directly to the right place in the developer console to flip the bit.
3459 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3460 { # Describes a URL link.
3461 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3462 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3463 },
3464 ],
3465 },
3466 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3467 # which can be attached to an RPC error.
3468 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3469 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3470 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3471 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3472 },
3473 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3474 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3475 &quot;a_key&quot;: &quot;A String&quot;,
3476 },
3477 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3478 # type or metric.
3479 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3480 # or metric.
3481 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3482 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3483 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3484 },
3485 },
3486 ],
3487 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3488 # This property is optional.
3489 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3490 },
3491 ],
3492 },
3493 &quot;getVersionOperationMetadata&quot;: {
3494 &quot;inlineSbomInfo&quot;: {
3495 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3496 # appropriate identifiers.
3497 &quot;a_key&quot;: &quot;A String&quot;,
3498 },
3499 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3500 # identifiers.
3501 &quot;a_key&quot;: &quot;A String&quot;,
3502 },
3503 },
3504 },
3505 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3506 # message that was returned, such as `NOT FOUND`.
3507 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3508 # status code that was returned. For example, a `404` means the
3509 # resource was not found.
3510 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3511 # defined by the server.
3512 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3513 # This value is inRFC3339
3514 # text format.
3515 &quot;instancesBulkInsertOperationMetadata&quot;: {
3516 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3517 # Example key: zones/us-central1-a
3518 &quot;a_key&quot;: {
3519 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3520 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3521 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3522 # error.
3523 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3524 # if the flow is rolling forward or rolling back.
3525 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3526 },
3527 },
3528 },
3529 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3530 # Operation resources.
3531 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3532 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3533 # group of operations results from a `bulkInsert` API request.
3534 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3535 # `update`, or `delete`, and so on.
3536 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3537 # There is no requirement that this be linear or support any granularity of
3538 # operations. This should not be used to guess when the operation will be
3539 # complete. This number should monotonically increase as the operation
3540 # progresses.
3541 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3542 # applicable when performing regional operations.
3543 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3544 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3545 # this field will contain information on all underlying zonal actions and
3546 # their state.
3547 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3548 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3549 # Example key: zones/us-central1-a
3550 &quot;a_key&quot;: {
3551 &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
3552 # populated.
3553 # different programming environments, including REST APIs and RPC APIs. It is
3554 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3555 # three pieces of data: error code, error message, and error details.
3556 #
3557 # You can find out more about this error model and how to work with it in the
3558 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3559 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3560 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3561 # message types for APIs to use.
3562 {
3563 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3564 },
3565 ],
3566 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3567 # user-facing error message should be localized and sent in the
3568 # google.rpc.Status.details field, or localized by the client.
3569 },
3570 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3571 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3572 },
3573 },
3574 },
3575 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3576 # This value is inRFC3339
3577 # text format.
3578 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3579 # following:
3580 # `PENDING`, `RUNNING`, or `DONE`.
3581 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3582 # operation.
3583 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3584 # of the target resource.
3585 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3586 # operations related to creating a snapshot, this points to the disk
3587 # that the snapshot was created from.
3588 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3589 # `[email protected]` or
3590 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3591 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3592 # operation, this field will be populated.
3593 {
3594 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3595 # Engine returns NO_RESULTS_ON_PAGE if there
3596 # are no results in the response.
3597 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3598 # value format. For example:
3599 #
3600 # &quot;data&quot;: [
3601 # {
3602 # &quot;key&quot;: &quot;scope&quot;,
3603 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3604 # }
3605 {
3606 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3607 # returned. For example, for warnings where there are no results in a list
3608 # request for a particular zone, this key might be scope and
3609 # the key value might be the zone name. Other examples might be a key
3610 # indicating a deprecated resource and a suggested replacement, or a
3611 # warning about invalid network settings (for example, if an instance
3612 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3613 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3614 },
3615 ],
3616 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3617 },
3618 ],
3619 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3620 # applicable when performing per-zone operations.
3621 }</pre>
3622 </div>
3623
3624 <div class="method">
3625 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
3626 <pre>Sets the access control policy on the specified resource.
3627 Replaces any existing policy.
3628
3629 Args:
3630 project: string, Project ID for this request. (required)
3631 region: string, The name of the region for this request. (required)
3632 resource: string, Name or id of the resource for this request. (required)
3633 body: object, The request body.
3634 The object takes the form of:
3635
3636 {
3637 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
3638 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
3639 { # Associates `members`, or principals, with a `role`.
3640 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3641 #
3642 # If the condition evaluates to `true`, then this binding applies to the
3643 # current request.
3644 #
3645 # If the condition evaluates to `false`, then this binding does not apply to
3646 # the current request. However, a different role binding might grant the same
3647 # role to one or more of the principals in this binding.
3648 #
3649 # To learn which resources support conditions in their IAM policies, see the
3650 # [IAM
3651 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3652 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3653 # are documented at https://github.com/google/cel-spec.
3654 #
3655 # Example (Comparison):
3656 #
3657 # title: &quot;Summary size limit&quot;
3658 # description: &quot;Determines if a summary is less than 100 chars&quot;
3659 # expression: &quot;document.summary.size() &lt; 100&quot;
3660 #
3661 # Example (Equality):
3662 #
3663 # title: &quot;Requestor is owner&quot;
3664 # description: &quot;Determines if requestor is the document owner&quot;
3665 # expression: &quot;document.owner == request.auth.claims.email&quot;
3666 #
3667 # Example (Logic):
3668 #
3669 # title: &quot;Public documents&quot;
3670 # description: &quot;Determine whether the document should be publicly visible&quot;
3671 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3672 #
3673 # Example (Data Manipulation):
3674 #
3675 # title: &quot;Notification string&quot;
3676 # description: &quot;Create a notification string with a timestamp.&quot;
3677 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3678 #
3679 # The exact variables and functions that may be referenced within an expression
3680 # are determined by the service that evaluates it. See the service
3681 # documentation for additional information.
3682 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3683 # describes the expression, e.g. when hovered over it in a UI.
3684 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3685 # syntax.
3686 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3687 # reporting, e.g. a file name and a position in the file.
3688 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3689 # its purpose. This can be used e.g. in UIs which allow to enter the
3690 # expression.
3691 },
3692 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3693 # `members` can have the following values:
3694 #
3695 # * `allUsers`: A special identifier that represents anyone who is
3696 # on the internet; with or without a Google account.
3697 #
3698 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3699 # who is authenticated with a Google account or a service account.
3700 # Does not include identities that come from external identity providers
3701 # (IdPs) through identity federation.
3702 #
3703 # * `user:{emailid}`: An email address that represents a specific Google
3704 # account. For example, `[email protected]` .
3705 #
3706 #
3707 # * `serviceAccount:{emailid}`: An email address that represents a Google
3708 # service account. For example,
3709 # `[email protected]`.
3710 #
3711 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3712 # identifier for a
3713 # [Kubernetes service
3714 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3715 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3716 #
3717 # * `group:{emailid}`: An email address that represents a Google group.
3718 # For example, `[email protected]`.
3719 #
3720 #
3721 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3722 # users of that domain. For example, `google.com` or `example.com`.
3723 #
3724 #
3725 #
3726 #
3727 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3728 # A single identity in a workforce identity pool.
3729 #
3730 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3731 # All workforce identities in a group.
3732 #
3733 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3734 # All workforce identities with a specific attribute value.
3735 #
3736 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3737 # All identities in a workforce identity pool.
3738 #
3739 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3740 # A single identity in a workload identity pool.
3741 #
3742 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3743 # A workload identity pool group.
3744 #
3745 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3746 # All identities in a workload identity pool with a certain attribute.
3747 #
3748 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3749 # All identities in a workload identity pool.
3750 #
3751 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3752 # identifier) representing a user that has been recently deleted. For
3753 # example, `[email protected]?uid=123456789012345678901`. If the user is
3754 # recovered, this value reverts to `user:{emailid}` and the recovered user
3755 # retains the role in the binding.
3756 #
3757 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3758 # unique identifier) representing a service account that has been recently
3759 # deleted. For example,
3760 # `[email protected]?uid=123456789012345678901`.
3761 # If the service account is undeleted, this value reverts to
3762 # `serviceAccount:{emailid}` and the undeleted service account retains the
3763 # role in the binding.
3764 #
3765 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3766 # identifier) representing a Google group that has been recently
3767 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3768 # the group is recovered, this value reverts to `group:{emailid}` and the
3769 # recovered group retains the role in the binding.
3770 #
3771 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3772 # Deleted single identity in a workforce identity pool. For example,
3773 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3774 &quot;A String&quot;,
3775 ],
3776 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3777 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3778 #
3779 # For an overview of the IAM roles and permissions, see the
3780 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3781 # a list of the available pre-defined roles, see
3782 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3783 },
3784 ],
3785 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
3786 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
3787 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
3788 # the policy is limited to a few 10s of KB. An empty policy is in general a
3789 # valid policy but certain services (like Projects) might reject them.
3790 # controls for Google Cloud resources.
3791 #
3792 #
3793 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3794 # `members`, or principals, to a single `role`. Principals can be user
3795 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3796 # `role` is a named list of permissions; each `role` can be an IAM predefined
3797 # role or a user-created custom role.
3798 #
3799 # For some types of Google Cloud resources, a `binding` can also specify a
3800 # `condition`, which is a logical expression that allows access to a resource
3801 # only if the expression evaluates to `true`. A condition can add constraints
3802 # based on attributes of the request, the resource, or both. To learn which
3803 # resources support conditions in their IAM policies, see the
3804 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3805 #
3806 # **JSON example:**
3807 #
3808 # ```
3809 # {
3810 # &quot;bindings&quot;: [
3811 # {
3812 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3813 # &quot;members&quot;: [
3814 # &quot;user:[email protected]&quot;,
3815 # &quot;group:[email protected]&quot;,
3816 # &quot;domain:google.com&quot;,
3817 # &quot;serviceAccount:[email protected]&quot;
3818 # ]
3819 # },
3820 # {
3821 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3822 # &quot;members&quot;: [
3823 # &quot;user:[email protected]&quot;
3824 # ],
3825 # &quot;condition&quot;: {
3826 # &quot;title&quot;: &quot;expirable access&quot;,
3827 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3828 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3829 # }
3830 # }
3831 # ],
3832 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3833 # &quot;version&quot;: 3
3834 # }
3835 # ```
3836 #
3837 # **YAML example:**
3838 #
3839 # ```
3840 # bindings:
3841 # - members:
3842 # - user:[email protected]
3843 # - group:[email protected]
3844 # - domain:google.com
3845 # - serviceAccount:[email protected]
3846 # role: roles/resourcemanager.organizationAdmin
3847 # - members:
3848 # - user:[email protected]
3849 # role: roles/resourcemanager.organizationViewer
3850 # condition:
3851 # title: expirable access
3852 # description: Does not grant access after Sep 2020
3853 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3854 # etag: BwWWja0YfJA=
3855 # version: 3
3856 # ```
3857 #
3858 # For a description of IAM and its features, see the
3859 # [IAM documentation](https://cloud.google.com/iam/docs/).
3860 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3861 { # Specifies the audit configuration for a service.
3862 # The configuration determines which permission types are logged, and what
3863 # identities, if any, are exempted from logging.
3864 # An AuditConfig must have one or more AuditLogConfigs.
3865 #
3866 # If there are AuditConfigs for both `allServices` and a specific service,
3867 # the union of the two AuditConfigs is used for that service: the log_types
3868 # specified in each AuditConfig are enabled, and the exempted_members in each
3869 # AuditLogConfig are exempted.
3870 #
3871 # Example Policy with multiple AuditConfigs:
3872 #
3873 # {
3874 # &quot;audit_configs&quot;: [
3875 # {
3876 # &quot;service&quot;: &quot;allServices&quot;,
3877 # &quot;audit_log_configs&quot;: [
3878 # {
3879 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3880 # &quot;exempted_members&quot;: [
3881 # &quot;user:[email protected]&quot;
3882 # ]
3883 # },
3884 # {
3885 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3886 # },
3887 # {
3888 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3889 # }
3890 # ]
3891 # },
3892 # {
3893 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3894 # &quot;audit_log_configs&quot;: [
3895 # {
3896 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3897 # },
3898 # {
3899 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3900 # &quot;exempted_members&quot;: [
3901 # &quot;user:[email protected]&quot;
3902 # ]
3903 # }
3904 # ]
3905 # }
3906 # ]
3907 # }
3908 #
3909 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3910 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3911 # `[email protected]` from DATA_WRITE logging.
3912 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3913 { # Provides the configuration for logging a type of permissions.
3914 # Example:
3915 #
3916 # {
3917 # &quot;audit_log_configs&quot;: [
3918 # {
3919 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3920 # &quot;exempted_members&quot;: [
3921 # &quot;user:[email protected]&quot;
3922 # ]
3923 # },
3924 # {
3925 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3926 # }
3927 # ]
3928 # }
3929 #
3930 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3931 # [email protected] from DATA_READ logging.
3932 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3933 # permission.
3934 # Follows the same format of Binding.members.
3935 &quot;A String&quot;,
3936 ],
3937 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3938 },
3939 ],
3940 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3941 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3942 # `allServices` is a special value that covers all services.
3943 },
3944 ],
3945 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3946 # may specify a `condition` that determines how and when the `bindings` are
3947 # applied. Each of the `bindings` must contain at least one principal.
3948 #
3949 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3950 # of these principals can be Google groups. Each occurrence of a principal
3951 # counts towards these limits. For example, if the `bindings` grant 50
3952 # different roles to `user:[email protected]`, and not to any other
3953 # principal, then you can add another 1,450 principals to the `bindings` in
3954 # the `Policy`.
3955 { # Associates `members`, or principals, with a `role`.
3956 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3957 #
3958 # If the condition evaluates to `true`, then this binding applies to the
3959 # current request.
3960 #
3961 # If the condition evaluates to `false`, then this binding does not apply to
3962 # the current request. However, a different role binding might grant the same
3963 # role to one or more of the principals in this binding.
3964 #
3965 # To learn which resources support conditions in their IAM policies, see the
3966 # [IAM
3967 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3968 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3969 # are documented at https://github.com/google/cel-spec.
3970 #
3971 # Example (Comparison):
3972 #
3973 # title: &quot;Summary size limit&quot;
3974 # description: &quot;Determines if a summary is less than 100 chars&quot;
3975 # expression: &quot;document.summary.size() &lt; 100&quot;
3976 #
3977 # Example (Equality):
3978 #
3979 # title: &quot;Requestor is owner&quot;
3980 # description: &quot;Determines if requestor is the document owner&quot;
3981 # expression: &quot;document.owner == request.auth.claims.email&quot;
3982 #
3983 # Example (Logic):
3984 #
3985 # title: &quot;Public documents&quot;
3986 # description: &quot;Determine whether the document should be publicly visible&quot;
3987 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3988 #
3989 # Example (Data Manipulation):
3990 #
3991 # title: &quot;Notification string&quot;
3992 # description: &quot;Create a notification string with a timestamp.&quot;
3993 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3994 #
3995 # The exact variables and functions that may be referenced within an expression
3996 # are determined by the service that evaluates it. See the service
3997 # documentation for additional information.
3998 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3999 # describes the expression, e.g. when hovered over it in a UI.
4000 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4001 # syntax.
4002 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4003 # reporting, e.g. a file name and a position in the file.
4004 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4005 # its purpose. This can be used e.g. in UIs which allow to enter the
4006 # expression.
4007 },
4008 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4009 # `members` can have the following values:
4010 #
4011 # * `allUsers`: A special identifier that represents anyone who is
4012 # on the internet; with or without a Google account.
4013 #
4014 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4015 # who is authenticated with a Google account or a service account.
4016 # Does not include identities that come from external identity providers
4017 # (IdPs) through identity federation.
4018 #
4019 # * `user:{emailid}`: An email address that represents a specific Google
4020 # account. For example, `[email protected]` .
4021 #
4022 #
4023 # * `serviceAccount:{emailid}`: An email address that represents a Google
4024 # service account. For example,
4025 # `[email protected]`.
4026 #
4027 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4028 # identifier for a
4029 # [Kubernetes service
4030 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4031 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4032 #
4033 # * `group:{emailid}`: An email address that represents a Google group.
4034 # For example, `[email protected]`.
4035 #
4036 #
4037 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4038 # users of that domain. For example, `google.com` or `example.com`.
4039 #
4040 #
4041 #
4042 #
4043 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4044 # A single identity in a workforce identity pool.
4045 #
4046 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4047 # All workforce identities in a group.
4048 #
4049 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4050 # All workforce identities with a specific attribute value.
4051 #
4052 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4053 # All identities in a workforce identity pool.
4054 #
4055 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4056 # A single identity in a workload identity pool.
4057 #
4058 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4059 # A workload identity pool group.
4060 #
4061 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4062 # All identities in a workload identity pool with a certain attribute.
4063 #
4064 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4065 # All identities in a workload identity pool.
4066 #
4067 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4068 # identifier) representing a user that has been recently deleted. For
4069 # example, `[email protected]?uid=123456789012345678901`. If the user is
4070 # recovered, this value reverts to `user:{emailid}` and the recovered user
4071 # retains the role in the binding.
4072 #
4073 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4074 # unique identifier) representing a service account that has been recently
4075 # deleted. For example,
4076 # `[email protected]?uid=123456789012345678901`.
4077 # If the service account is undeleted, this value reverts to
4078 # `serviceAccount:{emailid}` and the undeleted service account retains the
4079 # role in the binding.
4080 #
4081 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4082 # identifier) representing a Google group that has been recently
4083 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4084 # the group is recovered, this value reverts to `group:{emailid}` and the
4085 # recovered group retains the role in the binding.
4086 #
4087 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4088 # Deleted single identity in a workforce identity pool. For example,
4089 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4090 &quot;A String&quot;,
4091 ],
4092 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4093 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4094 #
4095 # For an overview of the IAM roles and permissions, see the
4096 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4097 # a list of the available pre-defined roles, see
4098 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4099 },
4100 ],
4101 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4102 # prevent simultaneous updates of a policy from overwriting each other.
4103 # It is strongly suggested that systems make use of the `etag` in the
4104 # read-modify-write cycle to perform policy updates in order to avoid race
4105 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4106 # systems are expected to put that etag in the request to `setIamPolicy` to
4107 # ensure that their change will be applied to the same version of the policy.
4108 #
4109 # **Important:** If you use IAM Conditions, you must include the `etag` field
4110 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4111 # you to overwrite a version `3` policy with a version `1` policy, and all of
4112 # the conditions in the version `3` policy are lost.
4113 &quot;version&quot;: 42, # Specifies the format of the policy.
4114 #
4115 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4116 # are rejected.
4117 #
4118 # Any operation that affects conditional role bindings must specify version
4119 # `3`. This requirement applies to the following operations:
4120 #
4121 # * Getting a policy that includes a conditional role binding
4122 # * Adding a conditional role binding to a policy
4123 # * Changing a conditional role binding in a policy
4124 # * Removing any role binding, with or without a condition, from a policy
4125 # that includes conditions
4126 #
4127 # **Important:** If you use IAM Conditions, you must include the `etag` field
4128 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4129 # you to overwrite a version `3` policy with a version `1` policy, and all of
4130 # the conditions in the version `3` policy are lost.
4131 #
4132 # If a policy does not include any conditions, operations on that policy may
4133 # specify any valid version or leave the field unset.
4134 #
4135 # To learn which resources support conditions in their IAM policies, see the
4136 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4137 },
4138 }
4139
4140 x__xgafv: string, V1 error format.
4141 Allowed values
4142 1 - v1 error format
4143 2 - v2 error format
4144
4145 Returns:
4146 An object of the form:
4147
4148 { # An Identity and Access Management (IAM) policy, which specifies access
4149 # controls for Google Cloud resources.
4150 #
4151 #
4152 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
4153 # `members`, or principals, to a single `role`. Principals can be user
4154 # accounts, service accounts, Google groups, and domains (such as G Suite). A
4155 # `role` is a named list of permissions; each `role` can be an IAM predefined
4156 # role or a user-created custom role.
4157 #
4158 # For some types of Google Cloud resources, a `binding` can also specify a
4159 # `condition`, which is a logical expression that allows access to a resource
4160 # only if the expression evaluates to `true`. A condition can add constraints
4161 # based on attributes of the request, the resource, or both. To learn which
4162 # resources support conditions in their IAM policies, see the
4163 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4164 #
4165 # **JSON example:**
4166 #
4167 # ```
4168 # {
4169 # &quot;bindings&quot;: [
4170 # {
4171 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
4172 # &quot;members&quot;: [
4173 # &quot;user:[email protected]&quot;,
4174 # &quot;group:[email protected]&quot;,
4175 # &quot;domain:google.com&quot;,
4176 # &quot;serviceAccount:[email protected]&quot;
4177 # ]
4178 # },
4179 # {
4180 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
4181 # &quot;members&quot;: [
4182 # &quot;user:[email protected]&quot;
4183 # ],
4184 # &quot;condition&quot;: {
4185 # &quot;title&quot;: &quot;expirable access&quot;,
4186 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
4187 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
4188 # }
4189 # }
4190 # ],
4191 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
4192 # &quot;version&quot;: 3
4193 # }
4194 # ```
4195 #
4196 # **YAML example:**
4197 #
4198 # ```
4199 # bindings:
4200 # - members:
4201 # - user:[email protected]
4202 # - group:[email protected]
4203 # - domain:google.com
4204 # - serviceAccount:[email protected]
4205 # role: roles/resourcemanager.organizationAdmin
4206 # - members:
4207 # - user:[email protected]
4208 # role: roles/resourcemanager.organizationViewer
4209 # condition:
4210 # title: expirable access
4211 # description: Does not grant access after Sep 2020
4212 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
4213 # etag: BwWWja0YfJA=
4214 # version: 3
4215 # ```
4216 #
4217 # For a description of IAM and its features, see the
4218 # [IAM documentation](https://cloud.google.com/iam/docs/).
4219 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
4220 { # Specifies the audit configuration for a service.
4221 # The configuration determines which permission types are logged, and what
4222 # identities, if any, are exempted from logging.
4223 # An AuditConfig must have one or more AuditLogConfigs.
4224 #
4225 # If there are AuditConfigs for both `allServices` and a specific service,
4226 # the union of the two AuditConfigs is used for that service: the log_types
4227 # specified in each AuditConfig are enabled, and the exempted_members in each
4228 # AuditLogConfig are exempted.
4229 #
4230 # Example Policy with multiple AuditConfigs:
4231 #
4232 # {
4233 # &quot;audit_configs&quot;: [
4234 # {
4235 # &quot;service&quot;: &quot;allServices&quot;,
4236 # &quot;audit_log_configs&quot;: [
4237 # {
4238 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4239 # &quot;exempted_members&quot;: [
4240 # &quot;user:[email protected]&quot;
4241 # ]
4242 # },
4243 # {
4244 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4245 # },
4246 # {
4247 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
4248 # }
4249 # ]
4250 # },
4251 # {
4252 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
4253 # &quot;audit_log_configs&quot;: [
4254 # {
4255 # &quot;log_type&quot;: &quot;DATA_READ&quot;
4256 # },
4257 # {
4258 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
4259 # &quot;exempted_members&quot;: [
4260 # &quot;user:[email protected]&quot;
4261 # ]
4262 # }
4263 # ]
4264 # }
4265 # ]
4266 # }
4267 #
4268 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4269 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4270 # `[email protected]` from DATA_WRITE logging.
4271 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4272 { # Provides the configuration for logging a type of permissions.
4273 # Example:
4274 #
4275 # {
4276 # &quot;audit_log_configs&quot;: [
4277 # {
4278 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4279 # &quot;exempted_members&quot;: [
4280 # &quot;user:[email protected]&quot;
4281 # ]
4282 # },
4283 # {
4284 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4285 # }
4286 # ]
4287 # }
4288 #
4289 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4290 # [email protected] from DATA_READ logging.
4291 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4292 # permission.
4293 # Follows the same format of Binding.members.
4294 &quot;A String&quot;,
4295 ],
4296 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4297 },
4298 ],
4299 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4300 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4301 # `allServices` is a special value that covers all services.
4302 },
4303 ],
4304 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4305 # may specify a `condition` that determines how and when the `bindings` are
4306 # applied. Each of the `bindings` must contain at least one principal.
4307 #
4308 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4309 # of these principals can be Google groups. Each occurrence of a principal
4310 # counts towards these limits. For example, if the `bindings` grant 50
4311 # different roles to `user:[email protected]`, and not to any other
4312 # principal, then you can add another 1,450 principals to the `bindings` in
4313 # the `Policy`.
4314 { # Associates `members`, or principals, with a `role`.
4315 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4316 #
4317 # If the condition evaluates to `true`, then this binding applies to the
4318 # current request.
4319 #
4320 # If the condition evaluates to `false`, then this binding does not apply to
4321 # the current request. However, a different role binding might grant the same
4322 # role to one or more of the principals in this binding.
4323 #
4324 # To learn which resources support conditions in their IAM policies, see the
4325 # [IAM
4326 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4327 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4328 # are documented at https://github.com/google/cel-spec.
4329 #
4330 # Example (Comparison):
4331 #
4332 # title: &quot;Summary size limit&quot;
4333 # description: &quot;Determines if a summary is less than 100 chars&quot;
4334 # expression: &quot;document.summary.size() &lt; 100&quot;
4335 #
4336 # Example (Equality):
4337 #
4338 # title: &quot;Requestor is owner&quot;
4339 # description: &quot;Determines if requestor is the document owner&quot;
4340 # expression: &quot;document.owner == request.auth.claims.email&quot;
4341 #
4342 # Example (Logic):
4343 #
4344 # title: &quot;Public documents&quot;
4345 # description: &quot;Determine whether the document should be publicly visible&quot;
4346 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4347 #
4348 # Example (Data Manipulation):
4349 #
4350 # title: &quot;Notification string&quot;
4351 # description: &quot;Create a notification string with a timestamp.&quot;
4352 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4353 #
4354 # The exact variables and functions that may be referenced within an expression
4355 # are determined by the service that evaluates it. See the service
4356 # documentation for additional information.
4357 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4358 # describes the expression, e.g. when hovered over it in a UI.
4359 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4360 # syntax.
4361 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4362 # reporting, e.g. a file name and a position in the file.
4363 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4364 # its purpose. This can be used e.g. in UIs which allow to enter the
4365 # expression.
4366 },
4367 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4368 # `members` can have the following values:
4369 #
4370 # * `allUsers`: A special identifier that represents anyone who is
4371 # on the internet; with or without a Google account.
4372 #
4373 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4374 # who is authenticated with a Google account or a service account.
4375 # Does not include identities that come from external identity providers
4376 # (IdPs) through identity federation.
4377 #
4378 # * `user:{emailid}`: An email address that represents a specific Google
4379 # account. For example, `[email protected]` .
4380 #
4381 #
4382 # * `serviceAccount:{emailid}`: An email address that represents a Google
4383 # service account. For example,
4384 # `[email protected]`.
4385 #
4386 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4387 # identifier for a
4388 # [Kubernetes service
4389 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4390 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4391 #
4392 # * `group:{emailid}`: An email address that represents a Google group.
4393 # For example, `[email protected]`.
4394 #
4395 #
4396 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4397 # users of that domain. For example, `google.com` or `example.com`.
4398 #
4399 #
4400 #
4401 #
4402 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4403 # A single identity in a workforce identity pool.
4404 #
4405 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4406 # All workforce identities in a group.
4407 #
4408 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4409 # All workforce identities with a specific attribute value.
4410 #
4411 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4412 # All identities in a workforce identity pool.
4413 #
4414 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4415 # A single identity in a workload identity pool.
4416 #
4417 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4418 # A workload identity pool group.
4419 #
4420 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4421 # All identities in a workload identity pool with a certain attribute.
4422 #
4423 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4424 # All identities in a workload identity pool.
4425 #
4426 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4427 # identifier) representing a user that has been recently deleted. For
4428 # example, `[email protected]?uid=123456789012345678901`. If the user is
4429 # recovered, this value reverts to `user:{emailid}` and the recovered user
4430 # retains the role in the binding.
4431 #
4432 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4433 # unique identifier) representing a service account that has been recently
4434 # deleted. For example,
4435 # `[email protected]?uid=123456789012345678901`.
4436 # If the service account is undeleted, this value reverts to
4437 # `serviceAccount:{emailid}` and the undeleted service account retains the
4438 # role in the binding.
4439 #
4440 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4441 # identifier) representing a Google group that has been recently
4442 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4443 # the group is recovered, this value reverts to `group:{emailid}` and the
4444 # recovered group retains the role in the binding.
4445 #
4446 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4447 # Deleted single identity in a workforce identity pool. For example,
4448 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4449 &quot;A String&quot;,
4450 ],
4451 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4452 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4453 #
4454 # For an overview of the IAM roles and permissions, see the
4455 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4456 # a list of the available pre-defined roles, see
4457 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4458 },
4459 ],
4460 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4461 # prevent simultaneous updates of a policy from overwriting each other.
4462 # It is strongly suggested that systems make use of the `etag` in the
4463 # read-modify-write cycle to perform policy updates in order to avoid race
4464 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4465 # systems are expected to put that etag in the request to `setIamPolicy` to
4466 # ensure that their change will be applied to the same version of the policy.
4467 #
4468 # **Important:** If you use IAM Conditions, you must include the `etag` field
4469 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4470 # you to overwrite a version `3` policy with a version `1` policy, and all of
4471 # the conditions in the version `3` policy are lost.
4472 &quot;version&quot;: 42, # Specifies the format of the policy.
4473 #
4474 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4475 # are rejected.
4476 #
4477 # Any operation that affects conditional role bindings must specify version
4478 # `3`. This requirement applies to the following operations:
4479 #
4480 # * Getting a policy that includes a conditional role binding
4481 # * Adding a conditional role binding to a policy
4482 # * Changing a conditional role binding in a policy
4483 # * Removing any role binding, with or without a condition, from a policy
4484 # that includes conditions
4485 #
4486 # **Important:** If you use IAM Conditions, you must include the `etag` field
4487 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4488 # you to overwrite a version `3` policy with a version `1` policy, and all of
4489 # the conditions in the version `3` policy are lost.
4490 #
4491 # If a policy does not include any conditions, operations on that policy may
4492 # specify any valid version or leave the field unset.
4493 #
4494 # To learn which resources support conditions in their IAM policies, see the
4495 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4496 }</pre>
4497 </div>
4498
4499 <div class="method">
4500 <code class="details" id="setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body=None, requestId=None, x__xgafv=None)</code>
4501 <pre>Set whether VMs in this subnet can access Google services without assigning
4502 external IP addresses through Private Google Access.
4503
4504 Args:
4505 project: string, Project ID for this request. (required)
4506 region: string, Name of the region scoping this request. (required)
4507 subnetwork: string, Name of the Subnetwork resource. (required)
4508 body: object, The request body.
4509 The object takes the form of:
4510
4511 {
4512 &quot;privateIpGoogleAccess&quot;: True or False,
4513 }
4514
4515 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4516 that if you must retry your request, the server will know to ignore the
4517 request if it has already been completed.
4518
4519 For example, consider a situation where you make an initial request and
4520 the request times out. If you make the request again with the same
4521 request ID, the server can check if original operation with the same
4522 request ID was received, and if so, will ignore the second request. This
4523 prevents clients from accidentally creating duplicate commitments.
4524
4525 The request ID must be
4526 a valid UUID with the exception that zero UUID is not supported
4527 (00000000-0000-0000-0000-000000000000).
4528 x__xgafv: string, V1 error format.
4529 Allowed values
4530 1 - v1 error format
4531 2 - v2 error format
4532
4533 Returns:
4534 An object of the form:
4535
4536 { # Represents an Operation resource.
4537 #
4538 # Google Compute Engine has three Operation resources:
4539 #
4540 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4541 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4542 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4543 #
4544 # You can use an operation resource to manage asynchronous API requests.
4545 # For more information, readHandling
4546 # API responses.
4547 #
4548 # Operations can be global, regional or zonal.
4549 #
4550 # - For global operations, use the `globalOperations`
4551 # resource.
4552 # - For regional operations, use the
4553 # `regionOperations` resource.
4554 # - For zonal operations, use
4555 # the `zoneOperations` resource.
4556 #
4557 #
4558 #
4559 # For more information, read
4560 # Global, Regional, and Zonal Resources.
4561 #
4562 # Note that completed Operation resources have a limited
4563 # retention period.
4564 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4565 # Not present otherwise.
4566 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4567 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4568 # set when the operation is created.
4569 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4570 # text format.
4571 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4572 # this field will be populated.
4573 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4574 # operation.
4575 {
4576 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4577 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4578 # details. There is a set of defined message types to use for providing
4579 # details.The syntax depends on the error code. For example,
4580 # QuotaExceededInfo will have details when the error code is
4581 # QUOTA_EXCEEDED.
4582 {
4583 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4584 #
4585 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4586 # is not enabled:
4587 #
4588 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4589 # &quot;domain&quot;: &quot;googleapis.com&quot;
4590 # &quot;metadata&quot;: {
4591 # &quot;resource&quot;: &quot;projects/123&quot;,
4592 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4593 # }
4594 # }
4595 #
4596 # This response indicates that the pubsub.googleapis.com API is not enabled.
4597 #
4598 # Example of an error that is returned when attempting to create a Spanner
4599 # instance in a region that is out of stock:
4600 #
4601 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4602 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4603 # &quot;metadata&quot;: {
4604 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4605 # }
4606 # }
4607 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4608 # is typically the registered service name of the tool or product that
4609 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4610 # generated by some common infrastructure, the error domain must be a
4611 # globally unique value that identifies the infrastructure. For Google API
4612 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4613 &quot;metadatas&quot;: { # Additional structured details about this error.
4614 #
4615 # Keys must match a regular expression of `a-z+` but should
4616 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4617 # length. When identifying the current value of an exceeded limit, the units
4618 # should be contained in the key, not the value. For example, rather than
4619 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4620 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4621 # instances that can be created in a single (batch) request.
4622 &quot;a_key&quot;: &quot;A String&quot;,
4623 },
4624 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4625 # proximate cause of the error. Error reasons are unique within a particular
4626 # domain of errors. This should be at most 63 characters and match a
4627 # regular expression of `A-Z+[A-Z0-9]`, which represents
4628 # UPPER_SNAKE_CASE.
4629 },
4630 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4631 #
4632 # For example, if a quota check failed with an error indicating the calling
4633 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4634 # directly to the right place in the developer console to flip the bit.
4635 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4636 { # Describes a URL link.
4637 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4638 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4639 },
4640 ],
4641 },
4642 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4643 # which can be attached to an RPC error.
4644 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4645 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4646 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4647 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4648 },
4649 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4650 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4651 &quot;a_key&quot;: &quot;A String&quot;,
4652 },
4653 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4654 # type or metric.
4655 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4656 # or metric.
4657 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4658 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4659 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4660 },
4661 },
4662 ],
4663 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4664 # This property is optional.
4665 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4666 },
4667 ],
4668 },
4669 &quot;getVersionOperationMetadata&quot;: {
4670 &quot;inlineSbomInfo&quot;: {
4671 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4672 # appropriate identifiers.
4673 &quot;a_key&quot;: &quot;A String&quot;,
4674 },
4675 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4676 # identifiers.
4677 &quot;a_key&quot;: &quot;A String&quot;,
4678 },
4679 },
4680 },
4681 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4682 # message that was returned, such as `NOT FOUND`.
4683 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4684 # status code that was returned. For example, a `404` means the
4685 # resource was not found.
4686 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4687 # defined by the server.
4688 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4689 # This value is inRFC3339
4690 # text format.
4691 &quot;instancesBulkInsertOperationMetadata&quot;: {
4692 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4693 # Example key: zones/us-central1-a
4694 &quot;a_key&quot;: {
4695 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4696 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4697 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4698 # error.
4699 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4700 # if the flow is rolling forward or rolling back.
4701 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4702 },
4703 },
4704 },
4705 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4706 # Operation resources.
4707 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4708 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4709 # group of operations results from a `bulkInsert` API request.
4710 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4711 # `update`, or `delete`, and so on.
4712 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4713 # There is no requirement that this be linear or support any granularity of
4714 # operations. This should not be used to guess when the operation will be
4715 # complete. This number should monotonically increase as the operation
4716 # progresses.
4717 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4718 # applicable when performing regional operations.
4719 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4720 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4721 # this field will contain information on all underlying zonal actions and
4722 # their state.
4723 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4724 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4725 # Example key: zones/us-central1-a
4726 &quot;a_key&quot;: {
4727 &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
4728 # populated.
4729 # different programming environments, including REST APIs and RPC APIs. It is
4730 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4731 # three pieces of data: error code, error message, and error details.
4732 #
4733 # You can find out more about this error model and how to work with it in the
4734 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4735 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4736 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4737 # message types for APIs to use.
4738 {
4739 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4740 },
4741 ],
4742 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4743 # user-facing error message should be localized and sent in the
4744 # google.rpc.Status.details field, or localized by the client.
4745 },
4746 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4747 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4748 },
4749 },
4750 },
4751 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4752 # This value is inRFC3339
4753 # text format.
4754 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4755 # following:
4756 # `PENDING`, `RUNNING`, or `DONE`.
4757 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4758 # operation.
4759 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4760 # of the target resource.
4761 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4762 # operations related to creating a snapshot, this points to the disk
4763 # that the snapshot was created from.
4764 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4765 # `[email protected]` or
4766 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4767 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4768 # operation, this field will be populated.
4769 {
4770 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4771 # Engine returns NO_RESULTS_ON_PAGE if there
4772 # are no results in the response.
4773 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4774 # value format. For example:
4775 #
4776 # &quot;data&quot;: [
4777 # {
4778 # &quot;key&quot;: &quot;scope&quot;,
4779 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4780 # }
4781 {
4782 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4783 # returned. For example, for warnings where there are no results in a list
4784 # request for a particular zone, this key might be scope and
4785 # the key value might be the zone name. Other examples might be a key
4786 # indicating a deprecated resource and a suggested replacement, or a
4787 # warning about invalid network settings (for example, if an instance
4788 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4789 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4790 },
4791 ],
4792 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4793 },
4794 ],
4795 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4796 # applicable when performing per-zone operations.
4797 }</pre>
4798 </div>
4799
4800 <div class="method">
4801 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
4802 <pre>Returns permissions that a caller has on the specified resource.
4803
4804 Args:
4805 project: string, Project ID for this request. (required)
4806 region: string, The name of the region for this request. (required)
4807 resource: string, Name or id of the resource for this request. (required)
4808 body: object, The request body.
4809 The object takes the form of:
4810
4811 {
4812 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
4813 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
4814 &quot;A String&quot;,
4815 ],
4816 }
4817
4818 x__xgafv: string, V1 error format.
4819 Allowed values
4820 1 - v1 error format
4821 2 - v2 error format
4822
4823 Returns:
4824 An object of the form:
4825
4826 {
4827 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
4828 # allowed.
4829 &quot;A String&quot;,
4830 ],
4831 }</pre>
4832 </div>
4833
4834 </body></html>