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

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

[diff] [blame]

85

<p class="firstline">Retrieves an aggregated list of target pools.</p>

86

87

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

88

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

89

Dmitry Frenkel

3e17f89

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

[diff] [blame]

90

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

91

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

92

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

<p class="firstline">Deletes the specified target pool.</p>

95

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Returns the specified target pool. Gets a list of available target pools by making a list() request.</p>

Sai Cheemalapati

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

[diff] [blame]

98

Dan O'Meara

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

[diff] [blame]

99

<code><a href="#getHealth">getHealth(project, region, targetPool, body=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

100

<p class="firstline">Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.</p>

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

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

[diff] [blame]

103

<p class="firstline">Creates a target pool in the specified project and region using the data included in the request.</p>

104

Bu Sun Kim

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

<p class="firstline">Retrieves a list of target pools available to the specified project and region.</p>

107

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

<p class="firstline">Removes health check URL from a target pool.</p>

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

<p class="firstline">Removes instance URL from a target pool.</p>

116

Dan O'Meara

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

[diff] [blame]

117

<code><a href="#setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

118

<p class="firstline">Changes a backup target pool's configurations.</p>

119

Dan O'Meara

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

[diff] [blame]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

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

122

<h3>Method Details</h3>

123

Dan O'Meara

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

[diff] [blame]

124

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

Sai Cheemalapati

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

[diff] [blame]

125

<pre>Adds health check URLs to a target pool.

126

127

Args:

128

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

129

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

130

targetPool: string, Name of the target pool to add a health check to. (required)

Dan O'Meara

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

[diff] [blame]

131

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

132

The object takes the form of:

133

134

{

Yoshi Automation Bot

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

[diff] [blame]

135

"healthChecks": [ # The HttpHealthCheck to add to the target pool.

136

{ # A full or valid partial URL to a health check. For example, the following are valid URLs:

137

# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check

138

# - projects/project-id/global/httpHealthChecks/health-check

139

# - global/httpHealthChecks/health-check

140

"healthCheck": "A String",

141

},

142

],

143

}

Sai Cheemalapati

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

[diff] [blame]

144

Bu Sun Kim

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

[diff] [blame]

145

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.

146

147

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.

148

149

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]

150

151

Returns:

152

An object of the form:

153

Bu Sun Kim

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

[diff] [blame]

154

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

155

#

156

# Google Compute Engine has three Operation resources:

157

#

158

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

159

#

160

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

161

#

162

# Operations can be global, regional or zonal.

163

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

164

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

165

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

166

#

167

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

168

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

169

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

170

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

171

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

172

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

173

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

Bu Sun Kim

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

[diff] [blame]

174

{

Yoshi Automation Bot

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

[diff] [blame]

175

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

176

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

177

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

Bu Sun Kim

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

[diff] [blame]

178

},

179

],

Yoshi Automation Bot

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

[diff] [blame]

180

},

181

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

182

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

183

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

184

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

185

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

186

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

yoshi-code-bot

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

[diff] [blame]

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

{

201

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

202

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

203

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

204

{

205

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

206

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

207

},

208

],

209

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

210

},

211

],

212

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

213

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

217

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

Sai Cheemalapati

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

[diff] [blame]

218

<pre>Adds an instance to a target pool.

219

220

Args:

221

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

222

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

223

targetPool: string, Name of the TargetPool resource to add instances to. (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

227

{

Yoshi Automation Bot

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

[diff] [blame]

228

"instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:

229

# - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name

230

# - projects/project-id/zones/zone/instances/instance-name

231

# - zones/zone/instances/instance-name

232

{

233

"instance": "A String", # The URL for a specific instance.

234

},

235

],

236

}

Sai Cheemalapati

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

[diff] [blame]

237

Bu Sun Kim

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

[diff] [blame]

238

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.

239

240

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.

241

242

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]

243

244

Returns:

245

An object of the form:

246

Bu Sun Kim

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

[diff] [blame]

247

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

248

#

249

# Google Compute Engine has three Operation resources:

250

#

251

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

252

#

253

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

254

#

255

# Operations can be global, regional or zonal.

256

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

257

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

258

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

259

#

260

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

261

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

262

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

