Debian Codegraph @

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