Debian Codegraph @

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