263

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

264

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

265

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

266

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

Bu Sun Kim

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

[diff] [blame]

267

{

Yoshi Automation Bot

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

[diff] [blame]

268

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

269

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

270

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

Bu Sun Kim

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

[diff] [blame]

271

},

272

],

Yoshi Automation Bot

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

[diff] [blame]

273

},

274

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

275

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

276

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

277

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

278

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

279

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

yoshi-code-bot

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

[diff] [blame]

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

{

294

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

295

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

296

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

297

{

298

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

299

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

300

},

301

],

302

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

303

},

304

],

305

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

306

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

310

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

Sai Cheemalapati

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

[diff] [blame]

311

<pre>Retrieves an aggregated list of target pools.

312

313

Args:

314

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

Dan O'Meara

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

[diff] [blame]

315

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]

316

Dan O'Meara

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

[diff] [blame]

317

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]

318

Dan O'Meara

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

[diff] [blame]

319

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]

320

Bu Sun Kim

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

[diff] [blame]

321

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

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

[diff] [blame]

322

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

Bu Sun Kim

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

[diff] [blame]

323

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

324

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

325

326

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.

327

328

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

329

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]

330

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]

331

332

Returns:

333

An object of the form:

334

335

{

Yoshi Automation Bot

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

[diff] [blame]

336

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

337

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

338

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

339

"targetPools": [ # A list of target pools contained in this scope.

340

{ # Represents a Target Pool resource.

341

#

342

# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)

343

"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

Bu Sun Kim

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

[diff] [blame]

344

#

Yoshi Automation Bot

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

[diff] [blame]

345

# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

346

#

347

# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

348

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

349

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

350

"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

351

#

352

# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

353

#

354

# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

yoshi-code-bot

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

[diff] [blame]

355

"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Yoshi Automation Bot

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

[diff] [blame]

356

"A String",

Sai Cheemalapati

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

[diff] [blame]

357

],

Yoshi Automation Bot

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

[diff] [blame]

358

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

359

"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

360

"A String",

361

],

362

"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.

363

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

364

"region": "A String", # [Output Only] URL of the region where the target pool resides.

365

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

366

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

367

"sessionAffinity": "A String", # Session affinity option, must be one of the following values:

368

# NONE: Connections from the same client IP may go to any instance in the pool.

369

# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.

370

# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Bu Sun Kim

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

[diff] [blame]

371

},

372

],

Yoshi Automation Bot

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

[diff] [blame]

373

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

374

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

375

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

376

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

377

{

378

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

379

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

380

},

381

],

382

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

383

},

Bu Sun Kim

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

[diff] [blame]

384

},

Yoshi Automation Bot

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

[diff] [blame]

385

},

386

"kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.

387

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

388

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

389

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

390

"A String",

391

],

392

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

393

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

394

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

395

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

396

{

397

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

398

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

399

},

400

],

401

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

402

},

403

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

408

<pre>Retrieves the next page of results.

409

410

Args:

411

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

412

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

413

414

Returns:

Bu Sun Kim

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

[diff] [blame]

415

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

Sai Cheemalapati

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

[diff] [blame]

416

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

421

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

422

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

426

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

Sai Cheemalapati

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

[diff] [blame]

427

<pre>Deletes the specified target pool.

428

429

Args:

430

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

431

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

432

targetPool: string, Name of the TargetPool resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

433

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.

434

435

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.

436

437

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]

438

439

Returns:

440

An object of the form:

441

Bu Sun Kim

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

[diff] [blame]

442

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

443

#

444

# Google Compute Engine has three Operation resources:

445

#

446

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

447

#

448

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

449

#

450

# Operations can be global, regional or zonal.

451

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

452

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

453

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

454

#

455

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

456

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

457

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

458

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

459

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

460

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

461

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

Bu Sun Kim

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

[diff] [blame]

462

{

Yoshi Automation Bot

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

[diff] [blame]

463

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

464

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

465

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

Bu Sun Kim

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

[diff] [blame]

466

},

467

],

Yoshi Automation Bot

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

[diff] [blame]

468

},

469

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

470

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

471

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

472

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

473

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

474

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

yoshi-code-bot

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

[diff] [blame]

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

