Debian Codegraph @

docs/dyn/compute_alpha.targetSslProxies.html

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