Blame - docs/dyn/compute_alpha.targetSslProxies.html - platform/external/python/google-api-python-client

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

[diff] [blame]

108

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

Sai Cheemalapati

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

112

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

Sai Cheemalapati

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

[diff] [blame]

113

<pre>Deletes the specified TargetSslProxy resource.

114

115

Args:

116

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

117

targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

118

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.

119

120

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.

121

122

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]

123

124

Returns:

125

An object of the form:

126

Bu Sun Kim

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

[diff] [blame]

127

{ # Represents an Operation resource.

128

#

Dan O'Meara

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

[diff] [blame]

129

# Google Compute Engine has three Operation resources:

130

#

131

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

132

#

Bu Sun Kim

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

[diff] [blame]

133

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

134

#

135

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

136

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

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

#

Dan O'Meara

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

[diff] [blame]

140

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

141

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

142

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

143

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

144

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

145

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

146

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

Sai Cheemalapati

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

[diff] [blame]

147

{

Bu Sun Kim

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

[diff] [blame]

148

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

149

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

150

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

Sai Cheemalapati

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

[diff] [blame]

151

},

152

],

153

},

Bu Sun Kim

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

[diff] [blame]

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

{

173

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

174

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

175

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

176

{

177

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

178

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

179

},

180

],

181

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

182

},

183

],

184

"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, targetSslProxy)</code>

Bu Sun Kim

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

[diff] [blame]

190

<pre>Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.

Sai Cheemalapati

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

[diff] [blame]

191

192

Args:

193

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

194

targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)

195

196

Returns:

197

An object of the form:

198

Dan O'Meara

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

[diff] [blame]

199

{ # Represents a Target SSL Proxy resource.

Bu Sun Kim

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

[diff] [blame]

200

#

201

# A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)

202

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

203

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

204

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

205

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

206

"kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

207

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

208

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

209

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

210

"service": "A String", # URL to the BackendService resource.

211

"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

212

"A String",

213

],

214

"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

215

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

219

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

Sai Cheemalapati

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

[diff] [blame]

220

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

221

222

Args:

223

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

Dan O'Meara

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

[diff] [blame]

224

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

225

The object takes the form of:

226

Dan O'Meara

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

[diff] [blame]

227

{ # Represents a Target SSL Proxy resource.

Bu Sun Kim

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

[diff] [blame]

228

#

229

# A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)

230

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

231

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

232

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

233

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

234

"kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

235

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

236

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

237

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

238

"service": "A String", # URL to the BackendService resource.

239

"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

240

"A String",

241

],

242

"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

243

}

Sai Cheemalapati

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

[diff] [blame]

244

Bu Sun Kim

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

[diff] [blame]

245

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.

246

247

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.

248

249

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]

250

251

Returns:

252

An object of the form:

253

Bu Sun Kim

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

[diff] [blame]

254

{ # Represents an Operation resource.

255

#

Dan O'Meara

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

[diff] [blame]

256

# Google Compute Engine has three Operation resources:

257

#

258

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

259

#

Bu Sun Kim

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

[diff] [blame]

260

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

261

#

262

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

263

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

264

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

265

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

Bu Sun Kim

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

[diff] [blame]

266

#

Dan O'Meara

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

[diff] [blame]

267

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

268

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

269

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

270

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

271

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

272

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

273

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

Sai Cheemalapati

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

[diff] [blame]

274

{

Bu Sun Kim

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

[diff] [blame]

275

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

276

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

277

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

Sai Cheemalapati

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

[diff] [blame]

278

},

279

],

280

},

Bu Sun Kim

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

[diff] [blame]

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

{

300

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

301

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

302

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

303

{

304

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

305

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

306

},

307

],

308

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

309

},

310

],

311

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

316

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

317

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

318

319

Args:

320

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

Dan O'Meara

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

[diff] [blame]

321

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]

322

Dan O'Meara

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

[diff] [blame]

323

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]

324

Dan O'Meara

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

[diff] [blame]

325

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]

326

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

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

330

