Blame - docs/dyn/compute_alpha.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

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

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

89

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

Dan O'Meara

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

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

98

99

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

100

<p class="firstline">Retrieves the next page of results.</p>

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

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

[diff] [blame]

103

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

104

<h3>Method Details</h3>

105

Bu Sun Kim

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

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

108

109

Args:

110

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

Dan O'Meara

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

[diff] [blame]

111

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]

112

Dan O'Meara

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

[diff] [blame]

113

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]

114

Dan O'Meara

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

[diff] [blame]

115

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]

116

Bu Sun Kim

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

[diff] [blame]

117

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]

118

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]

119

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

120

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

121

122

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.

123

124

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

125

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

126

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

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

[diff] [blame]

127

128

Returns:

129

An object of the form:

130

131

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

132

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

133

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

134

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

135

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

136

{ # Represents an SSL Certificate resource.

137

#

138

# Google Compute Engine has two SSL Certificate resources:

139

#

140

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

#

#

#

# The sslCertificates are used by:

145

# - external HTTPS load balancers

146

# - SSL proxy load balancers

147

#

148

# The regionSslCertificates are used by internal HTTPS load balancers.

149

#

150

# 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, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

151

"certificate": "A String", # A value read into memory from a certificate file. The certificate file 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.

152

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

153

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

154

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

155

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

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

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

159

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

160

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

161

"domains": [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).

Bu Sun Kim

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

[diff] [blame]

162

"A String",

163

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

164

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

Bu Sun Kim

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

[diff] [blame]

165

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

166

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

167

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

168

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

169

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

170

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

171

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

172

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

173

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

174

},

175

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

176

"A String",

Bu Sun Kim

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

[diff] [blame]

177

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

178

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

Bu Sun Kim

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

[diff] [blame]

179

},

180

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

181

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

182

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

183

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

184

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

185

{

186

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

187

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

188

},

189

],

190

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

191

},

Bu Sun Kim

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

[diff] [blame]

192

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

193

},

194

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

195

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

196

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

197

"unreachables": [ # [Output Only] Unreachable resources.

198

"A String",

199

],

200

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

201

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

202

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

203

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

204

{

205

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

206

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

207

},

208

],

209

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

210

},

211

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

216

<pre>Retrieves the next page of results.

217

218

Args:

219

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

220

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

221

222

Returns:

Bu Sun Kim

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

[diff] [blame]

223

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]

224

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

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

229

<code class="details" id="close">close()</code>

230

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

234

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

Sai Cheemalapati

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

[diff] [blame]

235

<pre>Deletes the specified SslCertificate resource.

236

237

Args:

238

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

239

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

Bu Sun Kim

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

[diff] [blame]

240

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.

241

242

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.

243

244

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]

245

246

Returns:

247

An object of the form:

248

Bu Sun Kim

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

[diff] [blame]

249

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

250

#

251

# Google Compute Engine has three Operation resources:

252

#

253

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

254

#

255

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

256

#

257

# Operations can be global, regional or zonal.

258

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

259

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

260

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

261

#

262

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

263

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

264

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

265

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

266

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

267

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

268

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

Bu Sun Kim

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

[diff] [blame]

269

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

270

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

271

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

272

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

Bu Sun Kim

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

[diff] [blame]

273

},

274

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

275

},

276

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

277

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

278

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

279

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

280

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

281

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

282

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

283

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

284

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

285

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

286

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

287

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

{

296

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

297

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

298

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

299

{

300

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

301

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

302

},

303

],

304

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

305

},

306

],

307

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

308

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

313

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

314

315

Args:

316

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

317

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

318

319

Returns:

320

An object of the form:

321

Dan O'Meara

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

[diff] [blame]

322

{ # Represents an SSL Certificate resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

323

#

324

# Google Compute Engine has two SSL Certificate resources:

325

#

326

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

#

#

#

# The sslCertificates are used by:

331

# - external HTTPS load balancers

332

# - SSL proxy load balancers

333

#

334

# The regionSslCertificates are used by internal HTTPS load balancers.

335

#

336

# 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, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

337

"certificate": "A String", # A value read into memory from a certificate file. The certificate file 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.

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

346

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

347

"domains": [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).

Bu Sun Kim

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

[diff] [blame]

348

"A String",

349

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

350

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

351

},

