Debian Codegraph @

docs/dyn/compute_alpha.sslCertificates.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.sslCertificates.html">sslCertificates</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 SslCertificate 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, sslCertificate, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified SslCertificate resource.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, sslCertificate, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified SslCertificate resource.</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">Creates a SslCertificate resource in the specified project using the data</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">Retrieves the list of SslCertificate resources available to the specified</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <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>
107 <pre>Retrieves the list of all SslCertificate resources, regional and global,
108 available to the specified project.
109
110 To prevent failure, Google recommends that you set the
111 `returnPartialSuccess` parameter to `true`.
112
113 Args:
114 project: string, Name of the project scoping this request. (required)
115 filter: string, A filter expression that filters resources listed in the response. Most
116 Compute resources support two types of filter expressions:
117 expressions that support regular expressions and expressions that follow
118 API improvement proposal AIP-160.
119 These two types of filter expressions cannot be mixed in one request.
120
121 If you want to use AIP-160, your expression must specify the field name, an
122 operator, and the value that you want to use for filtering. The value
123 must be a string, a number, or a boolean. The operator
124 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
125
126 For example, if you are filtering Compute Engine instances, you can
127 exclude instances named `example-instance` by specifying
128 `name != example-instance`.
129
130 The `:*` comparison can be used to test whether a key has been defined.
131 For example, to find all objects with `owner` label use:
132 ```
133 labels.owner:*
134 ```
135
136 You can also filter nested fields. For example, you could specify
137 `scheduling.automaticRestart = false` to include instances only
138 if they are not scheduled for automatic restarts. You can use filtering
139 on nested fields to filter based onresource labels.
140
141 To filter on multiple expressions, provide each separate expression within
142 parentheses. For example:
143 ```
144 (scheduling.automaticRestart = true)
145 (cpuPlatform = &quot;Intel Skylake&quot;)
146 ```
147 By default, each expression is an `AND` expression. However, you
148 can include `AND` and `OR` expressions explicitly.
149 For example:
150 ```
151 (cpuPlatform = &quot;Intel Skylake&quot;) OR
152 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
153 (scheduling.automaticRestart = true)
154 ```
155
156 If you want to use a regular expression, use the `eq` (equal) or `ne`
157 (not equal) operator against a single un-parenthesized expression with or
158 without quotes or against multiple parenthesized expressions. Examples:
159
160 `fieldname eq unquoted literal`
161 `fieldname eq &#x27;single quoted literal&#x27;`
162 `fieldname eq &quot;double quoted literal&quot;`
163 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
164
165 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
166 The literal value must match the entire field.
167
168 For example, to filter for instances that do not end with name &quot;instance&quot;,
169 you would use `name ne .*instance`.
170
171 You cannot combine constraints on multiple fields using regular
172 expressions.
173 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
174 global) should be included in the response. For new resource types added
175 after this field, the flag has no effect as new resource types will always
176 include every visible scope for each scope type in response. For resource
177 types which predate this field, if this flag is omitted or false, only
178 scopes of the scope types where the resource type is expected to be found
179 will be included.
180 maxResults: integer, The maximum number of results per page that should be returned.
181 If the number of available results is larger than `maxResults`,
182 Compute Engine returns a `nextPageToken` that can be used to get
183 the next page of results in subsequent list requests. Acceptable values are
184 `0` to `500`, inclusive. (Default: `500`)
185 orderBy: string, Sorts list results by a certain order. By default, results
186 are returned in alphanumerical order based on the resource name.
187
188 You can also sort results in descending order based on the creation
189 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
190 results based on the `creationTimestamp` field in
191 reverse chronological order (newest result first). Use this to sort
192 resources like operations so that the newest operation is returned first.
193
194 Currently, only sorting by `name` or
195 `creationTimestamp desc` is supported.
196 pageToken: string, Specifies a page token to use. Set `pageToken` to the
197 `nextPageToken` returned by a previous list request to get
198 the next page of results.
199 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
200 of failure. The default value is false.
201
202 For example, when partial success behavior is enabled, aggregatedList for a
203 single zone scope either returns all resources in the zone or no resources,
204 with an error code.
205 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
206 aggregated list request is invoked for subnetworks list-usable api.
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212 Returns:
213 An object of the form:
214
215 {
216 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
217 &quot;items&quot;: { # A list of SslCertificatesScopedList resources.
218 &quot;a_key&quot;: { # Name of the scope containing this set of SslCertificates.
219 &quot;sslCertificates&quot;: [ # List of SslCertificates contained in this scope.
220 { # Represents an SSL certificate resource.
221 #
222 # Google Compute Engine has two SSL certificate resources:
223 #
224 # * [Global](/compute/docs/reference/rest/alpha/sslCertificates)
225 # * [Regional](/compute/docs/reference/rest/alpha/regionSslCertificates)
226 #
227 #
228 # The global SSL certificates (sslCertificates) are used by:
229 #
230 # - Global external Application Load Balancers
231 # - Classic Application Load Balancers
232 # - Proxy Network Load Balancers (with target SSL proxies)
233 #
234 #
235 #
236 # The regional SSL certificates (regionSslCertificates) are used
237 # by:
238 #
239 # - Regional external Application Load Balancers
240 # - Regional internal Application Load Balancers
241 #
242 #
243 #
244 # Optionally, certificate file contents that you upload can contain a set of up
245 # to five PEM-encoded certificates.
246 # The API call creates an object (sslCertificate) that holds this data.
247 # You can use SSL keys and certificates to secure connections to a load
248 # balancer.
249 # For more information, read
250 # Creating and using SSL certificates,SSL certificates
251 # quotas and limits, and
252 # Troubleshooting SSL certificates.
253 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must
254 # be in PEM format. The certificate chain must be no greater than 5 certs
255 # long. The chain must include at least one intermediate cert.
256 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
257 # text format.
258 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
259 # create the resource.
260 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. [Output Only] Expire time of the certificate. RFC3339
261 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
262 # defined by the server.
263 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates.
264 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
265 &quot;domainStatus&quot;: { # Output only. [Output only] Detailed statuses of the domains specified for managed
266 # certificate resource.
267 &quot;a_key&quot;: &quot;A String&quot;,
268 },
269 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each
270 # Google-managed SSL certificate supports up to the [maximum number of
271 # domains per Google-managed SSL
272 # certificate](/load-balancing/docs/quotas#ssl_certificates).
273 &quot;A String&quot;,
274 ],
275 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output only] Status of the managed certificate resource.
276 },
277 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
278 # The name must be 1-63 characters long, and comply withRFC1035.
279 # Specifically, the name must be 1-63 characters long and match the regular
280 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
281 # character must be a lowercase letter, and all following characters must
282 # be a dash, lowercase letter, or digit, except the last character, which
283 # cannot be a dash.
284 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private
285 # key file must be in PEM format. For security, only insert
286 # requests include this field.
287 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional SSL Certificate
288 # resides. This field is not applicable to global SSL Certificate.
289 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
290 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
291 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
292 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in
293 # PEM format. The certificate chain must be no greater than 5 certs
294 # long. The chain must include at least one intermediate cert.
295 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert
296 # requests will include this field.
297 },
298 &quot;subjectAlternativeNames&quot;: [ # Output only. [Output Only] Domains associated with the certificate via Subject
299 # Alternative Name.
300 &quot;A String&quot;,
301 ],
302 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or
303 # &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fieldscertificate and private_key are used.
304 },
305 ],
306 &quot;warning&quot;: { # Informational warning which replaces the list of
307 # backend services when the list is empty.
308 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
309 # Engine returns NO_RESULTS_ON_PAGE if there
310 # are no results in the response.
311 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
312 # value format. For example:
313 #
314 # &quot;data&quot;: [
315 # {
316 # &quot;key&quot;: &quot;scope&quot;,
317 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
318 # }
319 {
320 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
321 # returned. For example, for warnings where there are no results in a list
322 # request for a particular zone, this key might be scope and
323 # the key value might be the zone name. Other examples might be a key
324 # indicating a deprecated resource and a suggested replacement, or a
325 # warning about invalid network settings (for example, if an instance
326 # attempts to perform IP forwarding but is not enabled for IP forwarding).
327 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
328 },
329 ],
330 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
331 },
332 },
333 },
334 &quot;kind&quot;: &quot;compute#sslCertificateAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#sslCertificateAggregatedList for lists of SSL
335 # Certificates.
336 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
337 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
338 # the query parameter pageToken in the next list request.
339 # Subsequent list requests will have their own nextPageToken to
340 # continue paging through the results.
341 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
342 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
343 &quot;A String&quot;,
344 ],
345 &quot;warning&quot;: { # [Output Only] Informational warning message.
346 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
347 # Engine returns NO_RESULTS_ON_PAGE if there
348 # are no results in the response.
349 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
350 # value format. For example:
351 #
352 # &quot;data&quot;: [
353 # {
354 # &quot;key&quot;: &quot;scope&quot;,
355 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
356 # }
357 {
358 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
359 # returned. For example, for warnings where there are no results in a list
360 # request for a particular zone, this key might be scope and
361 # the key value might be the zone name. Other examples might be a key
362 # indicating a deprecated resource and a suggested replacement, or a
363 # warning about invalid network settings (for example, if an instance
364 # attempts to perform IP forwarding but is not enabled for IP forwarding).
365 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
366 },
367 ],
368 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
369 },
370 }</pre>
371 </div>
372
373 <div class="method">
374 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
375 <pre>Retrieves the next page of results.
376
377 Args:
378 previous_request: The request for the previous page. (required)
379 previous_response: The response from the request for the previous page. (required)
380
381 Returns:
382 A request object that you can call &#x27;execute()&#x27; on to request the next
383 page. Returns None if there are no more items in the collection.
384 </pre>
385 </div>
386
387 <div class="method">
388 <code class="details" id="close">close()</code>
389 <pre>Close httplib2 connections.</pre>
390 </div>
391
392 <div class="method">
393 <code class="details" id="delete">delete(project, sslCertificate, requestId=None, x__xgafv=None)</code>
394 <pre>Deletes the specified SslCertificate resource.
395
396 Args:
397 project: string, Project ID for this request. (required)
398 sslCertificate: string, Name of the SslCertificate resource to delete. (required)
399 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
400 that if you must retry your request, the server will know to ignore the
401 request if it has already been completed.
402
403 For example, consider a situation where you make an initial request and
404 the request times out. If you make the request again with the same
405 request ID, the server can check if original operation with the same
406 request ID was received, and if so, will ignore the second request. This
407 prevents clients from accidentally creating duplicate commitments.
408
409 The request ID must be
410 a valid UUID with the exception that zero UUID is not supported
411 (00000000-0000-0000-0000-000000000000).
412 x__xgafv: string, V1 error format.
413 Allowed values
414 1 - v1 error format
415 2 - v2 error format
416
417 Returns:
418 An object of the form:
419
420 { # Represents an Operation resource.
421 #
422 # Google Compute Engine has three Operation resources:
423 #
424 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
425 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
426 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
427 #
428 # You can use an operation resource to manage asynchronous API requests.
429 # For more information, readHandling
430 # API responses.
431 #
432 # Operations can be global, regional or zonal.
433 #
434 # - For global operations, use the `globalOperations`
435 # resource.
436 # - For regional operations, use the
437 # `regionOperations` resource.
438 # - For zonal operations, use
439 # the `zoneOperations` resource.
440 #
441 #
442 #
443 # For more information, read
444 # Global, Regional, and Zonal Resources.
445 #
446 # Note that completed Operation resources have a limited
447 # retention period.
448 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
449 # Not present otherwise.
450 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
451 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
452 # set when the operation is created.
453 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
454 # text format.
455 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
456 # this field will be populated.
457 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
458 # operation.
459 {
460 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
461 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
462 # details. There is a set of defined message types to use for providing
463 # details.The syntax depends on the error code. For example,
464 # QuotaExceededInfo will have details when the error code is
465 # QUOTA_EXCEEDED.
466 {
467 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
468 #
469 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
470 # is not enabled:
471 #
472 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
473 # &quot;domain&quot;: &quot;googleapis.com&quot;
474 # &quot;metadata&quot;: {
475 # &quot;resource&quot;: &quot;projects/123&quot;,
476 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
477 # }
478 # }
479 #
480 # This response indicates that the pubsub.googleapis.com API is not enabled.
481 #
482 # Example of an error that is returned when attempting to create a Spanner
483 # instance in a region that is out of stock:
484 #
485 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
486 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
487 # &quot;metadata&quot;: {
488 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
489 # }
490 # }
491 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
492 # is typically the registered service name of the tool or product that
493 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
494 # generated by some common infrastructure, the error domain must be a
495 # globally unique value that identifies the infrastructure. For Google API
496 # infrastructure, the error domain is &quot;googleapis.com&quot;.
497 &quot;metadatas&quot;: { # Additional structured details about this error.
498 #
499 # Keys must match a regular expression of `a-z+` but should
500 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
501 # length. When identifying the current value of an exceeded limit, the units
502 # should be contained in the key, not the value. For example, rather than
503 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
504 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
505 # instances that can be created in a single (batch) request.
506 &quot;a_key&quot;: &quot;A String&quot;,
507 },
508 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
509 # proximate cause of the error. Error reasons are unique within a particular
510 # domain of errors. This should be at most 63 characters and match a
511 # regular expression of `A-Z+[A-Z0-9]`, which represents
512 # UPPER_SNAKE_CASE.
513 },
514 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
515 #
516 # For example, if a quota check failed with an error indicating the calling
517 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
518 # directly to the right place in the developer console to flip the bit.
519 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
520 { # Describes a URL link.
521 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
522 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
523 },
524 ],
525 },
526 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
527 # which can be attached to an RPC error.
528 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
529 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
530 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
531 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
532 },
533 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
534 &quot;dimensions&quot;: { # The map holding related quota dimensions.
535 &quot;a_key&quot;: &quot;A String&quot;,
536 },
537 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
538 # type or metric.
539 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
540 # or metric.
541 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
542 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
543 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
544 },
545 },
546 ],
547 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
548 # This property is optional.
549 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
550 },
551 ],
552 },
553 &quot;getVersionOperationMetadata&quot;: {
554 &quot;inlineSbomInfo&quot;: {
555 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
556 # appropriate identifiers.
557 &quot;a_key&quot;: &quot;A String&quot;,
558 },
559 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
560 # identifiers.
561 &quot;a_key&quot;: &quot;A String&quot;,
562 },
563 },
564 },
565 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
566 # message that was returned, such as `NOT FOUND`.
567 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
568 # status code that was returned. For example, a `404` means the
569 # resource was not found.
570 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
571 # defined by the server.
572 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
573 # This value is inRFC3339
574 # text format.
575 &quot;instancesBulkInsertOperationMetadata&quot;: {
576 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
577 # Example key: zones/us-central1-a
578 &quot;a_key&quot;: {
579 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
580 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
581 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
582 # error.
583 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
584 # if the flow is rolling forward or rolling back.
585 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
586 },
587 },
588 },
589 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
590 # Operation resources.
591 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
592 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
593 # group of operations results from a `bulkInsert` API request.
594 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
595 # `update`, or `delete`, and so on.
596 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
597 # There is no requirement that this be linear or support any granularity of
598 # operations. This should not be used to guess when the operation will be
599 # complete. This number should monotonically increase as the operation
600 # progresses.
601 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
602 # applicable when performing regional operations.
603 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
604 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
605 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
606 # this field will contain information on all underlying zonal actions and
607 # their state.
608 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
609 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
610 # Example key: zones/us-central1-a
611 &quot;a_key&quot;: {
612 &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
613 # populated.
614 # different programming environments, including REST APIs and RPC APIs. It is
615 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
616 # three pieces of data: error code, error message, and error details.
617 #
618 # You can find out more about this error model and how to work with it in the
619 # [API Design Guide](https://cloud.google.com/apis/design/errors).
620 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
621 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
622 # message types for APIs to use.
623 {
624 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
625 },
626 ],
627 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
628 # user-facing error message should be localized and sent in the
629 # google.rpc.Status.details field, or localized by the client.
630 },
631 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
632 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
633 },
634 },
635 },
636 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
637 # This value is inRFC3339
638 # text format.
639 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
640 # following:
641 # `PENDING`, `RUNNING`, or `DONE`.
642 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
643 # operation.
644 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
645 # of the target resource.
646 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
647 # operations related to creating a snapshot, this points to the disk
648 # that the snapshot was created from.
649 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
650 # `[email protected]` or
651 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
652 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
653 # operation, this field will be populated.
654 {
655 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
656 # Engine returns NO_RESULTS_ON_PAGE if there
657 # are no results in the response.
658 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
659 # value format. For example:
660 #
661 # &quot;data&quot;: [
662 # {
663 # &quot;key&quot;: &quot;scope&quot;,
664 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
665 # }
666 {
667 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
668 # returned. For example, for warnings where there are no results in a list
669 # request for a particular zone, this key might be scope and
670 # the key value might be the zone name. Other examples might be a key
671 # indicating a deprecated resource and a suggested replacement, or a
672 # warning about invalid network settings (for example, if an instance
673 # attempts to perform IP forwarding but is not enabled for IP forwarding).
674 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
675 },
676 ],
677 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
678 },
679 ],
680 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
681 # applicable when performing per-zone operations.
682 }</pre>
683 </div>
684
685 <div class="method">
686 <code class="details" id="get">get(project, sslCertificate, x__xgafv=None)</code>
687 <pre>Returns the specified SslCertificate resource.
688
689 Args:
690 project: string, Project ID for this request. (required)
691 sslCertificate: string, Name of the SslCertificate resource to return. (required)
692 x__xgafv: string, V1 error format.
693 Allowed values
694 1 - v1 error format
695 2 - v2 error format
696
697 Returns:
698 An object of the form:
699
700 { # Represents an SSL certificate resource.
701 #
702 # Google Compute Engine has two SSL certificate resources:
703 #
704 # * [Global](/compute/docs/reference/rest/alpha/sslCertificates)
705 # * [Regional](/compute/docs/reference/rest/alpha/regionSslCertificates)
706 #
707 #
708 # The global SSL certificates (sslCertificates) are used by:
709 #
710 # - Global external Application Load Balancers
711 # - Classic Application Load Balancers
712 # - Proxy Network Load Balancers (with target SSL proxies)
713 #
714 #
715 #
716 # The regional SSL certificates (regionSslCertificates) are used
717 # by:
718 #
719 # - Regional external Application Load Balancers
720 # - Regional internal Application Load Balancers
721 #
722 #
723 #
724 # Optionally, certificate file contents that you upload can contain a set of up
725 # to five PEM-encoded certificates.
726 # The API call creates an object (sslCertificate) that holds this data.
727 # You can use SSL keys and certificates to secure connections to a load
728 # balancer.
729 # For more information, read
730 # Creating and using SSL certificates,SSL certificates
731 # quotas and limits, and
732 # Troubleshooting SSL certificates.
733 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must
734 # be in PEM format. The certificate chain must be no greater than 5 certs
735 # long. The chain must include at least one intermediate cert.
736 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
737 # text format.
738 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
739 # create the resource.
740 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. [Output Only] Expire time of the certificate. RFC3339
741 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
742 # defined by the server.
743 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates.
744 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
745 &quot;domainStatus&quot;: { # Output only. [Output only] Detailed statuses of the domains specified for managed
746 # certificate resource.
747 &quot;a_key&quot;: &quot;A String&quot;,
748 },
749 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each
750 # Google-managed SSL certificate supports up to the [maximum number of
751 # domains per Google-managed SSL
752 # certificate](/load-balancing/docs/quotas#ssl_certificates).
753 &quot;A String&quot;,
754 ],
755 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output only] Status of the managed certificate resource.
756 },
757 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
758 # The name must be 1-63 characters long, and comply withRFC1035.
759 # Specifically, the name must be 1-63 characters long and match the regular
760 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
761 # character must be a lowercase letter, and all following characters must
762 # be a dash, lowercase letter, or digit, except the last character, which
763 # cannot be a dash.
764 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private
765 # key file must be in PEM format. For security, only insert
766 # requests include this field.
767 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional SSL Certificate
768 # resides. This field is not applicable to global SSL Certificate.
769 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
770 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
771 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
772 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in
773 # PEM format. The certificate chain must be no greater than 5 certs
774 # long. The chain must include at least one intermediate cert.
775 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert
776 # requests will include this field.
777 },
778 &quot;subjectAlternativeNames&quot;: [ # Output only. [Output Only] Domains associated with the certificate via Subject
779 # Alternative Name.
780 &quot;A String&quot;,
781 ],
782 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or
783 # &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fieldscertificate and private_key are used.
784 }</pre>
785 </div>
786
787 <div class="method">
788 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
789 <pre>Creates a SslCertificate resource in the specified project using the data
790 included in the request.
791
792 Args:
793 project: string, Project ID for this request. (required)
794 body: object, The request body.
795 The object takes the form of:
796
797 { # Represents an SSL certificate resource.
798 #
799 # Google Compute Engine has two SSL certificate resources:
800 #
801 # * [Global](/compute/docs/reference/rest/alpha/sslCertificates)
802 # * [Regional](/compute/docs/reference/rest/alpha/regionSslCertificates)
803 #
804 #
805 # The global SSL certificates (sslCertificates) are used by:
806 #
807 # - Global external Application Load Balancers
808 # - Classic Application Load Balancers
809 # - Proxy Network Load Balancers (with target SSL proxies)
810 #
811 #
812 #
813 # The regional SSL certificates (regionSslCertificates) are used
814 # by:
815 #
816 # - Regional external Application Load Balancers
817 # - Regional internal Application Load Balancers
818 #
819 #
820 #
821 # Optionally, certificate file contents that you upload can contain a set of up
822 # to five PEM-encoded certificates.
823 # The API call creates an object (sslCertificate) that holds this data.
824 # You can use SSL keys and certificates to secure connections to a load
825 # balancer.
826 # For more information, read
827 # Creating and using SSL certificates,SSL certificates
828 # quotas and limits, and
829 # Troubleshooting SSL certificates.
830 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must
831 # be in PEM format. The certificate chain must be no greater than 5 certs
832 # long. The chain must include at least one intermediate cert.
833 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
834 # text format.
835 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
836 # create the resource.
837 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. [Output Only] Expire time of the certificate. RFC3339
838 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
839 # defined by the server.
840 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates.
841 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
842 &quot;domainStatus&quot;: { # Output only. [Output only] Detailed statuses of the domains specified for managed
843 # certificate resource.
844 &quot;a_key&quot;: &quot;A String&quot;,
845 },
846 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each
847 # Google-managed SSL certificate supports up to the [maximum number of
848 # domains per Google-managed SSL
849 # certificate](/load-balancing/docs/quotas#ssl_certificates).
850 &quot;A String&quot;,
851 ],
852 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output only] Status of the managed certificate resource.
853 },
854 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
855 # The name must be 1-63 characters long, and comply withRFC1035.
856 # Specifically, the name must be 1-63 characters long and match the regular
857 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
858 # character must be a lowercase letter, and all following characters must
859 # be a dash, lowercase letter, or digit, except the last character, which
860 # cannot be a dash.
861 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private
862 # key file must be in PEM format. For security, only insert
863 # requests include this field.
864 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional SSL Certificate
865 # resides. This field is not applicable to global SSL Certificate.
866 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
867 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
868 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
869 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in
870 # PEM format. The certificate chain must be no greater than 5 certs
871 # long. The chain must include at least one intermediate cert.
872 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert
873 # requests will include this field.
874 },
875 &quot;subjectAlternativeNames&quot;: [ # Output only. [Output Only] Domains associated with the certificate via Subject
876 # Alternative Name.
877 &quot;A String&quot;,
878 ],
879 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or
880 # &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fieldscertificate and private_key are used.
881 }
882
883 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
884 that if you must retry your request, the server will know to ignore the
885 request if it has already been completed.
886
887 For example, consider a situation where you make an initial request and
888 the request times out. If you make the request again with the same
889 request ID, the server can check if original operation with the same
890 request ID was received, and if so, will ignore the second request. This
891 prevents clients from accidentally creating duplicate commitments.
892
893 The request ID must be
894 a valid UUID with the exception that zero UUID is not supported
895 (00000000-0000-0000-0000-000000000000).
896 x__xgafv: string, V1 error format.
897 Allowed values
898 1 - v1 error format
899 2 - v2 error format
900
901 Returns:
902 An object of the form:
903
904 { # Represents an Operation resource.
905 #
906 # Google Compute Engine has three Operation resources:
907 #
908 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
909 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
910 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
911 #
912 # You can use an operation resource to manage asynchronous API requests.
913 # For more information, readHandling
914 # API responses.
915 #
916 # Operations can be global, regional or zonal.
917 #
918 # - For global operations, use the `globalOperations`
919 # resource.
920 # - For regional operations, use the
921 # `regionOperations` resource.
922 # - For zonal operations, use
923 # the `zoneOperations` resource.
924 #
925 #
926 #
927 # For more information, read
928 # Global, Regional, and Zonal Resources.
929 #
930 # Note that completed Operation resources have a limited
931 # retention period.
932 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
933 # Not present otherwise.
934 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
935 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
936 # set when the operation is created.
937 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
938 # text format.
939 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
940 # this field will be populated.
941 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
942 # operation.
943 {
944 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
945 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
946 # details. There is a set of defined message types to use for providing
947 # details.The syntax depends on the error code. For example,
948 # QuotaExceededInfo will have details when the error code is
949 # QUOTA_EXCEEDED.
950 {
951 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
952 #
953 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
954 # is not enabled:
955 #
956 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
957 # &quot;domain&quot;: &quot;googleapis.com&quot;
958 # &quot;metadata&quot;: {
959 # &quot;resource&quot;: &quot;projects/123&quot;,
960 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
961 # }
962 # }
963 #
964 # This response indicates that the pubsub.googleapis.com API is not enabled.
965 #
966 # Example of an error that is returned when attempting to create a Spanner
967 # instance in a region that is out of stock:
968 #
969 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
970 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
971 # &quot;metadata&quot;: {
972 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
973 # }
974 # }
975 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
976 # is typically the registered service name of the tool or product that
977 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
978 # generated by some common infrastructure, the error domain must be a
979 # globally unique value that identifies the infrastructure. For Google API
980 # infrastructure, the error domain is &quot;googleapis.com&quot;.
981 &quot;metadatas&quot;: { # Additional structured details about this error.
982 #
983 # Keys must match a regular expression of `a-z+` but should
984 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
985 # length. When identifying the current value of an exceeded limit, the units
986 # should be contained in the key, not the value. For example, rather than
987 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
988 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
989 # instances that can be created in a single (batch) request.
990 &quot;a_key&quot;: &quot;A String&quot;,
991 },
992 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
993 # proximate cause of the error. Error reasons are unique within a particular
994 # domain of errors. This should be at most 63 characters and match a
995 # regular expression of `A-Z+[A-Z0-9]`, which represents
996 # UPPER_SNAKE_CASE.
997 },
998 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
999 #
1000 # For example, if a quota check failed with an error indicating the calling
1001 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1002 # directly to the right place in the developer console to flip the bit.
1003 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1004 { # Describes a URL link.
1005 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1006 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1007 },
1008 ],
1009 },
1010 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1011 # which can be attached to an RPC error.
1012 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1013 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1014 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1015 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1016 },
1017 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1018 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1019 &quot;a_key&quot;: &quot;A String&quot;,
1020 },
1021 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1022 # type or metric.
1023 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1024 # or metric.
1025 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1026 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1027 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1028 },
1029 },
1030 ],
1031 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1032 # This property is optional.
1033 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1034 },
1035 ],
1036 },
1037 &quot;getVersionOperationMetadata&quot;: {
1038 &quot;inlineSbomInfo&quot;: {
1039 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1040 # appropriate identifiers.
1041 &quot;a_key&quot;: &quot;A String&quot;,
1042 },
1043 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1044 # identifiers.
1045 &quot;a_key&quot;: &quot;A String&quot;,
1046 },
1047 },
1048 },
1049 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1050 # message that was returned, such as `NOT FOUND`.
1051 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1052 # status code that was returned. For example, a `404` means the
1053 # resource was not found.
1054 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1055 # defined by the server.
1056 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1057 # This value is inRFC3339
1058 # text format.
1059 &quot;instancesBulkInsertOperationMetadata&quot;: {
1060 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1061 # Example key: zones/us-central1-a
1062 &quot;a_key&quot;: {
1063 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1064 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1065 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1066 # error.
1067 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1068 # if the flow is rolling forward or rolling back.
1069 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1070 },
1071 },
1072 },
1073 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1074 # Operation resources.
1075 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1076 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1077 # group of operations results from a `bulkInsert` API request.
1078 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1079 # `update`, or `delete`, and so on.
1080 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1081 # There is no requirement that this be linear or support any granularity of
1082 # operations. This should not be used to guess when the operation will be
1083 # complete. This number should monotonically increase as the operation
1084 # progresses.
1085 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1086 # applicable when performing regional operations.
1087 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1088 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1089 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1090 # this field will contain information on all underlying zonal actions and
1091 # their state.
1092 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1093 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1094 # Example key: zones/us-central1-a
1095 &quot;a_key&quot;: {
1096 &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
1097 # populated.
1098 # different programming environments, including REST APIs and RPC APIs. It is
1099 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1100 # three pieces of data: error code, error message, and error details.
1101 #
1102 # You can find out more about this error model and how to work with it in the
1103 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1104 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1105 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1106 # message types for APIs to use.
1107 {
1108 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1109 },
1110 ],
1111 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1112 # user-facing error message should be localized and sent in the
1113 # google.rpc.Status.details field, or localized by the client.
1114 },
1115 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1116 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1117 },
1118 },
1119 },
1120 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1121 # This value is inRFC3339
1122 # text format.
1123 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1124 # following:
1125 # `PENDING`, `RUNNING`, or `DONE`.
1126 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1127 # operation.
1128 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1129 # of the target resource.
1130 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1131 # operations related to creating a snapshot, this points to the disk
1132 # that the snapshot was created from.
1133 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1134 # `[email protected]` or
1135 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1136 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1137 # operation, this field will be populated.
1138 {
1139 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1140 # Engine returns NO_RESULTS_ON_PAGE if there
1141 # are no results in the response.
1142 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1143 # value format. For example:
1144 #
1145 # &quot;data&quot;: [
1146 # {
1147 # &quot;key&quot;: &quot;scope&quot;,
1148 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1149 # }
1150 {
1151 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1152 # returned. For example, for warnings where there are no results in a list
1153 # request for a particular zone, this key might be scope and
1154 # the key value might be the zone name. Other examples might be a key
1155 # indicating a deprecated resource and a suggested replacement, or a
1156 # warning about invalid network settings (for example, if an instance
1157 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1158 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1159 },
1160 ],
1161 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1162 },
1163 ],
1164 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1165 # applicable when performing per-zone operations.
1166 }</pre>
1167 </div>
1168
1169 <div class="method">
1170 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1171 <pre>Retrieves the list of SslCertificate resources available to the specified
1172 project.
1173
1174 Args:
1175 project: string, Project ID for this request. (required)
1176 filter: string, A filter expression that filters resources listed in the response. Most
1177 Compute resources support two types of filter expressions:
1178 expressions that support regular expressions and expressions that follow
1179 API improvement proposal AIP-160.
1180 These two types of filter expressions cannot be mixed in one request.
1181
1182 If you want to use AIP-160, your expression must specify the field name, an
1183 operator, and the value that you want to use for filtering. The value
1184 must be a string, a number, or a boolean. The operator
1185 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1186
1187 For example, if you are filtering Compute Engine instances, you can
1188 exclude instances named `example-instance` by specifying
1189 `name != example-instance`.
1190
1191 The `:*` comparison can be used to test whether a key has been defined.
1192 For example, to find all objects with `owner` label use:
1193 ```
1194 labels.owner:*
1195 ```
1196
1197 You can also filter nested fields. For example, you could specify
1198 `scheduling.automaticRestart = false` to include instances only
1199 if they are not scheduled for automatic restarts. You can use filtering
1200 on nested fields to filter based onresource labels.
1201
1202 To filter on multiple expressions, provide each separate expression within
1203 parentheses. For example:
1204 ```
1205 (scheduling.automaticRestart = true)
1206 (cpuPlatform = &quot;Intel Skylake&quot;)
1207 ```
1208 By default, each expression is an `AND` expression. However, you
1209 can include `AND` and `OR` expressions explicitly.
1210 For example:
1211 ```
1212 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1213 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1214 (scheduling.automaticRestart = true)
1215 ```
1216
1217 If you want to use a regular expression, use the `eq` (equal) or `ne`
1218 (not equal) operator against a single un-parenthesized expression with or
1219 without quotes or against multiple parenthesized expressions. Examples:
1220
1221 `fieldname eq unquoted literal`
1222 `fieldname eq &#x27;single quoted literal&#x27;`
1223 `fieldname eq &quot;double quoted literal&quot;`
1224 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1225
1226 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1227 The literal value must match the entire field.
1228
1229 For example, to filter for instances that do not end with name &quot;instance&quot;,
1230 you would use `name ne .*instance`.
1231
1232 You cannot combine constraints on multiple fields using regular
1233 expressions.
1234 maxResults: integer, The maximum number of results per page that should be returned.
1235 If the number of available results is larger than `maxResults`,
1236 Compute Engine returns a `nextPageToken` that can be used to get
1237 the next page of results in subsequent list requests. Acceptable values are
1238 `0` to `500`, inclusive. (Default: `500`)
1239 orderBy: string, Sorts list results by a certain order. By default, results
1240 are returned in alphanumerical order based on the resource name.
1241
1242 You can also sort results in descending order based on the creation
1243 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1244 results based on the `creationTimestamp` field in
1245 reverse chronological order (newest result first). Use this to sort
1246 resources like operations so that the newest operation is returned first.
1247
1248 Currently, only sorting by `name` or
1249 `creationTimestamp desc` is supported.
1250 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1251 `nextPageToken` returned by a previous list request to get
1252 the next page of results.
1253 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1254 of failure. The default value is false.
1255
1256 For example, when partial success behavior is enabled, aggregatedList for a
1257 single zone scope either returns all resources in the zone or no resources,
1258 with an error code.
1259 x__xgafv: string, V1 error format.
1260 Allowed values
1261 1 - v1 error format
1262 2 - v2 error format
1263
1264 Returns:
1265 An object of the form:
1266
1267 { # Contains a list of SslCertificate resources.
1268 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1269 &quot;items&quot;: [ # A list of SslCertificate resources.
1270 { # Represents an SSL certificate resource.
1271 #
1272 # Google Compute Engine has two SSL certificate resources:
1273 #
1274 # * [Global](/compute/docs/reference/rest/alpha/sslCertificates)
1275 # * [Regional](/compute/docs/reference/rest/alpha/regionSslCertificates)
1276 #
1277 #
1278 # The global SSL certificates (sslCertificates) are used by:
1279 #
1280 # - Global external Application Load Balancers
1281 # - Classic Application Load Balancers
1282 # - Proxy Network Load Balancers (with target SSL proxies)
1283 #
1284 #
1285 #
1286 # The regional SSL certificates (regionSslCertificates) are used
1287 # by:
1288 #
1289 # - Regional external Application Load Balancers
1290 # - Regional internal Application Load Balancers
1291 #
1292 #
1293 #
1294 # Optionally, certificate file contents that you upload can contain a set of up
1295 # to five PEM-encoded certificates.
1296 # The API call creates an object (sslCertificate) that holds this data.
1297 # You can use SSL keys and certificates to secure connections to a load
1298 # balancer.
1299 # For more information, read
1300 # Creating and using SSL certificates,SSL certificates
1301 # quotas and limits, and
1302 # Troubleshooting SSL certificates.
1303 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must
1304 # be in PEM format. The certificate chain must be no greater than 5 certs
1305 # long. The chain must include at least one intermediate cert.
1306 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1307 # text format.
1308 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1309 # create the resource.
1310 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. [Output Only] Expire time of the certificate. RFC3339
1311 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1312 # defined by the server.
1313 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates.
1314 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
1315 &quot;domainStatus&quot;: { # Output only. [Output only] Detailed statuses of the domains specified for managed
1316 # certificate resource.
1317 &quot;a_key&quot;: &quot;A String&quot;,
1318 },
1319 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Each
1320 # Google-managed SSL certificate supports up to the [maximum number of
1321 # domains per Google-managed SSL
1322 # certificate](/load-balancing/docs/quotas#ssl_certificates).
1323 &quot;A String&quot;,
1324 ],
1325 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output only] Status of the managed certificate resource.
1326 },
1327 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1328 # The name must be 1-63 characters long, and comply withRFC1035.
1329 # Specifically, the name must be 1-63 characters long and match the regular
1330 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1331 # character must be a lowercase letter, and all following characters must
1332 # be a dash, lowercase letter, or digit, except the last character, which
1333 # cannot be a dash.
1334 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private
1335 # key file must be in PEM format. For security, only insert
1336 # requests include this field.
1337 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional SSL Certificate
1338 # resides. This field is not applicable to global SSL Certificate.
1339 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
1340 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1341 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
1342 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in
1343 # PEM format. The certificate chain must be no greater than 5 certs
1344 # long. The chain must include at least one intermediate cert.
1345 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert
1346 # requests will include this field.
1347 },
1348 &quot;subjectAlternativeNames&quot;: [ # Output only. [Output Only] Domains associated with the certificate via Subject
1349 # Alternative Name.
1350 &quot;A String&quot;,
1351 ],
1352 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or
1353 # &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fieldscertificate and private_key are used.
1354 },
1355 ],
1356 &quot;kind&quot;: &quot;compute#sslCertificateList&quot;, # Output only. Type of resource.
1357 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1358 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1359 # the query parameter pageToken in the next list request.
1360 # Subsequent list requests will have their own nextPageToken to
1361 # continue paging through the results.
1362 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1363 &quot;warning&quot;: { # [Output Only] Informational warning message.
1364 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1365 # Engine returns NO_RESULTS_ON_PAGE if there
1366 # are no results in the response.
1367 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1368 # value format. For example:
1369 #
1370 # &quot;data&quot;: [
1371 # {
1372 # &quot;key&quot;: &quot;scope&quot;,
1373 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1374 # }
1375 {
1376 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1377 # returned. For example, for warnings where there are no results in a list
1378 # request for a particular zone, this key might be scope and
1379 # the key value might be the zone name. Other examples might be a key
1380 # indicating a deprecated resource and a suggested replacement, or a
1381 # warning about invalid network settings (for example, if an instance
1382 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1383 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1384 },
1385 ],
1386 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1387 },
1388 }</pre>
1389 </div>
1390
1391 <div class="method">
1392 <code class="details" id="list_next">list_next()</code>
1393 <pre>Retrieves the next page of results.
1394
1395 Args:
1396 previous_request: The request for the previous page. (required)
1397 previous_response: The response from the request for the previous page. (required)
1398
1399 Returns:
1400 A request object that you can call &#x27;execute()&#x27; on to request the next
1401 page. Returns None if there are no more items in the collection.
1402 </pre>
1403 </div>
1404
1405 <div class="method">
1406 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
1407 <pre>Returns permissions that a caller has on the specified resource.
1408
1409 Args:
1410 project: string, Project ID for this request. (required)
1411 resource: string, Name or id of the resource for this request. (required)
1412 body: object, The request body.
1413 The object takes the form of:
1414
1415 {
1416 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1417 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1418 &quot;A String&quot;,
1419 ],
1420 }
1421
1422 x__xgafv: string, V1 error format.
1423 Allowed values
1424 1 - v1 error format
1425 2 - v2 error format
1426
1427 Returns:
1428 An object of the form:
1429
1430 {
1431 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1432 # allowed.
1433 &quot;A String&quot;,
1434 ],
1435 }</pre>
1436 </div>
1437
1438 </body></html>