331

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.

332

333

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

334

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.

335

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

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

[diff] [blame]

336

337

Returns:

338

An object of the form:

339

340

{ # Contains a list of TargetSslProxy resources.

Bu Sun Kim

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

[diff] [blame]

341

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

342

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

Dan O'Meara

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

[diff] [blame]

343

{ # Represents a Target SSL Proxy resource.

Bu Sun Kim

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

[diff] [blame]

344

#

345

# A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)

346

"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

347

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

348

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

349

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

350

"kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

351

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

352

"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

353

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

354

"service": "A String", # URL to the BackendService resource.

355

"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

356

"A String",

357

],

358

"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

359

},

Sai Cheemalapati

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

[diff] [blame]

360

],

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

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

364

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

365

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

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

{

Bu Sun Kim

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

[diff] [blame]

369

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

370

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

371

},

372

],

Bu Sun Kim

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

[diff] [blame]

373

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

374

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

380

<pre>Retrieves the next page of results.

381

382

Args:

383

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

384

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

385

386

Returns:

Bu Sun Kim

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

[diff] [blame]

387

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

Sai Cheemalapati

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

[diff] [blame]

388

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

393

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

Sai Cheemalapati

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

[diff] [blame]

394

<pre>Changes the BackendService for TargetSslProxy.

395

396

Args:

397

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

398

targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)

Dan O'Meara

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

[diff] [blame]

399

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

400

The object takes the form of:

401

402

{

Bu Sun Kim

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

[diff] [blame]

403

"service": "A String", # The URL of the new BackendService resource for the targetSslProxy.

Sai Cheemalapati

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

[diff] [blame]

404

}

405

Bu Sun Kim

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

[diff] [blame]

406

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.

407

408

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.

409

410

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]

411

412

Returns:

413

An object of the form:

414

Bu Sun Kim

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

[diff] [blame]

415

{ # Represents an Operation resource.

416

#

Dan O'Meara

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

[diff] [blame]

417

# Google Compute Engine has three Operation resources:

418

#

419

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

420

#

Bu Sun Kim

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

[diff] [blame]

421

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

422

#

423

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

424

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

425

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

426

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

Bu Sun Kim

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

[diff] [blame]

427

#

Dan O'Meara

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

[diff] [blame]

428

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

429

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

430

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

431

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

432

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

433

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

434

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

Sai Cheemalapati

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

[diff] [blame]

435

{

Bu Sun Kim

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

[diff] [blame]

436

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

437

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

438

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

Sai Cheemalapati

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

[diff] [blame]

439

},

440

],

441

},

Bu Sun Kim

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

[diff] [blame]

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

{

461

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

462

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

463

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

464

{

465

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

466

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

467

},

468

],

469

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

470

},

471

],

472

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

}</pre>

</div>

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

478

<pre>Changes the Certificate Map for TargetSslProxy.

479

480

Args:

481

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

482

targetSslProxy: string, Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required)

483

body: object, The request body.

484

The object takes the form of:

485

486

{

487

"certificateMap": "A String", # URL of the Certificate Map to associate with this TargetSslProxy.

488

}

489

490

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.

491

492

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.

493

494

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

495

496

Returns:

497

An object of the form:

498

499

{ # Represents an Operation resource.

500

#

501

# Google Compute Engine has three Operation resources:

502

#

503

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

504

#

505

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

506

#

507

# Operations can be global, regional or zonal.

508

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

509

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

510

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

511

#

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

{

520

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

521

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

522

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

},

],

},

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

{

545

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

546

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

547

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

548

{

549

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

550

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

551

},

552

],

553

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

554

},

555

],

556

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

Dan O'Meara

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

[diff] [blame]

561

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

Sai Cheemalapati

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

[diff] [blame]

562

<pre>Changes the ProxyHeaderType for TargetSslProxy.

563

564

Args:

565

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

566

targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)

Dan O'Meara

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

[diff] [blame]

567

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

568

The object takes the form of:

569

570

