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