blob: 0fb4269d8be8d532fbbda798f7a0fbb6dfb4262b [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087 <code><a href="#delete">delete(project, sslCertificate, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070088<p class="firstline">Deletes the specified SslCertificate resource.</p>
89<p class="toc_element">
90 <code><a href="#get">get(project, sslCertificate)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070094<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>
95<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070097<p class="firstline">Retrieves the list of SslCertificate resources available to the specified project.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107 <pre>Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
108
109Args:
110 project: string, Name of the project scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112
Dan O'Mearadd494642020-05-01 07:42:23 -0700113For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114
Dan O'Mearadd494642020-05-01 07:42:23 -0700115You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116
Bu Sun Kim65020912020-05-20 12:08:20 -0700117To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700118 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
122You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
123
124Currently, only sorting by `name` or `creationTimestamp desc` is supported.
125 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700126 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127
128Returns:
129 An object of the form:
130
131 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
133 &quot;items&quot;: { # A list of SslCertificatesScopedList resources.
134 &quot;a_key&quot;: { # Name of the scope containing this set of SslCertificates.
135 &quot;sslCertificates&quot;: [ # List of SslCertificates contained in this scope.
136 { # Represents an SSL Certificate resource.
137 #
138 # Google Compute Engine has two SSL Certificate resources:
139 #
140 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
141 #
142 #
143 #
144 # The sslCertificates are used by:
145 # - external HTTPS load balancers
146 # - SSL proxy load balancers
147 #
148 # The regionSslCertificates are used by internal HTTPS load balancers.
149 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700150 # Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700151 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700152 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
153 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
154 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
155 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
156 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
157 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
158 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
159 &quot;a_key&quot;: &quot;A String&quot;,
160 },
161 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
162 &quot;A String&quot;,
163 ],
164 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
165 },
166 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700167 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700168 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
169 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
170 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
171 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
172 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
173 },
174 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
175 &quot;A String&quot;,
176 ],
177 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
178 },
179 ],
180 &quot;warning&quot;: { # Informational warning which replaces the list of backend services when the list is empty.
181 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
182 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
183 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700184 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
186 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187 },
188 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700190 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700191 },
192 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 &quot;kind&quot;: &quot;compute#sslCertificateAggregatedList&quot;, # [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.
194 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
195 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700196 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
197 &quot;A String&quot;,
198 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700199 &quot;warning&quot;: { # [Output Only] Informational warning message.
200 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
201 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
202 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700203 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
205 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700206 },
207 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700208 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700209 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
215 <pre>Retrieves the next page of results.
216
217Args:
218 previous_request: The request for the previous page. (required)
219 previous_response: The response from the request for the previous page. (required)
220
221Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700222 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700223 page. Returns None if there are no more items in the collection.
224 </pre>
225</div>
226
227<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700228 <code class="details" id="close">close()</code>
229 <pre>Close httplib2 connections.</pre>
230</div>
231
232<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700233 <code class="details" id="delete">delete(project, sslCertificate, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700234 <pre>Deletes the specified SslCertificate resource.
235
236Args:
237 project: string, Project ID for this request. (required)
238 sslCertificate: string, Name of the SslCertificate resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700239 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
240
241For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
242
243The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700244
245Returns:
246 An object of the form:
247
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248 { # Represents an Operation resource.
249 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700250 # Google Compute Engine has three Operation resources:
251 #
252 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
253 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
255 #
256 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700257 # - For global operations, use the `globalOperations` resource.
258 # - For regional operations, use the `regionOperations` resource.
259 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700260 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700261 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700262 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
263 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
264 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
265 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
266 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
267 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700268 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700269 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
270 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
271 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700272 },
273 ],
274 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700275 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
276 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
277 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
278 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
279 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
280 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
281 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
282 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
283 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
284 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
285 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
286 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
287 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
288 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
289 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
290 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
291 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
292 {
293 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
294 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
295 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
296 {
297 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
298 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
299 },
300 ],
301 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
302 },
303 ],
304 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700305 }</pre>
306</div>
307
308<div class="method">
309 <code class="details" id="get">get(project, sslCertificate)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700310 <pre>Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700311
312Args:
313 project: string, Project ID for this request. (required)
314 sslCertificate: string, Name of the SslCertificate resource to return. (required)
315
316Returns:
317 An object of the form:
318
Dan O'Mearadd494642020-05-01 07:42:23 -0700319 { # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700320 #
321 # Google Compute Engine has two SSL Certificate resources:
322 #
323 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
324 #
325 #
326 #
327 # The sslCertificates are used by:
328 # - external HTTPS load balancers
329 # - SSL proxy load balancers
330 #
331 # The regionSslCertificates are used by internal HTTPS load balancers.
332 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700333 # Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700334 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700335 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
336 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
337 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
338 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
339 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
340 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
341 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
342 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700343 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700344 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
345 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700346 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700347 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
348 },
349 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700350 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700351 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
352 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
353 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
354 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
355 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
356 },
357 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
358 &quot;A String&quot;,
359 ],
360 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
361 }</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700362</div>
363
364<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700365 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700366 <pre>Creates a SslCertificate resource in the specified project using the data included in the request.
367
368Args:
369 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700370 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700371 The object takes the form of:
372
Dan O'Mearadd494642020-05-01 07:42:23 -0700373{ # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700374 #
375 # Google Compute Engine has two SSL Certificate resources:
376 #
377 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
378 #
379 #
380 #
381 # The sslCertificates are used by:
382 # - external HTTPS load balancers
383 # - SSL proxy load balancers
384 #
385 # The regionSslCertificates are used by internal HTTPS load balancers.
386 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700387 # Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700388 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700389 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
390 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
391 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
392 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
393 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
394 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
395 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
396 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700397 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700398 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
399 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700401 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
402 },
403 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700404 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700405 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
406 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
407 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
408 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
409 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
410 },
411 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
412 &quot;A String&quot;,
413 ],
414 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
415}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700416
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700417 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
418
419For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
420
421The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700422
423Returns:
424 An object of the form:
425
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700426 { # Represents an Operation resource.
427 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700428 # Google Compute Engine has three Operation resources:
429 #
430 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
431 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700432 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
433 #
434 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700435 # - For global operations, use the `globalOperations` resource.
436 # - For regional operations, use the `regionOperations` resource.
437 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700438 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700439 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700440 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
441 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
442 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
443 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
444 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
445 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700446 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700447 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
448 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
449 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700450 },
451 ],
452 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700453 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
454 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
455 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
456 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
457 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
458 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
459 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
460 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
461 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
462 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
463 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
464 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
465 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
466 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
467 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
468 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
469 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
470 {
471 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
472 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
473 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
474 {
475 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
476 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
477 },
478 ],
479 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
480 },
481 ],
482 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700483 }</pre>
484</div>
485
486<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700487 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700488 <pre>Retrieves the list of SslCertificate resources available to the specified project.
489
490Args:
491 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700492 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700493
Dan O'Mearadd494642020-05-01 07:42:23 -0700494For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700495
Dan O'Mearadd494642020-05-01 07:42:23 -0700496You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700497
Bu Sun Kim65020912020-05-20 12:08:20 -0700498To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
499 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
500 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
501
502You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
503
504Currently, only sorting by `name` or `creationTimestamp desc` is supported.
505 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700506 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700507
508Returns:
509 An object of the form:
510
511 { # Contains a list of SslCertificate resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700512 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
513 &quot;items&quot;: [ # A list of SslCertificate resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700514 { # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700515 #
516 # Google Compute Engine has two SSL Certificate resources:
517 #
518 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
519 #
520 #
521 #
522 # The sslCertificates are used by:
523 # - external HTTPS load balancers
524 # - SSL proxy load balancers
525 #
526 # The regionSslCertificates are used by internal HTTPS load balancers.
527 #
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700528 # Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700529 &quot;certificate&quot;: &quot;A String&quot;, # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
Bu Sun Kim65020912020-05-20 12:08:20 -0700530 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
531 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
532 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
533 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
534 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
535 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
536 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
537 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700538 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700539 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
540 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700541 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700542 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700543 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700544 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700545 &quot;privateKey&quot;: &quot;A String&quot;, # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700546 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
547 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
548 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
549 &quot;certificate&quot;: &quot;A String&quot;, # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
550 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
551 },
552 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
553 &quot;A String&quot;,
554 ],
555 &quot;type&quot;: &quot;A String&quot;, # (Optional) Specifies the type of SSL certificate, either &quot;SELF_MANAGED&quot; or &quot;MANAGED&quot;. If not specified, the certificate is self-managed and the fields certificate and private_key are used.
556 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700557 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700558 &quot;kind&quot;: &quot;compute#sslCertificateList&quot;, # Type of resource.
559 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
560 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
561 &quot;warning&quot;: { # [Output Only] Informational warning message.
562 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
563 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
564 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700565 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700566 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
567 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700568 },
569 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700570 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700571 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700572 }</pre>
573</div>
574
575<div class="method">
576 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
577 <pre>Retrieves the next page of results.
578
579Args:
580 previous_request: The request for the previous page. (required)
581 previous_response: The response from the request for the previous page. (required)
582
583Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700584 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700585 page. Returns None if there are no more items in the collection.
586 </pre>
587</div>
588
589<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700590 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700591 <pre>Returns permissions that a caller has on the specified resource.
592
593Args:
594 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700595 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700596 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700597 The object takes the form of:
598
599{
Bu Sun Kim65020912020-05-20 12:08:20 -0700600 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
601 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700602 ],
603 }
604
605
606Returns:
607 An object of the form:
608
609 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700610 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
611 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700612 ],
613 }</pre>
614</div>
615
616</body></html>