{

Bu Sun Kim

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

[diff] [blame]

571

"proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.

Sai Cheemalapati

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

[diff] [blame]

572

}

573

Bu Sun Kim

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

[diff] [blame]

574

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.

575

576

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.

577

578

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]

579

580

Returns:

581

An object of the form:

582

Bu Sun Kim

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

[diff] [blame]

583

{ # Represents an Operation resource.

584

#

Dan O'Meara

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

[diff] [blame]

585

# Google Compute Engine has three Operation resources:

586

#

587

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

588

#

Bu Sun Kim

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

[diff] [blame]

589

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

590

#

591

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

592

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

593

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

594

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

Bu Sun Kim

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

[diff] [blame]

595

#

Dan O'Meara

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

[diff] [blame]

596

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

597

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

598

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

599

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

600

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

601

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

602

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

Sai Cheemalapati

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

[diff] [blame]

603

{

Bu Sun Kim

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

[diff] [blame]

604

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

605

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

606

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

Sai Cheemalapati

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

[diff] [blame]

607

},

608

],

609

},

Bu Sun Kim

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

[diff] [blame]

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

{

629

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

630

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

631

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

632

{

633

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

634

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

635

},

636

],

637

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

638

},

639

],

640

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

Dan O'Meara

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

[diff] [blame]

645

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

Sai Cheemalapati

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

[diff] [blame]

646

<pre>Changes SslCertificates for TargetSslProxy.

647

648

Args:

649

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

650

targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)

Dan O'Meara

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

[diff] [blame]

651

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

652

The object takes the form of:

653

654

{

Bu Sun Kim

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

[diff] [blame]

655

"sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.

656

"A String",

Sai Cheemalapati

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

[diff] [blame]

],

}

Bu Sun Kim

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

[diff] [blame]

660

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.

661

662

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.

663

664

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]

665

666

Returns:

667

An object of the form:

668

Bu Sun Kim

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

[diff] [blame]

669

{ # Represents an Operation resource.

670

#

Dan O'Meara

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

[diff] [blame]

671

# Google Compute Engine has three Operation resources:

672

#

673

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

674

#

Bu Sun Kim

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

[diff] [blame]

675

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

676

#

677

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

678

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

679

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

680

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

Bu Sun Kim

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

[diff] [blame]

681

#

Dan O'Meara

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

[diff] [blame]

682

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

683

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

684

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

685

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

686

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

687

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

688

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

Bu Sun Kim

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

[diff] [blame]

689

{

Bu Sun Kim

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

[diff] [blame]

690

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

691

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

692

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

Bu Sun Kim

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

[diff] [blame]

693

},

694

],

695

},

Bu Sun Kim

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

[diff] [blame]

696

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

697

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

698

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

699

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

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

{

715

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

716

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

717

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

718

{

719

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

720

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

721

},

722

],

723

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

724

},

725

],

726

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

731

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

Bu Sun Kim

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

[diff] [blame]

732

<pre>Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.

733

734

Args:

735

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

736

targetSslProxy: string, Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

737

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

738

The object takes the form of:

739

740

{

Bu Sun Kim

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

[diff] [blame]

741

"sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.

Bu Sun Kim

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

[diff] [blame]

742

}

743

744

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.

745

746

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.

747

748

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

749

750

Returns:

751

An object of the form:

752

753

{ # Represents an Operation resource.

754

#

Dan O'Meara

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

[diff] [blame]

755

# Google Compute Engine has three Operation resources:

756

#

757

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

758

#

Bu Sun Kim

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

[diff] [blame]

759

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

760

#

761

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

762

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

763

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

764

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

Bu Sun Kim

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

[diff] [blame]

765

#

Dan O'Meara

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

[diff] [blame]

766

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

767

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

768

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

769

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

770

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

771

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

772

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

Sai Cheemalapati

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

[diff] [blame]

773

{

Bu Sun Kim

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

[diff] [blame]

774

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

775

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

776

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

Sai Cheemalapati

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

[diff] [blame]

777

},

778

],

779

},

Bu Sun Kim