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

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

<h3>Method Details</h3>

114

Dmitry Frenkel

3e17f89

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

[diff] [blame]

115

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

116

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

<pre>Deletes the specified TargetSslProxy resource.

122

123

Args:

124

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

125

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

Bu Sun Kim

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

[diff] [blame]

126

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.

127

128

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.

129

130

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]

131

132

Returns:

133

An object of the form:

134

Bu Sun Kim

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

[diff] [blame]

135

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

136

#

137

# Google Compute Engine has three Operation resources:

138

#

139

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

140

#

141

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

142

#

143

# Operations can be global, regional or zonal.

144

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

145

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

146

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

147

#

148

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

149

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

150

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

151

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

152

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

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

{

Yoshi Automation Bot

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

[diff] [blame]

156

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

157

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

158

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

Bu Sun Kim

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

[diff] [blame]

159

},

160

],

Yoshi Automation Bot

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

[diff] [blame]

161

},

162

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

163

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

164

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

165

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

166

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

167

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

yoshi-code-bot

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

[diff] [blame]

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

{

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

},

192

],

193

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

194

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

199

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

200

201

Args:

202

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

203

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

204

205

Returns:

206

An object of the form:

207

Dan O'Meara

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

[diff] [blame]

208

{ # Represents a Target SSL Proxy resource.

Yoshi Automation Bot

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

[diff] [blame]

209

#

210

# 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 ==)

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

220

"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. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

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

[diff] [blame]

221

"A String",

222

],

223

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

224

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

228

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

Sai Cheemalapati

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

[diff] [blame]

229

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

230

231

Args:

232

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

Dan O'Meara

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

[diff] [blame]

233

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

234

The object takes the form of:

235

Dan O'Meara

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

[diff] [blame]

236

{ # Represents a Target SSL Proxy resource.

Bu Sun Kim

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

[diff] [blame]

237

#

238

# 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 ==)

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

248

"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. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

249

"A String",

250

],

251

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

252

}

Sai Cheemalapati

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

[diff] [blame]

253

Bu Sun Kim

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

[diff] [blame]

254

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.

255

256

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.

257

258

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]

259

260

Returns:

261

An object of the form:

262

Bu Sun Kim

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

[diff] [blame]

263

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

264

#

265

# Google Compute Engine has three Operation resources:

266

#

267

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

268

#

269

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

270

#

271

# Operations can be global, regional or zonal.

272

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

273

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

274

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

275

#

276

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

277

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

278

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

279

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

280

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

281

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

282

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

Bu Sun Kim

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

[diff] [blame]

283

{

Yoshi Automation Bot

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

[diff] [blame]

284

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

285

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

286

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

Bu Sun Kim

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

[diff] [blame]

287

},

288

],

Yoshi Automation Bot

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

[diff] [blame]

289

},

290

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

291

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

292

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

293

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

294

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

295

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

yoshi-code-bot

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

[diff] [blame]

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

{

310

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

311

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

312

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

313

{

314

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

315

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

316

},

317

],

318

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

319

},

320

],

321

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

322

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

326

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

327

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

328

329

Args:

330

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

Dan O'Meara

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

[diff] [blame]

331

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]

332

Dan O'Meara

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

[diff] [blame]

333

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]

334

Dan O'Meara

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

[diff] [blame]

335

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]

336

Bu Sun Kim

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

[diff] [blame]

337

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

338

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

339

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

340

341

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.

342

343

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

344

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]

345

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]

346

347

Returns:

348

An object of the form:

349

350

{ # Contains a list of TargetSslProxy resources.

Yoshi Automation Bot

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

[diff] [blame]

351

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

352

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

353

{ # Represents a Target SSL Proxy resource.

354

#

355

# 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 ==)

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

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

364

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

365

"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. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

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

[diff] [blame]

366

"A String",

367

],

368

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

369

},

370

],

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

{

379

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

380

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

381

},

Sai Cheemalapati

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

[diff] [blame]

382

],

Yoshi Automation Bot

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

[diff] [blame]

383

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

384

},

385

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

390

<pre>Retrieves the next page of results.

391

392

Args:

393

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

394

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

395

396

Returns:

Bu Sun Kim

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

[diff] [blame]

397

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

Sai Cheemalapati

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

[diff] [blame]

398

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]

403

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

Sai Cheemalapati

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

[diff] [blame]

404

<pre>Changes the BackendService for TargetSslProxy.

405

406

Args:

407

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

408

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]

409

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

410

The object takes the form of:

411

412

{

Yoshi Automation Bot

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

[diff] [blame]

413

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

414

}

Sai Cheemalapati

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

[diff] [blame]

415

Bu Sun Kim

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

[diff] [blame]

416

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.

417

418

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.

419

420

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]

421

422

Returns:

423

An object of the form:

424

Bu Sun Kim

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

[diff] [blame]

425

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

426

#

427

# Google Compute Engine has three Operation resources:

428

#

429

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

430

#

431

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

432

#

433

# Operations can be global, regional or zonal.

434

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

435

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

436

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

437

#

438

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

439

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

440

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

441

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

442

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

443

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

444

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

Bu Sun Kim

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

[diff] [blame]

445

{

Yoshi Automation Bot

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

[diff] [blame]

446

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

447

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

448

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

Bu Sun Kim

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

[diff] [blame]

449

},

450

],

Yoshi Automation Bot

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

