blob: 2bf76af1e2c4a3eb5fb8895d82930788a8e6c583 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -070078 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=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">
84 <code><a href="#delete">delete(project, sslCertificate, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070085<p class="firstline">Deletes the specified SslCertificate resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, sslCertificate)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<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 -070089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070091<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070093 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070094<p class="firstline">Retrieves the list of SslCertificate resources available to the specified project.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700103 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104 <pre>Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
105
106Args:
107 project: string, Name of the project scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 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 -0700109
Dan O'Mearadd494642020-05-01 07:42:23 -0700110For 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 -0700111
Dan O'Mearadd494642020-05-01 07:42:23 -0700112You 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 -0700113
Bu Sun Kim65020912020-05-20 12:08:20 -0700114To 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 -0700115 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 -0700116 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`)
117 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
118
119You 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.
120
121Currently, only sorting by `name` or `creationTimestamp desc` is supported.
122 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700123
124Returns:
125 An object of the form:
126
127 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700128 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
129 &quot;items&quot;: { # A list of SslCertificatesScopedList resources.
130 &quot;a_key&quot;: { # Name of the scope containing this set of SslCertificates.
131 &quot;sslCertificates&quot;: [ # List of SslCertificates contained in this scope.
132 { # Represents an SSL Certificate resource.
133 #
134 # Google Compute Engine has two SSL Certificate resources:
135 #
136 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
137 #
138 #
139 #
140 # The sslCertificates are used by:
141 # - external HTTPS load balancers
142 # - SSL proxy load balancers
143 #
144 # The regionSslCertificates are used by internal HTTPS load balancers.
145 #
146 # 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 ==)
147 &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.
148 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
149 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
150 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
151 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
152 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
153 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
154 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
155 &quot;a_key&quot;: &quot;A String&quot;,
156 },
157 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
158 &quot;A String&quot;,
159 ],
160 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
161 },
162 &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.
163 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
164 &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.
165 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
166 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
167 &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.
168 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
169 },
170 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
171 &quot;A String&quot;,
172 ],
173 &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.
174 },
175 ],
176 &quot;warning&quot;: { # Informational warning which replaces the list of backend services when the list is empty.
177 &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.
178 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
179 # &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 -0700180 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700181 &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).
182 &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 -0700183 },
184 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 &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 -0700186 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187 },
188 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 &quot;kind&quot;: &quot;compute#sslCertificateAggregatedList&quot;, # [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.
190 &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.
191 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
192 &quot;warning&quot;: { # [Output Only] Informational warning message.
193 &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.
194 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
195 # &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 -0700196 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 &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).
198 &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 -0700199 },
200 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700201 &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 -0700202 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700203 }</pre>
204</div>
205
206<div class="method">
207 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
208 <pre>Retrieves the next page of results.
209
210Args:
211 previous_request: The request for the previous page. (required)
212 previous_response: The response from the request for the previous page. (required)
213
214Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700216 page. Returns None if there are no more items in the collection.
217 </pre>
218</div>
219
220<div class="method">
221 <code class="details" id="delete">delete(project, sslCertificate, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700222 <pre>Deletes the specified SslCertificate resource.
223
224Args:
225 project: string, Project ID for this request. (required)
226 sslCertificate: string, Name of the SslCertificate resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227 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.
228
229For 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.
230
231The 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 -0700232
233Returns:
234 An object of the form:
235
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700236 { # Represents an Operation resource.
237 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700238 # Google Compute Engine has three Operation resources:
239 #
240 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
241 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
243 #
244 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700245 # - For global operations, use the `globalOperations` resource.
246 # - For regional operations, use the `regionOperations` resource.
247 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700249 # 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 -0700250 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
251 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
252 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
253 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
254 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
255 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700256 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700257 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
258 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
259 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700260 },
261 ],
262 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 &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`.
264 &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.
265 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
266 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
267 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
268 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
269 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
270 &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.
271 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
272 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
273 &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.
274 &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`.
275 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
276 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
277 &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.
278 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
279 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
280 {
281 &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.
282 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
283 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
284 {
285 &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).
286 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
287 },
288 ],
289 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
290 },
291 ],
292 &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 -0700293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="get">get(project, sslCertificate)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700298 <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 -0700299
300Args:
301 project: string, Project ID for this request. (required)
302 sslCertificate: string, Name of the SslCertificate resource to return. (required)
303
304Returns:
305 An object of the form:
306
Dan O'Mearadd494642020-05-01 07:42:23 -0700307 { # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700308 #
309 # Google Compute Engine has two SSL Certificate resources:
310 #
311 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
312 #
313 #
314 #
315 # The sslCertificates are used by:
316 # - external HTTPS load balancers
317 # - SSL proxy load balancers
318 #
319 # The regionSslCertificates are used by internal HTTPS load balancers.
320 #
321 # 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 ==)
322 &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.
323 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
324 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
325 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
326 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
327 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
328 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
329 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
330 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700331 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700332 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
333 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700334 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700335 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
336 },
337 &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.
338 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
339 &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.
340 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
341 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
342 &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.
343 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
344 },
345 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
346 &quot;A String&quot;,
347 ],
348 &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.
349 }</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700350</div>
351
352<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700353 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700354 <pre>Creates a SslCertificate resource in the specified project using the data included in the request.
355
356Args:
357 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700358 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700359 The object takes the form of:
360
Dan O'Mearadd494642020-05-01 07:42:23 -0700361{ # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700362 #
363 # Google Compute Engine has two SSL Certificate resources:
364 #
365 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
366 #
367 #
368 #
369 # The sslCertificates are used by:
370 # - external HTTPS load balancers
371 # - SSL proxy load balancers
372 #
373 # The regionSslCertificates are used by internal HTTPS load balancers.
374 #
375 # 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 ==)
376 &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.
377 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
378 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
379 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
380 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
381 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
382 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
383 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
384 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700385 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700386 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
387 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700388 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700389 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
390 },
391 &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.
392 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
393 &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.
394 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
395 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
396 &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.
397 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
398 },
399 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
400 &quot;A String&quot;,
401 ],
402 &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.
403}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700404
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700405 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.
406
407For 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.
408
409The 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 -0700410
411Returns:
412 An object of the form:
413
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700414 { # Represents an Operation resource.
415 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700416 # Google Compute Engine has three Operation resources:
417 #
418 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
419 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700420 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
421 #
422 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700423 # - For global operations, use the `globalOperations` resource.
424 # - For regional operations, use the `regionOperations` resource.
425 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700426 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700427 # 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 -0700428 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
429 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
430 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
431 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
432 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
433 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700434 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700435 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
436 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
437 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700438 },
439 ],
440 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700441 &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`.
442 &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.
443 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
444 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
445 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
446 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
447 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
448 &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.
449 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
450 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
451 &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.
452 &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`.
453 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
454 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
455 &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.
456 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
457 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
458 {
459 &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.
460 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
461 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
462 {
463 &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).
464 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
465 },
466 ],
467 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
468 },
469 ],
470 &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 -0700471 }</pre>
472</div>
473
474<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700475 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700476 <pre>Retrieves the list of SslCertificate resources available to the specified project.
477
478Args:
479 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700480 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 -0700481
Dan O'Mearadd494642020-05-01 07:42:23 -0700482For 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 -0700483
Dan O'Mearadd494642020-05-01 07:42:23 -0700484You 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 -0700485
Bu Sun Kim65020912020-05-20 12:08:20 -0700486To 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) ```
487 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`)
488 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
489
490You 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.
491
492Currently, only sorting by `name` or `creationTimestamp desc` is supported.
493 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700494
495Returns:
496 An object of the form:
497
498 { # Contains a list of SslCertificate resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700499 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
500 &quot;items&quot;: [ # A list of SslCertificate resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700501 { # Represents an SSL Certificate resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700502 #
503 # Google Compute Engine has two SSL Certificate resources:
504 #
505 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
506 #
507 #
508 #
509 # The sslCertificates are used by:
510 # - external HTTPS load balancers
511 # - SSL proxy load balancers
512 #
513 # The regionSslCertificates are used by internal HTTPS load balancers.
514 #
515 # 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 ==)
516 &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.
517 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
518 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
519 &quot;expireTime&quot;: &quot;A String&quot;, # [Output Only] Expire time of the certificate. RFC3339
520 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
521 &quot;kind&quot;: &quot;compute#sslCertificate&quot;, # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
522 &quot;managed&quot;: { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
523 &quot;domainStatus&quot;: { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
524 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700525 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700526 &quot;domains&quot;: [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
527 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700528 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700529 &quot;status&quot;: &quot;A String&quot;, # [Output only] Status of the managed certificate resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700530 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700531 &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.
532 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
533 &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.
534 &quot;selfLink&quot;: &quot;A String&quot;, # [Output only] Server-defined URL for the resource.
535 &quot;selfManaged&quot;: { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
536 &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.
537 &quot;privateKey&quot;: &quot;A String&quot;, # A write-only private key in PEM format. Only insert requests will include this field.
538 },
539 &quot;subjectAlternativeNames&quot;: [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
540 &quot;A String&quot;,
541 ],
542 &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.
543 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700544 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700545 &quot;kind&quot;: &quot;compute#sslCertificateList&quot;, # Type of resource.
546 &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.
547 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
548 &quot;warning&quot;: { # [Output Only] Informational warning message.
549 &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.
550 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
551 # &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 -0700552 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700553 &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).
554 &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 -0700555 },
556 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700557 &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 -0700558 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700559 }</pre>
560</div>
561
562<div class="method">
563 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
564 <pre>Retrieves the next page of results.
565
566Args:
567 previous_request: The request for the previous page. (required)
568 previous_response: The response from the request for the previous page. (required)
569
570Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700571 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700572 page. Returns None if there are no more items in the collection.
573 </pre>
574</div>
575
576<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700577 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700578 <pre>Returns permissions that a caller has on the specified resource.
579
580Args:
581 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700582 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700583 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700584 The object takes the form of:
585
586{
Bu Sun Kim65020912020-05-20 12:08:20 -0700587 &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.
588 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700589 ],
590 }
591
592
593Returns:
594 An object of the form:
595
596 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700597 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
598 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700599 ],
600 }</pre>
601</div>
602
603</body></html>