blob: 719d1d14a37db9b61ec16f35fe5a5bcf0ccc56c1 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionSslCertificates.html">regionSslCertificates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, region, sslCertificate, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified SslCertificate resource in the region.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, region, sslCertificate)</a></code></p>
82<p class="firstline">Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Creates a SslCertificate resource in the specified project and region using the data included in the request</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Retrieves the list of SslCertificate resources available to the specified project in the specified region.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Returns permissions that a caller has on the specified resource and region.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(project, region, sslCertificate, requestId=None)</code>
98 <pre>Deletes the specified SslCertificate resource in the region.
99
100Args:
101 project: string, Project ID for this request. (required)
102 region: string, Name of the region scoping this request. (required)
103 sslCertificate: string, Name of the SslCertificate resource to delete. (required)
104 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.
105
106For 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.
107
108The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
109
110Returns:
111 An object of the form:
112
113 { # Represents an Operation resource.
114 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 # Google Compute Engine has three Operation resources:
116 #
117 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
118 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
120 #
121 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700122 # - For global operations, use the `globalOperations` resource.
123 # - For regional operations, use the `regionOperations` resource.
124 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700126 # 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 -0700127 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
128 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
129 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
130 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
131 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
132 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
135 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
136 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700137 },
138 ],
139 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700140 &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`.
141 &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.
142 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
143 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
144 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
145 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
146 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
147 &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.
148 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
149 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
150 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
151 &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.
152 &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`.
153 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
154 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
155 &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.
156 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
157 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
158 {
159 &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.
160 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
161 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
162 {
163 &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).
164 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
165 },
166 ],
167 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
168 },
169 ],
170 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="get">get(project, region, sslCertificate)</code>
176 <pre>Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.
177
178Args:
179 project: string, Project ID for this request. (required)
180 region: string, Name of the region scoping this request. (required)
181 sslCertificate: string, Name of the SslCertificate resource to return. (required)
182
183Returns:
184 An object of the form:
185
Dan O'Mearadd494642020-05-01 07:42:23 -0700186 { # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700187 #
188 # Google Compute Engine has two SSL Certificate resources:
189 #
190 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
191 #
192 #
193 #
194 # The sslCertificates are used by:
195 # - external HTTPS load balancers
196 # - SSL proxy load balancers
197 #
198 # The regionSslCertificates are used by internal HTTPS load balancers.
199 #
200 # 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 and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
201 &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.
202 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
203 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
204 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
205 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
206 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
207 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
208 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
209 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700210 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700211 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
212 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700213 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
215 },
216 &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.
217 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
218 &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.
219 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
220 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
221 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
222 &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.
223 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
224 },
225 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
226 &quot;A String&quot;,
227 ],
228 &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.
229 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700230</div>
231
232<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700233 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700234 <pre>Creates a SslCertificate resource in the specified project and region using the data included in the request
235
236Args:
237 project: string, Project ID for this request. (required)
238 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700239 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700240 The object takes the form of:
241
Dan O'Mearadd494642020-05-01 07:42:23 -0700242{ # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700243 #
244 # Google Compute Engine has two SSL Certificate resources:
245 #
246 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
247 #
248 #
249 #
250 # The sslCertificates are used by:
251 # - external HTTPS load balancers
252 # - SSL proxy load balancers
253 #
254 # The regionSslCertificates are used by internal HTTPS load balancers.
255 #
256 # 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 and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
257 &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.
258 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
259 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
260 &quot;expireTime&quot;: &quot;A String&quot;, # [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 defined by the server.
262 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
263 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
264 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
265 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
268 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700270 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
271 },
272 &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.
273 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
274 &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.
275 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
276 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
277 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
278 &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.
279 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
280 },
281 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
282 &quot;A String&quot;,
283 ],
284 &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.
285}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700286
287 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.
288
289For 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.
290
291The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
292
293Returns:
294 An object of the form:
295
296 { # Represents an Operation resource.
297 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700298 # Google Compute Engine has three Operation resources:
299 #
300 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
301 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700302 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
303 #
304 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700305 # - For global operations, use the `globalOperations` resource.
306 # - For regional operations, use the `regionOperations` resource.
307 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700308 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700309 # 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 -0700310 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
311 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
312 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
313 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
314 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
315 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700316 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700317 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
318 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
319 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320 },
321 ],
322 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700323 &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`.
324 &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.
325 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
326 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
327 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
328 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
329 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
330 &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.
331 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
332 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
333 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
334 &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.
335 &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`.
336 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
337 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
338 &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.
339 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
340 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
341 {
342 &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.
343 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
344 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
345 {
346 &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).
347 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
348 },
349 ],
350 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
351 },
352 ],
353 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700354 }</pre>
355</div>
356
357<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700358 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700359 <pre>Retrieves the list of SslCertificate resources available to the specified project in the specified region.
360
361Args:
362 project: string, Project ID for this request. (required)
363 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700364 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 -0700365
Dan O'Mearadd494642020-05-01 07:42:23 -0700366For 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 -0700367
Dan O'Mearadd494642020-05-01 07:42:23 -0700368You 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 -0700369
Bu Sun Kim65020912020-05-20 12:08:20 -0700370To 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) ```
371 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`)
372 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
373
374You 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.
375
376Currently, only sorting by `name` or `creationTimestamp desc` is supported.
377 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.
378 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 -0700379
380Returns:
381 An object of the form:
382
383 { # Contains a list of SslCertificate resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700384 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
385 &quot;items&quot;: [ # A list of SslCertificate resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700386 { # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700387 #
388 # Google Compute Engine has two SSL Certificate resources:
389 #
390 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
391 #
392 #
393 #
394 # The sslCertificates are used by:
395 # - external HTTPS load balancers
396 # - SSL proxy load balancers
397 #
398 # The regionSslCertificates are used by internal HTTPS load balancers.
399 #
400 # 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 and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)
401 &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.
402 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
403 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
404 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
405 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
406 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
407 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
408 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
409 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700410 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700411 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
412 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700413 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700414 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700415 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700416 &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.
417 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
418 &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.
419 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
420 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
421 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
422 &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.
423 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
424 },
425 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
426 &quot;A String&quot;,
427 ],
428 &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.
429 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700430 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700431 &quot;kind&quot;: &quot;compute#sslCertificateList&quot;, # Type of resource.
432 &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.
433 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
434 &quot;warning&quot;: { # [Output Only] Informational warning message.
435 &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.
436 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
437 # &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 -0700438 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700439 &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).
440 &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 -0700441 },
442 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700443 &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 -0700444 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700445 }</pre>
446</div>
447
448<div class="method">
449 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
450 <pre>Retrieves the next page of results.
451
452Args:
453 previous_request: The request for the previous page. (required)
454 previous_response: The response from the request for the previous page. (required)
455
456Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700457 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 page. Returns None if there are no more items in the collection.
459 </pre>
460</div>
461
462<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700463 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700464 <pre>Returns permissions that a caller has on the specified resource and region.
465
466Args:
467 project: string, Project ID for this request. (required)
468 region: string, The name of the region for this request. (required)
469 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700470 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700471 The object takes the form of:
472
473{
Bu Sun Kim65020912020-05-20 12:08:20 -0700474 &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.
475 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700476 ],
477 }
478
479
480Returns:
481 An object of the form:
482
483 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700484 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
485 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700486 ],
487 }</pre>
488</div>
489
490</body></html>