352

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

353

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

354

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

355

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

356

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

357

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

358

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

359

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

360

},

361

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

362

"A String",

363

],

364

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

365

}</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]

369

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

Sai Cheemalapati

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

[diff] [blame]

370

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

371

372

Args:

373

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

Dan O'Meara

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

[diff] [blame]

374

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

375

The object takes the form of:

376

Dan O'Meara

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

[diff] [blame]

377

{ # Represents an SSL Certificate resource.

Bu Sun Kim

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

[diff] [blame]

378

#

379

# Google Compute Engine has two SSL Certificate resources:

380

#

381

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

#

#

#

# The sslCertificates are used by:

386

# - external HTTPS load balancers

387

# - SSL proxy load balancers

388

#

389

# The regionSslCertificates are used by internal HTTPS load balancers.

390

#

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

391

# 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, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

392

"certificate": "A String", # A value read into memory from a certificate file. The certificate file 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.

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

401

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

402

"domains": [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).

Bu Sun Kim

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

[diff] [blame]

403

"A String",

Bu Sun Kim

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

[diff] [blame]

404

],

Bu Sun Kim

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

[diff] [blame]

405

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

406

},

407

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

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

408

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

Bu Sun Kim

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

[diff] [blame]

409

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

410

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

411

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

412

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

413

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

414

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

415

},

416

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

417

"A String",

418

],

419

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

420

}

Sai Cheemalapati

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

[diff] [blame]

421

Bu Sun Kim

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

[diff] [blame]

422

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.

423

424

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.

425

426

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]

427

428

Returns:

429

An object of the form:

430

Bu Sun Kim

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

[diff] [blame]

431

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

432

#

433

# Google Compute Engine has three Operation resources:

434

#

435

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

436

#

437

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

438

#

439

# Operations can be global, regional or zonal.

440

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

441

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

442

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

443

#

444

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

445

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

446

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

447

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

448

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

449

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

450

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

Bu Sun Kim

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

[diff] [blame]

451

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

452

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

453

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

454

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

Bu Sun Kim

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

[diff] [blame]

455

},

456

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

457

},

458

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

459

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

460

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

461

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

462

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

463

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

464

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

465

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

466

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

467

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

468

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

469

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

{

478

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

479

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

480

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

481

{

482

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

483

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

484

},

485

],

486

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

487

},

488

],

489

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

490

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

494

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

Sai Cheemalapati

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

[diff] [blame]

495

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

496

497

Args:

498

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

Dan O'Meara

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

[diff] [blame]

499

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]

500

Dan O'Meara

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

[diff] [blame]

501

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]

502

Dan O'Meara

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

[diff] [blame]

503

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]

504

Bu Sun Kim

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

[diff] [blame]

505

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

506

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

507

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

508

509

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.

510

511

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

512

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

513

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

514

515

Returns:

516

An object of the form:

517

518

{ # Contains a list of SslCertificate resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

519

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

520

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

521

{ # Represents an SSL Certificate resource.

522

#

523

# Google Compute Engine has two SSL Certificate resources:

524

#

525

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

#

#

#

# The sslCertificates are used by:

530

# - external HTTPS load balancers

531

# - SSL proxy load balancers

532

#

533

# The regionSslCertificates are used by internal HTTPS load balancers.

534

#

535

# 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, SSL certificates quotas and limits, and Troubleshooting SSL certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)

536

"certificate": "A String", # A value read into memory from a certificate file. The certificate file 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

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

538

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

539

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

540

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

541

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

542

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

543

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

544

"a_key": "A String",

Sai Cheemalapati

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

[diff] [blame]

545

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

546

"domains": [ # The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).

Bu Sun Kim

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

[diff] [blame]

547

"A String",

548

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

549

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

550

},

551

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

552

"privateKey": "A String", # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

553

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

554

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

555

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

556

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

557

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

558

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

559

},

560

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

561

"A String",

562

],

563

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

564

},

565

],

566

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

567

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

568

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

569

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

570

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

571

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

572

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

573

{

574

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

575

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

Bu Sun Kim

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

[diff] [blame]

576

},

Sai Cheemalapati