[diff] [blame]

451

},

452

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

453

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

454

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

455

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

456

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

457

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

yoshi-code-bot

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

[diff] [blame]

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

{

472

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

473

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

474

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

475

{

476

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

477

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

478

},

479

],

480

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

481

},

482

],

483

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

484

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

489

<pre>Changes the Certificate Map for TargetSslProxy.

490

491

Args:

492

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

493

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)

494

body: object, The request body.

495

The object takes the form of:

496

497

{

Yoshi Automation Bot

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

[diff] [blame]

498

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

499

}

Bu Sun Kim

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

[diff] [blame]

500

501

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.

502

503

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.

504

505

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

506

507

Returns:

508

An object of the form:

509

510

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

511

#

512

# Google Compute Engine has three Operation resources:

513

#

514

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

515

#

516

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

517

#

518

# Operations can be global, regional or zonal.

519

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

520

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

521

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

522

#

523

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

524

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

525

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

526

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

527

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

528

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

529

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

Bu Sun Kim

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

[diff] [blame]

530

{

Yoshi Automation Bot

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

[diff] [blame]

531

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

532

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

533

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

Bu Sun Kim

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

[diff] [blame]

534

},

535

],

Yoshi Automation Bot

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

[diff] [blame]

536

},

537

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

538

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

539

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

540

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

541

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

542

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

yoshi-code-bot

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

[diff] [blame]

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

{

557

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

558

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

559

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

560

{

561

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

562

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

563

},

564

],

565

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

566

},

567

],

568

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

569

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

573

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

Sai Cheemalapati

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

[diff] [blame]

574

<pre>Changes the ProxyHeaderType for TargetSslProxy.

575

576

Args:

577

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

578

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]

579

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

580

The object takes the form of:

581

582

{

Yoshi Automation Bot

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

[diff] [blame]

583

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

584

}

Sai Cheemalapati

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

[diff] [blame]

585

Bu Sun Kim

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

[diff] [blame]

586

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.

587

588

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.

589

590

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]

591

592

Returns:

593

An object of the form:

594

Bu Sun Kim

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

[diff] [blame]

595

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

596

#

597

# Google Compute Engine has three Operation resources:

598

#

599

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

600

#

601

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

602

#

603

# Operations can be global, regional or zonal.

604

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

605

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

606

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

607

#

608

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

609

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

610

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

611

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

612

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

613

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

614

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

Bu Sun Kim

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

[diff] [blame]

615

{

Yoshi Automation Bot

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

[diff] [blame]

616

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

617

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

618

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

Bu Sun Kim

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

[diff] [blame]

619

},

620

],

Yoshi Automation Bot

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

[diff] [blame]

621

},

622

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

623

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

624

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

625

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

626

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

627

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

yoshi-code-bot

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

[diff] [blame]

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

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

641

{

642

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

643

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

644

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

645

{

646

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

647

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

648

},

649

],

650

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

651

},

652

],

653

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

654

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

658

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

Sai Cheemalapati

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

[diff] [blame]

659

<pre>Changes SslCertificates for TargetSslProxy.

660

661

Args:

662

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

663

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]

664

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

665

The object takes the form of:

666

667

{

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

668

"sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.

Yoshi Automation Bot

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

[diff] [blame]

669

"A String",

670

],

671

}

Sai Cheemalapati

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

[diff] [blame]

672

Bu Sun Kim

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

[diff] [blame]

673

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.

674

675

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.

676

677

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]

678

679

Returns:

680

An object of the form:

681

Bu Sun Kim

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

[diff] [blame]

682

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

683

#

684

# Google Compute Engine has three Operation resources:

685

#

686

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

687

#

688

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

689

#

690

# Operations can be global, regional or zonal.

691

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

692

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

693

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

694

#

695

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

696

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

697

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

698

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

699

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

700

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

701

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

Bu Sun Kim

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

[diff] [blame]

702

{

Yoshi Automation Bot

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

[diff] [blame]

703

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

704

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

705

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

Bu Sun Kim

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

[diff] [blame]

706

},

707

],

Yoshi Automation Bot

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

[diff] [blame]

708

},

709

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

710

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

711

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

712

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

713

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

714

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

yoshi-code-bot

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

[diff] [blame]

715

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

716

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

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

{

729

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

730

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

731

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

732

{

733

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

734

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

735

},

736

],

737

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

738

},

739

],

740

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

741

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

745

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

746

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

747

748

Args:

749

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

750

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]

751

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

752

The object takes the form of:

753

754

{

Yoshi Automation Bot

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

[diff] [blame]

755

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

756

}

Bu Sun Kim

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

[diff] [blame]

757

758

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.

759

760

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.

761

762

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

763

764

Returns:

765

An object of the form:

766

767

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

768

#

769

# Google Compute Engine has three Operation resources:

770

#

771

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

772

#

773

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

774

#

775

# Operations can be global, regional or zonal.

776

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

777

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

778

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

779

#

780

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

781

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

782

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

783

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

784

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

785

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

786

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

Bu Sun Kim

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

[diff] [blame]

787

{

Yoshi Automation Bot

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

[diff] [blame]

788

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

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

791

},

792

],

Yoshi Automation Bot

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

[diff] [blame]

793

},

794

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

795

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

796

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

797

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

798

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

799

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

yoshi-code-bot

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

[diff] [blame]

800

"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