{

489

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

490

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

491

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

492

{

493

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

494

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

495

},

496

],

497

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

498

},

499

],

500

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

501

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

506

<pre>Returns the specified target pool. Gets a list of available target pools by making a list() request.

Sai Cheemalapati

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

[diff] [blame]

507

508

Args:

509

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

510

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

511

targetPool: string, Name of the TargetPool resource to return. (required)

512

513

Returns:

514

An object of the form:

515

Dan O'Meara

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

[diff] [blame]

516

{ # Represents a Target Pool resource.

Yoshi Automation Bot

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

[diff] [blame]

517

#

518

# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)

519

"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

Bu Sun Kim

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

[diff] [blame]

520

#

Yoshi Automation Bot

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

[diff] [blame]

521

# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

522

#

523

# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

524

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

525

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

526

"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

527

#

528

# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

529

#

530

# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

yoshi-code-bot

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

[diff] [blame]

531

"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Yoshi Automation Bot

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

[diff] [blame]

532

"A String",

533

],

534

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

535

"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

536

"A String",

537

],

538

"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.

539

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

540

"region": "A String", # [Output Only] URL of the region where the target pool resides.

541

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

542

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

543

"sessionAffinity": "A String", # Session affinity option, must be one of the following values:

544

# NONE: Connections from the same client IP may go to any instance in the pool.

545

# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.

546

# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

547

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

551

<code class="details" id="getHealth">getHealth(project, region, targetPool, body=None)</code>

Sai Cheemalapati

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

[diff] [blame]

552

<pre>Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

553

554

Args:

555

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

556

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

557

targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)

Dan O'Meara

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

[diff] [blame]

558

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

559

The object takes the form of:

560

561

{

Bu Sun Kim

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

[diff] [blame]

562

"instance": "A String", # The URL for a specific instance.

Sai Cheemalapati

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

[diff] [blame]

}

Returns:

An object of the form:

568

569

{

Yoshi Automation Bot

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

[diff] [blame]

570

"healthStatus": [

571

{

572

"annotations": { # Metadata defined as annotations for network endpoint.

573

"a_key": "A String",

Sai Cheemalapati

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

[diff] [blame]

574

},

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

575

"forwardingRule": "A String", # URL of the forwarding rule associated with the health status of the instance.

576

"forwardingRuleIp": "A String", # A forwarding rule IP address assigned to this instance.

Yoshi Automation Bot

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

[diff] [blame]

577

"healthState": "A String", # Health state of the instance.

578

"instance": "A String", # URL of the instance resource.

yoshi-code-bot

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

[diff] [blame]

579

"ipAddress": "A String", # For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.

Yoshi Automation Bot

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

[diff] [blame]

580

"port": 42, # The named port of the instance group, not necessarily the port that is health-checked.

yoshi-code-bot

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

[diff] [blame]

581

"weight": "A String",

582

"weightError": "A String",

Yoshi Automation Bot

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

[diff] [blame]

583

},

584

],

585

"kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.

586

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

590

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

Sai Cheemalapati

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

[diff] [blame]

591

<pre>Creates a target pool in the specified project and region using the data included in the request.

592

593

Args:

594

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

595

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

Dan O'Meara

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

[diff] [blame]

596

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

597

The object takes the form of:

598

Dan O'Meara

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

[diff] [blame]

599

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

600

#

601

# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

602

"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

Dan O'Meara

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

[diff] [blame]

603

#

Bu Sun Kim

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

[diff] [blame]

604

# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

605

#

606

# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

607

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

608

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

609

"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

610

#

611

# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

612

#

613

# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

yoshi-code-bot

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

[diff] [blame]

614

"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Bu Sun Kim

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

[diff] [blame]

615

"A String",

616

],

617

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

618

"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

619

"A String",

620

],

621

"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.

622

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

623

"region": "A String", # [Output Only] URL of the region where the target pool resides.

624

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

625

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

626

"sessionAffinity": "A String", # Session affinity option, must be one of the following values:

627

# NONE: Connections from the same client IP may go to any instance in the pool.

628

# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.

629

# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

630

}

Sai Cheemalapati

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

[diff] [blame]

631

Bu Sun Kim

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

