Blame - docs/dyn/compute_beta.sslCertificates.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.</p>

80

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

84

<code><a href="#delete">delete(project, sslCertificate, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

85

<p class="firstline">Deletes the specified SslCertificate resource.</p>

86

87

<code><a href="#get">get(project, sslCertificate)</a></code></p>

Bu Sun Kim

2019-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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

91

<p class="firstline">Creates a SslCertificate resource in the specified project using the data included in the request.</p>

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

94

<p class="firstline">Retrieves the list of SslCertificate resources available to the specified project.</p>

95

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

100

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

101

<h3>Method Details</h3>

102

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

103

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

<pre>Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.

105

106

Args:

107

project: string, Name of the project scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

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 `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

111

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

To 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) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

115

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

117

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

118

119

You 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.

120

121

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

122

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

123

124

Returns:

125

An object of the form:

126

127

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

128

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

129

"items": { # A list of SslCertificatesScopedList resources.

130

"a_key": { # Name of the scope containing this set of SslCertificates.

131

"sslCertificates": [ # List of SslCertificates contained in this scope.

132

{ # Represents an SSL Certificate resource.

133

#

134

# Google Compute Engine has two SSL Certificate resources:

135

#

136

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

141

# - external HTTPS load balancers

142

# - SSL proxy load balancers

143

#

144

# The regionSslCertificates are used by internal HTTPS load balancers.

145

#

146

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

147

"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.

148

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

149

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

150

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

151

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

152

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

153

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

154

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

155

"a_key": "A String",

156

},

157

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

158

"A String",

159

],

160

"status": "A String", # [Output only] Status of the managed certificate resource.

161

},

162

"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.

163

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

164

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

165

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

166

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

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

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

169

},

170

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

171

"A String",

172

],

173

"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.

174

},

175

],

176

"warning": { # Informational warning which replaces the list of backend services when the list is empty.

177

"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.

178

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

179

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

180

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

181

"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).

182

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

183

},

184

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

185

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

186

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

187

},

188

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

189

"kind": "compute#sslCertificateAggregatedList", # [Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.

190

"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.

191

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

192

"warning": { # [Output Only] Informational warning message.

193

"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.

194

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

195

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

196

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

197

"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).

198

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

199

},

200

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

201

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

202

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

208

<pre>Retrieves the next page of results.

209

210

Args:

211

previous_request: The request for the previous page. (required)

212

previous_response: The response from the request for the previous page. (required)

213

214

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

215

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

216

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="delete">delete(project, sslCertificate, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

222

<pre>Deletes the specified SslCertificate resource.

223

224

Args:

225

project: string, Project ID for this request. (required)

226

sslCertificate: string, Name of the SslCertificate resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

227

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

228

229

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

230

231

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

232

233

Returns:

234

An object of the form:

235

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

236

{ # Represents an Operation resource.

237

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

238

# Google Compute Engine has three Operation resources:

239

#

240

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

241

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

242

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

243

#

244

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

245

# - For global operations, use the `globalOperations` resource.

246

# - For regional operations, use the `regionOperations` resource.

247

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

248

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

249

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

250

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

251

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

252

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

253

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

254

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

255

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

256

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

257

"code": "A String", # [Output Only] The error type identifier for this error.

258

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

259

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

260

},

261

],

262

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

263

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

264

"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.

265

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

266

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

267

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

268

"name": "A String", # [Output Only] Name of the operation.

269

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

270

"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.

271

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

272

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

273

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

274

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

275

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

276

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

277

"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.

278

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

279

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

280

{

281

"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.

282

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

283

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

284

{

285

"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).

286

"value": "A String", # [Output Only] A warning data value corresponding to the key.

287

},

288

],

289

"message": "A String", # [Output Only] A human-readable description of the warning code.

290

},

291

],

292

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, sslCertificate)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

298

<pre>Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

299

300

Args:

301

project: string, Project ID for this request. (required)

302

sslCertificate: string, Name of the SslCertificate resource to return. (required)

303

304

Returns:

305

An object of the form:

306

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

307

{ # Represents an SSL Certificate resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

#

309

# Google Compute Engine has two SSL Certificate resources:

310

#

311

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

316

# - external HTTPS load balancers

317

# - SSL proxy load balancers

318

#

319

# The regionSslCertificates are used by internal HTTPS load balancers.

320

#

321

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

322

"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.

323

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

324

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

325

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

326

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

327

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

328

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

329

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

330

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

331

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

333

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

334

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

335

"status": "A String", # [Output only] Status of the managed certificate resource.

336

},

337

"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.

338

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

339

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

340

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

341

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

342

"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.

343

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

344

},

345

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

346

"A String",

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

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

353

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

354

<pre>Creates a SslCertificate resource in the specified project using the data included in the request.

355

356

Args:

357

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

358

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

359

The object takes the form of:

360

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

361

{ # Represents an SSL Certificate resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

362

#

363

# Google Compute Engine has two SSL Certificate resources:

364

#

365

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

370

# - external HTTPS load balancers

371

# - SSL proxy load balancers

372

#

373

# The regionSslCertificates are used by internal HTTPS load balancers.

374

#

375

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

376

"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.

377

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

378

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

379

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

380

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

381

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

382

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

383

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

384

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

385

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

386

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

387

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

388

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

389

"status": "A String", # [Output only] Status of the managed certificate resource.

390

},

391

"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.

392

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

393

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

394

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

395

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

396

"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.

397

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

398

},

399

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

400

"A String",

401

],

402

"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.

403

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

404

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

405

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

406

407

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

408

409

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

410

411

Returns:

412

An object of the form:

413

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

414

{ # Represents an Operation resource.

415

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

416

# Google Compute Engine has three Operation resources:

417

#

418

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

419

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

420

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

421

#

422

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

423

# - For global operations, use the `globalOperations` resource.

424

# - For regional operations, use the `regionOperations` resource.

425

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

426

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

427

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

428

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

429

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

430

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

431

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

432

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

433

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

434

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

435

"code": "A String", # [Output Only] The error type identifier for this error.

436

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

437

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

438

},

439

],

440

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

441

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

442

"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.

443

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

444

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

445

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

446

"name": "A String", # [Output Only] Name of the operation.

447

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

448

"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.

449

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

450

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

451

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

452

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

453

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

454

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

455

"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.

456

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

457

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

458

{

459

"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.

460

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

461

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

462

{

463

"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).

464

"value": "A String", # [Output Only] A warning data value corresponding to the key.

465

},

466

],

467

"message": "A String", # [Output Only] A human-readable description of the warning code.

468

},

469

],

470

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

476

<pre>Retrieves the list of SslCertificate resources available to the specified project.

477

478

Args:

479

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

480

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 `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

481

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

482

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

483

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

484

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

485

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

486

To 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) ```

487

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

488

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

489

490

You 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.

491

492

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

493

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

494

495

Returns:

496

An object of the form:

497

498

{ # Contains a list of SslCertificate resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

499

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

500

"items": [ # A list of SslCertificate resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

501

{ # Represents an SSL Certificate resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

#

503

# Google Compute Engine has two SSL Certificate resources:

504

#

505

# * [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)

#

#

#

# The sslCertificates are used by:

510

# - external HTTPS load balancers

511

# - SSL proxy load balancers

512

#

513

# The regionSslCertificates are used by internal HTTPS load balancers.

514

#

515

# Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

516

"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.

517

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

518

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

519

"expireTime": "A String", # [Output Only] Expire time of the certificate. RFC3339

520

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

521

"kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

522

"managed": { # Configuration and status of a managed SSL certificate. # Configuration and status of a managed SSL certificate.

523

"domainStatus": { # [Output only] Detailed statuses of the domains specified for managed certificate resource.

524

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

525

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

526

"domains": [ # The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.

527

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

528

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

529

"status": "A String", # [Output only] Status of the managed certificate resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

530

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

531

"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.

532

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

533

"region": "A String", # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

534

"selfLink": "A String", # [Output only] Server-defined URL for the resource.

535

"selfManaged": { # Configuration and status of a self-managed SSL certificate. # Configuration and status of a self-managed SSL certificate.

536

"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.

537

"privateKey": "A String", # A write-only private key in PEM format. Only insert requests will include this field.

538

},

539

"subjectAlternativeNames": [ # [Output Only] Domains associated with the certificate via Subject Alternative Name.

540

"A String",

541

],

542

"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.

543

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

544

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

545

"kind": "compute#sslCertificateList", # Type of resource.

546

"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.

547

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

548

"warning": { # [Output Only] Informational warning message.

549

"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.

550

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

551

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

552

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

553

"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).

554

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

555

},

556

],

Bu Sun Kim