Debian Codegraph @

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