[diff] [blame]

632

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.

633

634

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.

635

636

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]

637

638

Returns:

639

An object of the form:

640

Bu Sun Kim

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

[diff] [blame]

641

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

642

#

643

# Google Compute Engine has three Operation resources:

644

#

645

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

646

#

647

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

648

#

649

# Operations can be global, regional or zonal.

650

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

651

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

652

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

653

#

654

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

655

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

656

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

657

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

658

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

659

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

660

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

Bu Sun Kim

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

[diff] [blame]

661

{

Yoshi Automation Bot

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

[diff] [blame]

662

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

663

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

664

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

Bu Sun Kim

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

[diff] [blame]

665

},

666

],

Yoshi Automation Bot

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

[diff] [blame]

667

},

668

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

669

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

670

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

671

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

672

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

673

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

yoshi-code-bot

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

[diff] [blame]

674

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

675

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

676

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

677

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

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

{

688

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

689

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

690

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

691

{

692

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

693

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

694

},

695

],

696

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

697

},

698

],

699

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

700

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

704

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

Sai Cheemalapati

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

[diff] [blame]

705

<pre>Retrieves a list of target pools available to the specified project and region.

706

707

Args:

708

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

709

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

Dan O'Meara

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

[diff] [blame]

710

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]

711

Dan O'Meara

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

[diff] [blame]

712

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]

713

Dan O'Meara

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

[diff] [blame]

714

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]

715

Bu Sun Kim

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

[diff] [blame]

716

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

717

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

718

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

719

720

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.

721

722

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

723

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]

724

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]

725

726

Returns:

727

An object of the form:

728

729

{ # Contains a list of TargetPool resources.

Yoshi Automation Bot

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

[diff] [blame]

730

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

731

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

732

{ # Represents a Target Pool resource.

733

#

734

# Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)

735

"backupPool": "A String", # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

Bu Sun Kim

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

[diff] [blame]

736

#

Yoshi Automation Bot

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

[diff] [blame]

737

# backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

738

#

739

# In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

740

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

741

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

742

"failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

743

#

744

# If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

745

#

746

# In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

yoshi-code-bot

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

[diff] [blame]

747

"healthChecks": [ # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Yoshi Automation Bot

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

[diff] [blame]

748

"A String",

749

],

750

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

751

"instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

752

"A String",

753

],

754

"kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.

755

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

756

"region": "A String", # [Output Only] URL of the region where the target pool resides.

757

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

758

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

759

"sessionAffinity": "A String", # Session affinity option, must be one of the following values:

760

# NONE: Connections from the same client IP may go to any instance in the pool.

761

# CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.

762

# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

763

},

764

],

765

"kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.

766

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

767

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

768

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

769

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

770

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

771

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

772

{

773

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

774

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

775

},

Sai Cheemalapati

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

[diff] [blame]

776

],

Yoshi Automation Bot

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

[diff] [blame]

777

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

778

},

779

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

784

<pre>Retrieves the next page of results.

785

786

Args:

787

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

788

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

789

790

Returns:

Bu Sun Kim

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

[diff] [blame]

791

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

Sai Cheemalapati

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

[diff] [blame]

792

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]

797

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

Sai Cheemalapati

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

[diff] [blame]

798

<pre>Removes health check URL from a target pool.

799

800

Args:

801

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

802

region: string, Name of the region for this request. (required)

803

targetPool: string, Name of the target pool to remove health checks from. (required)

Dan O'Meara

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

[diff] [blame]

804

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

805

The object takes the form of:

806

807

{

Yoshi Automation Bot

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

[diff] [blame]

808

"healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:

809

# - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check

810

# - projects/project/global/httpHealthChecks/health-check

811

# - global/httpHealthChecks/health-check

812

{ # A full or valid partial URL to a health check. For example, the following are valid URLs:

813

# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check

814

# - projects/project-id/global/httpHealthChecks/health-check

Sai Cheemalapati

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

[diff] [blame]

815

# - global/httpHealthChecks/health-check

Yoshi Automation Bot

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

[diff] [blame]

816

"healthCheck": "A String",

817

},

818

],

819

}

Sai Cheemalapati

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

[diff] [blame]

