Debian Codegraph @

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