Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.sslCertificates.html
blob: be7d96c5cc2c798afbed27c3cf50ca656251c4b3 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<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_v1.html">Compute Engine API</a> . <a href="compute_v1.sslCertificates.html">sslCertificates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</a></code></p>
79<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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#delete">delete(project, sslCertificate, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<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 -0700[diff] [blame]88<p class="firstline">Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]94<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<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]100 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</code>
101 <pre>Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
102
103Args:
104 project: string, Name of the project scoping this request. (required)
105 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
106
107You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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.
108
109Currently, only sorting by `name` or `creationTimestamp desc` is supported.
110 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`)
111 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.
112 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;`.
113
114For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
115
116You 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.
117
118To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
119 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.
120
121Returns:
122 An object of the form:
123
124 {
125 "nextPageToken": "A String", # [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.
126 "kind": "compute#sslCertificateAggregatedList", # [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.
127 "items": { # A list of SslCertificatesScopedList resources.
128 "a_key": { # Name of the scope containing this set of SslCertificates.
129 "warning": { # Informational warning which replaces the list of backend services when the list is empty.
130 "message": "A String", # [Output Only] A human-readable description of the warning code.
131 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
132 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
133 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
134 {
135 "value": "A String", # [Output Only] A warning data value corresponding to the key.
136 "key": "A String", # [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).
137 },
138 ],
139 },
140 "sslCertificates": [ # List of SslCertificates contained in this scope.
141 { # Represents an SSL Certificate resource.
142 #
143 # Google Compute Engine has two SSL Certificate resources:
144 #
145 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
146 #
147 #
148 #
149 # The sslCertificates are used by:
150 # - external HTTPS load balancers
151 # - SSL proxy load balancers
152 #
153 # The regionSslCertificates are used by internal HTTPS load balancers.
154 #
155 # 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 ==)
156 "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
157 "managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
158 "domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
159 "A String",
160 ],
161 "status": "A String", # [Output only] Status of the managed certificate resource.
162 "domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
163 "a_key": "A String",
164 },
165 },
166 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
167 "certificate": "A String", # 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 "selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
169 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
170 "certificate": "A String", # 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.
171 },
172 "type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.
173 "region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
174 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
175 "expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339
176 "subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
177 "A String",
178 ],
179 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
180 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
181 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
182 "name": "A String", # 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.
183 },
184 ],
185 },
186 },
187 "warning": { # [Output Only] Informational warning message.
188 "message": "A String", # [Output Only] A human-readable description of the warning code.
189 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
190 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
191 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
192 {
193 "value": "A String", # [Output Only] A warning data value corresponding to the key.
194 "key": "A String", # [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).
195 },
196 ],
197 },
198 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
199 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
205 <pre>Retrieves the next page of results.
206
207Args:
208 previous_request: The request for the previous page. (required)
209 previous_response: The response from the request for the previous page. (required)
210
211Returns:
212 A request object that you can call 'execute()' on to request the next
213 page. Returns None if there are no more items in the collection.
214 </pre>
215</div>
216
217<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 <code class="details" id="delete">delete(project, sslCertificate, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]219 <pre>Deletes the specified SslCertificate resource.
220
221Args:
222 project: string, Project ID for this request. (required)
223 sslCertificate: string, Name of the SslCertificate resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 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.
225
226For 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.
227
228The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]229
230Returns:
231 An object of the form:
232
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 { # Represents an Operation resource.
234 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 # Google Compute Engine has three Operation resources:
236 #
237 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
238 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
240 #
241 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]242 # - For global operations, use the `globalOperations` resource.
243 # - For regional operations, use the `regionOperations` resource.
244 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]245 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]246 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]247 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]249 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]250 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]253 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
254 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]255 "progress": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]256 "httpErrorStatusCode": 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]257 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]259 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
260 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
261 {
262 "message": "A String", # [Output Only] A human-readable description of the warning code.
263 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
264 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
265 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
266 {
267 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]268 "key": "A String", # [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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]269 },
270 ],
271 },
272 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]273 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]275 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
276 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]278 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
279 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
280 {
281 "message": "A String", # [Output Only] An optional, human-readable error message.
282 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]283 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]284 },
285 ],
286 },
287 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
288 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]289 "targetLink": "A String", # [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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]290 }</pre>
291</div>
292
293<div class="method">
294 <code class="details" id="get">get(project, sslCertificate)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 <pre>Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]296
297Args:
298 project: string, Project ID for this request. (required)
299 sslCertificate: string, Name of the SslCertificate resource to return. (required)
300
301Returns:
302 An object of the form:
303
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 { # Represents an SSL Certificate resource.
305 #
306 # Google Compute Engine has two SSL Certificate resources:
307 #
308 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
309 #
310 #
311 #
312 # The sslCertificates are used by:
313 # - external HTTPS load balancers
314 # - SSL proxy load balancers
315 #
316 # The regionSslCertificates are used by internal HTTPS load balancers.
317 #
318 # 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 ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]319 "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320 "managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
321 "domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
322 "A String",
323 ],
324 "status": "A String", # [Output only] Status of the managed certificate resource.
325 "domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
326 "a_key": "A String",
327 },
328 },
329 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]330 "certificate": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]331 "selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
332 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
333 "certificate": "A String", # 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.
334 },
335 "type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.
336 "region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]337 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]338 "expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339
339 "subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
340 "A String",
341 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]342 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
343 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
344 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]345 "name": "A String", # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]346 }</pre>
347</div>
348
349<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]350 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]351 <pre>Creates a SslCertificate resource in the specified project using the data included in the request.
352
353Args:
354 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 The object takes the form of:
357
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358{ # Represents an SSL Certificate resource.
359 #
360 # Google Compute Engine has two SSL Certificate resources:
361 #
362 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
363 #
364 #
365 #
366 # The sslCertificates are used by:
367 # - external HTTPS load balancers
368 # - SSL proxy load balancers
369 #
370 # The regionSslCertificates are used by internal HTTPS load balancers.
371 #
372 # 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 ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]373 "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 "managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
375 "domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
376 "A String",
377 ],
378 "status": "A String", # [Output only] Status of the managed certificate resource.
379 "domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
380 "a_key": "A String",
381 },
382 },
383 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]384 "certificate": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]385 "selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
386 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
387 "certificate": "A String", # 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.
388 },
389 "type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.
390 "region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]391 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]392 "expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339
393 "subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
394 "A String",
395 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]396 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
397 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
398 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]399 "name": "A String", # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]400 }
401
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 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.
403
404For 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.
405
406The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]407
408Returns:
409 An object of the form:
410
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 { # Represents an Operation resource.
412 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]413 # Google Compute Engine has three Operation resources:
414 #
415 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
416 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
418 #
419 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]420 # - For global operations, use the `globalOperations` resource.
421 # - For regional operations, use the `regionOperations` resource.
422 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]424 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]425 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]427 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]428 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]429 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]430 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
432 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]433 "progress": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 "httpErrorStatusCode": 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]435 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]437 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
438 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
439 {
440 "message": "A String", # [Output Only] A human-readable description of the warning code.
441 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
442 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
443 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
444 {
445 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]446 "key": "A String", # [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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]447 },
448 ],
449 },
450 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]451 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]452 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
454 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]455 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]456 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
457 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
458 {
459 "message": "A String", # [Output Only] An optional, human-readable error message.
460 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]461 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]462 },
463 ],
464 },
465 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
466 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]467 "targetLink": "A String", # [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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]468 }</pre>
469</div>
470
471<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]472 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]473 <pre>Retrieves the list of SslCertificate resources available to the specified project.
474
475Args:
476 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]477 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
478
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]479You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]480
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]481Currently, only sorting by `name` or `creationTimestamp desc` is supported.
482 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`)
483 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.
484 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;`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]485
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]486For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]487
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]488You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]489
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]490To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]491
492Returns:
493 An object of the form:
494
495 { # Contains a list of SslCertificate resources.
496 "nextPageToken": "A String", # [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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497 "kind": "compute#sslCertificateList", # Type of resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]498 "items": [ # A list of SslCertificate resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]499 { # Represents an SSL Certificate resource.
500 #
501 # Google Compute Engine has two SSL Certificate resources:
502 #
503 # * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)
504 #
505 #
506 #
507 # The sslCertificates are used by:
508 # - external HTTPS load balancers
509 # - SSL proxy load balancers
510 #
511 # The regionSslCertificates are used by internal HTTPS load balancers.
512 #
513 # 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 ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]514 "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 "managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.
516 "domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.
517 "A String",
518 ],
519 "status": "A String", # [Output only] Status of the managed certificate resource.
520 "domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.
521 "a_key": "A String",
522 },
523 },
524 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]525 "certificate": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]526 "selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.
527 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
528 "certificate": "A String", # 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.
529 },
530 "type": "A String", # (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used.
531 "region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]532 "privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]533 "expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339
534 "subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.
535 "A String",
536 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]537 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
538 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
539 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]540 "name": "A String", # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]541 },
542 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 "warning": { # [Output Only] Informational warning message.
544 "message": "A String", # [Output Only] A human-readable description of the warning code.
545 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
546 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
547 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
548 {
549 "value": "A String", # [Output Only] A warning data value corresponding to the key.
550 "key": "A String", # [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).
551 },
552 ],
553 },
554 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]555 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
556 }</pre>
557</div>
558
559<div class="method">
560 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
561 <pre>Retrieves the next page of results.
562
563Args:
564 previous_request: The request for the previous page. (required)
565 previous_response: The response from the request for the previous page. (required)
566
567Returns:
568 A request object that you can call 'execute()' on to request the next
569 page. Returns None if there are no more items in the collection.
570 </pre>
571</div>
572
573</body></html>