820

Bu Sun Kim

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

[diff] [blame]

821

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.

822

823

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.

824

825

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]

826

827

Returns:

828

An object of the form:

829

Bu Sun Kim

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

[diff] [blame]

830

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

831

#

832

# Google Compute Engine has three Operation resources:

833

#

834

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

835

#

836

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

837

#

838

# Operations can be global, regional or zonal.

839

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

840

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

841

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

842

#

843

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

844

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

845

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

846

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

847

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

848

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

849

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

Bu Sun Kim

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

[diff] [blame]

850

{

Yoshi Automation Bot

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

[diff] [blame]

851

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

852

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

853

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

Bu Sun Kim

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

[diff] [blame]

854

},

855

],

Yoshi Automation Bot

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

[diff] [blame]

856

},

857

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

858

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

859

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

860

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

861

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

862

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

yoshi-code-bot

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

[diff] [blame]

863

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

864

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

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

{

877

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

878

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

879

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

880

{

881

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

882

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

883

},

884

],

885

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

886

},

887

],

888

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

889

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

893

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

Sai Cheemalapati

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

[diff] [blame]

894

<pre>Removes instance URL from a target pool.

895

896

Args:

897

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

898

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

899

targetPool: string, Name of the TargetPool resource to remove instances from. (required)

Dan O'Meara

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

[diff] [blame]

900

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

901

The object takes the form of:

902

903

{

Yoshi Automation Bot

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

[diff] [blame]

904

"instances": [ # URLs of the instances to be removed from target pool.

905

{

906

"instance": "A String", # The URL for a specific instance.

907

},

908

],

909

}

Sai Cheemalapati

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

[diff] [blame]

910

Bu Sun Kim

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

[diff] [blame]

911

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.

912

913

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.

914

915

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]

916

917

Returns:

918

An object of the form:

919

Bu Sun Kim

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

[diff] [blame]

920

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

921

#

922

# Google Compute Engine has three Operation resources:

923

#

924

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

925

#

926

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

927

#

928

# Operations can be global, regional or zonal.

929

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

930

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

931

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

932

#

933

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

934

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

935

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

936

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

937

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

938

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

939

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

Bu Sun Kim

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

[diff] [blame]

940

{

Yoshi Automation Bot

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

[diff] [blame]

941

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

942

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

943

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

Bu Sun Kim

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

[diff] [blame]

944

},

945

],

Yoshi Automation Bot

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

[diff] [blame]

946

},

947

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

948

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

949

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

950

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

951

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

952

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

yoshi-code-bot

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

[diff] [blame]

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

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

964

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

965

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

966

{

967

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

968

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

969

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

970

{

971

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

972

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

973

},

974

],

975

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

976

},

977

],

978

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

979

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

983

<code class="details" id="setBackup">setBackup(project, region, targetPool, body=None, failoverRatio=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

984

<pre>Changes a backup target pool's configurations.

Sai Cheemalapati

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

[diff] [blame]

985

986

Args:

987

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

988

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

989

targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)

Dan O'Meara

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

[diff] [blame]

990

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

991

The object takes the form of:

992

993

{

Yoshi Automation Bot

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

[diff] [blame]

994

"target": "A String",

995

}

Sai Cheemalapati

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

[diff] [blame]

996

997

failoverRatio: number, New failoverRatio value for the target pool.

Bu Sun Kim

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

[diff] [blame]

998

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.

999

1000

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.

1001

1002

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]

1003

1004

Returns:

1005

An object of the form:

1006

Bu Sun Kim

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

[diff] [blame]

1007

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1008

#

1009

# Google Compute Engine has three Operation resources:

1010

#

1011

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

1012

#

1013

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

1014

#

1015

# Operations can be global, regional or zonal.

1016

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

1017

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

1018

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

1019

#

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

Bu Sun Kim

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

[diff] [blame]

1027

{

Yoshi Automation Bot

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

[diff] [blame]

1028

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

1029

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

1030

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

Bu Sun Kim

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

[diff] [blame]

1031

},

1032

],

Yoshi Automation Bot

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

[diff] [blame]

1033

},

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

yoshi-code-bot

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

[diff] [blame]

1040

"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