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

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

{

Bu Sun Kim

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

[diff] [blame]

135

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

Sai Cheemalapati

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

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame]

140

"healthCheck": "A String",

Sai Cheemalapati

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

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.

155

#

Dan O'Meara

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

[diff] [blame]

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

#

Bu Sun Kim

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

[diff] [blame]

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.

Dan O'Meara

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

[diff] [blame]

163

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

164

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

165

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

Bu Sun Kim

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

[diff] [blame]

166

#

Dan O'Meara

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

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame]

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.

Sai Cheemalapati

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

[diff] [blame]

174

{

Bu Sun Kim

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

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

Sai Cheemalapati

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

[diff] [blame]

178

},

179

],

180

},

Bu Sun Kim

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

[diff] [blame]

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.

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

{

200

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

201

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

202

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

203

{

204

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

205

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

206

},

207

],

208

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

209

},

210

],

211

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

216

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

217

<pre>Adds an instance to a target pool.

218

219

Args:

220

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

221

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

222

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

Dan O'Meara

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

[diff] [blame]

223

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

224

The object takes the form of:

225

226

{

Bu Sun Kim

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

[diff] [blame]

227

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

Sai Cheemalapati

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

[diff] [blame]

228

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

229

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

230

# - zones/zone/instances/instance-name

231

{

Bu Sun Kim

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

[diff] [blame]

232

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

Sai Cheemalapati

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

237

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.

238

239

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.

240

241

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]

242

243

Returns:

244

An object of the form:

245

Bu Sun Kim

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

[diff] [blame]

246

{ # Represents an Operation resource.

247

#

Dan O'Meara

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

[diff] [blame]

248

# Google Compute Engine has three Operation resources:

249

#

250

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

251

#

Bu Sun Kim

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

[diff] [blame]

252

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

253

#

254

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

255

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

256

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

257

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

Bu Sun Kim

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

[diff] [blame]

258

#

Dan O'Meara

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

[diff] [blame]

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

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

263

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

264

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

265

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

Sai Cheemalapati

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

[diff] [blame]

266

{

Bu Sun Kim

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

[diff] [blame]

267

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

268

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

269

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

Sai Cheemalapati

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

[diff] [blame]

270

},

271

],

272

},

Bu Sun Kim

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

[diff] [blame]

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

{

292

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

293

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

294

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

295

{

296

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

297

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

298

},

299

],

300

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

301

},

302

],

303

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

308

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

309

<pre>Retrieves an aggregated list of target pools.

310

311

Args:

312

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

Dan O'Meara

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

[diff] [blame]

313

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]

314

Dan O'Meara

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

[diff] [blame]

315

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]

316

Dan O'Meara

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

[diff] [blame]

317

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]

318

Bu Sun Kim

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

[diff] [blame]

319

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]

320

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]

321

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

322

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

323

324

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.

325

326

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

327

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.

328

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

Sai Cheemalapati

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

[diff] [blame]

329

330

Returns:

331

An object of the form:

332

333

{

Bu Sun Kim

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

[diff] [blame]

334

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

335

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

336

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

337

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

338

{ # Represents a Target Pool resource.

339

#

340

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

341

"backupPool": "A String", # 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].

342

#

343

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

344

#

345

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

346

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

347

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

348

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

349

#

350

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

351

#

352

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

Dmitry Frenkel

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

[diff] [blame^]

353

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

Bu Sun Kim

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

[diff] [blame]

354

"A String",

355

],

356

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

357

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

358

"A String",

359

],

360

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

361

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

},

370

],

371

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

372

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

373

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

374

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

Sai Cheemalapati

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

[diff] [blame]

375

{

Bu Sun Kim

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

[diff] [blame]

376

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

377

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

Sai Cheemalapati

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

[diff] [blame]

378

},

379

],

Bu Sun Kim

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

[diff] [blame]

380

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

Sai Cheemalapati

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

[diff] [blame]

381

},

Sai Cheemalapati

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

[diff] [blame]

382

},

383

},

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

386

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

387

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

388

"A String",

389

],

390

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

391

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

392

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

393

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

Bu Sun Kim

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

[diff] [blame]

394

{

Bu Sun Kim

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

[diff] [blame]

395

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

396

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

Bu Sun Kim

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

[diff] [blame]

397

},

398

],

Bu Sun Kim

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

[diff] [blame]

399

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

Bu Sun Kim

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

[diff] [blame]

400

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

406

<pre>Retrieves the next page of results.

407

408

Args:

409

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

410

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

411

412

Returns:

Bu Sun Kim

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

[diff] [blame]

413

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

Sai Cheemalapati

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

[diff] [blame]

414

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

419

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

420

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

424

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

Sai Cheemalapati

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

[diff] [blame]

425

<pre>Deletes the specified target pool.

426

427

Args:

428

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

429

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

430

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

Bu Sun Kim

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

[diff] [blame]

431

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.

432

433

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.

434

435

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]

436

437

Returns:

438

An object of the form:

439

Bu Sun Kim

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

[diff] [blame]

440

{ # Represents an Operation resource.

441

#

Dan O'Meara

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

[diff] [blame]

442

# Google Compute Engine has three Operation resources:

443

#

444

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

445

#

Bu Sun Kim

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

[diff] [blame]

446

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

447

#

448

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

449

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

450

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

451

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

Bu Sun Kim

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

[diff] [blame]

452

#

Dan O'Meara

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

[diff] [blame]

453

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

Bu Sun Kim

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

[diff] [blame]

454

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

455

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

456

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

457

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

458

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

459

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

Sai Cheemalapati

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

[diff] [blame]

460

{

Bu Sun Kim

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

[diff] [blame]

461

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

462

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

463

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

Sai Cheemalapati

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

[diff] [blame]

464

},

465

],

466

},

Bu Sun Kim

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

[diff] [blame]

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

{

486

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

487

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

488

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

489

{

490

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

491

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

492

},

493

],

494

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

495

},

496

],

497

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

503

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

504

505

Args:

506

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

507

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

508

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

509

510

Returns:

511

An object of the form:

512

Dan O'Meara

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

[diff] [blame]

513

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

514

#

515

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

516

"backupPool": "A String", # 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]

517

#

Bu Sun Kim

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

[diff] [blame]

518

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

519

#

520

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

521

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

522

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

523

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

524

#

525

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

526

#

527

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

Dmitry Frenkel

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

[diff] [blame^]

528

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

Bu Sun Kim

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

[diff] [blame]

529

"A String",

530

],

531

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

532

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

533

"A String",

534

],

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

548

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

Sai Cheemalapati

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

[diff] [blame]

549

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

550

551

Args:

552

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

553

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

554

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]

555

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

556

The object takes the form of:

557

558

{

Bu Sun Kim

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

[diff] [blame]

559

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

565

566

{

Bu Sun Kim

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

[diff] [blame]

567

"healthStatus": [

Sai Cheemalapati

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

[diff] [blame]

568

{

Bu Sun Kim

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

[diff] [blame]

569

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

570

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

571

},

Bu Sun Kim

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

[diff] [blame]

572

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

573

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

574

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

575

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

Sai Cheemalapati

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

[diff] [blame]

576

},

577

],

Bu Sun Kim

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

[diff] [blame]

578

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

583

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

Sai Cheemalapati

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

[diff] [blame]

584

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

585

586

Args:

587

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

588

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

Dan O'Meara

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

[diff] [blame]

589

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

590

The object takes the form of:

591

Dan O'Meara

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

[diff] [blame]

592

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

593

#

594

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

595

"backupPool": "A String", # 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]

596

#

Bu Sun Kim

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

[diff] [blame]

597

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

598

#

599

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

600

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

601

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

602

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

603

#

604

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

605

#

606

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

Dmitry Frenkel

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

[diff] [blame^]

607

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

Bu Sun Kim

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

[diff] [blame]

608

"A String",

609

],

610

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

611

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

612

"A String",

613

],

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

}

Sai Cheemalapati

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

[diff] [blame]

624

Bu Sun Kim

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

[diff] [blame]

625

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.

626

627

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.

628

629

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]

630

631

Returns:

632

An object of the form:

633

Bu Sun Kim

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

[diff] [blame]

634

{ # Represents an Operation resource.

635

#

Dan O'Meara

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

[diff] [blame]

636

# Google Compute Engine has three Operation resources:

637

#

638

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

639

#

Bu Sun Kim

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

[diff] [blame]

640

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

641

#

642

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

643

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

644

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

645

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

Bu Sun Kim

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

[diff] [blame]

646

#

Dan O'Meara

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

[diff] [blame]

647

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

Bu Sun Kim

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

[diff] [blame]

648

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

649

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

650

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

651

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

652

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

653

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

Sai Cheemalapati

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

[diff] [blame]

654

{

Bu Sun Kim

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

[diff] [blame]

655

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

656

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

657

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

Sai Cheemalapati

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

[diff] [blame]

658

},

659

],

660

},

Bu Sun Kim

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

[diff] [blame]

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

{

680

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

681

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

682

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

683

{

684

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

685

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

686

},

687

],

688

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

689

},

690

],

691

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

696

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

697

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

698

699

Args:

700

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

701

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

Dan O'Meara

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

[diff] [blame]

702

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]

703

Dan O'Meara

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

[diff] [blame]

704

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]

705

Dan O'Meara

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

[diff] [blame]

706

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]

707

Bu Sun Kim

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

[diff] [blame]

708

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

709

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

710

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

711

712

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.

713

714

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

715

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.

716

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

Sai Cheemalapati

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

[diff] [blame]

717

718

Returns:

719

An object of the form:

720

721

{ # Contains a list of TargetPool resources.

Bu Sun Kim

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

[diff] [blame]

722

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

723

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

Dan O'Meara

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

[diff] [blame]

724

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

725

#

726

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

727

"backupPool": "A String", # 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]

728

#

Bu Sun Kim

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

[diff] [blame]

729

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

730

#

731

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

732

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

733

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

734

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

735

#

736

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

737

#

738

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

Dmitry Frenkel

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

[diff] [blame^]

739

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

Bu Sun Kim

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

[diff] [blame]

740

"A String",

741

],

742

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

743

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

744

"A String",

745

],

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

},

Sai Cheemalapati

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

[diff] [blame]

756

],

Bu Sun Kim

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

[diff] [blame]

757

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

758

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

759

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

760

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

761

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

762

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

763

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

Bu Sun Kim

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

[diff] [blame]

764

{

Bu Sun Kim

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

[diff] [blame]

765

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

766

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

Bu Sun Kim

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

[diff] [blame]

767

},

768

],

Bu Sun Kim

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

[diff] [blame]

769

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

Bu Sun Kim

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

[diff] [blame]

770

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

776

<pre>Retrieves the next page of results.

777

778

Args:

779

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

780

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

781

782

Returns:

Bu Sun Kim

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

[diff] [blame]

783

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

Sai Cheemalapati

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

[diff] [blame]

784

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]

789

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

790

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

791

792

Args:

793

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

794

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

795

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]

796

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

797

The object takes the form of:

798

799

{

Bu Sun Kim

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

[diff] [blame]

800

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

Sai Cheemalapati

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

[diff] [blame]

801

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

802

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

803

# - global/httpHealthChecks/health-check

804

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

805

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

806

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

807

# - global/httpHealthChecks/health-check

Bu Sun Kim

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

[diff] [blame]

808

"healthCheck": "A String",

Sai Cheemalapati

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

813

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.

814

815

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.

816

817

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]

818

819

Returns:

820

An object of the form:

821

Bu Sun Kim

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

[diff] [blame]

822

{ # Represents an Operation resource.

823

#

Dan O'Meara

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

[diff] [blame]

824

# Google Compute Engine has three Operation resources:

825

#

826

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

827

#

Bu Sun Kim

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

[diff] [blame]

828

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

829

#

830

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

831

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

832

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

833

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

Bu Sun Kim

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

[diff] [blame]

834

#

Dan O'Meara

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

[diff] [blame]

835

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

Bu Sun Kim

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

[diff] [blame]

836

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

837

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

838

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

839

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

840

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

841

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

Sai Cheemalapati

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

[diff] [blame]

842

{

Bu Sun Kim

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

[diff] [blame]

843

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

844

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

845

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

Sai Cheemalapati

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

[diff] [blame]

846

},

847

],

848

},

Bu Sun Kim

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

[diff] [blame]

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

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

866

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

867

{

868

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

869

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

870

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

871

{

872

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

873

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

874

},

875

],

876

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

877

},

878

],

879

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

884

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

885

<pre>Removes instance URL from a target pool.

886

887

Args:

888

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

889

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

890

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

Dan O'Meara

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

[diff] [blame]

891

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

892

The object takes the form of:

893

894

{

Bu Sun Kim

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

[diff] [blame]

895

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

Sai Cheemalapati

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

[diff] [blame]

896

{

Bu Sun Kim

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

[diff] [blame]

897

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

Sai Cheemalapati

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

902

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.

903

904

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.

905

906

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]

907

908

Returns:

909

An object of the form:

910

Bu Sun Kim

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

[diff] [blame]

911

{ # Represents an Operation resource.

912

#

Dan O'Meara

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

[diff] [blame]

913

# Google Compute Engine has three Operation resources:

914

#

915

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

916

#

Bu Sun Kim

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

[diff] [blame]

917

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

918

#

919

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

920

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

921

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

922

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

Bu Sun Kim

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

[diff] [blame]

923

#

Dan O'Meara

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

[diff] [blame]

924

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

Bu Sun Kim

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

[diff] [blame]

925

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

926

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

927

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

928

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

929

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

930

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

Sai Cheemalapati

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

[diff] [blame]

931

{

Bu Sun Kim

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

[diff] [blame]

932

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

933

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

934

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

Sai Cheemalapati

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

[diff] [blame]

935

},

936

],

937

},

Bu Sun Kim

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

[diff] [blame]

938

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

939

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

940

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

941

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

942

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

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

{

957

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

958

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

959

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

960

{

961

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

962

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

963

},

964

],

965

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

966

},

967

],

968

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

973

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

974

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

Sai Cheemalapati

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

[diff] [blame]

975

976

Args:

977

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

978

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

979

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]

980

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

981

The object takes the form of:

982

983

{

Bu Sun Kim

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

[diff] [blame]

984

"target": "A String",

Sai Cheemalapati

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

[diff] [blame]

985

}

986

987

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

Bu Sun Kim

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

[diff] [blame]

988

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.

989

990

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.

991

992

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]

993

994

Returns:

995

An object of the form:

996

Bu Sun Kim

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

[diff] [blame]

997

{ # Represents an Operation resource.

998

#

Dan O'Meara

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

[diff] [blame]

999

# Google Compute Engine has three Operation resources:

1000

#

1001

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

1002

#

Bu Sun Kim

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

[diff] [blame]

1003

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

1004

#

1005

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1006

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

1007

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

1008

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

Bu Sun Kim

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

[diff] [blame]

1009

#

Dan O'Meara

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

[diff] [blame]

1010

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

Bu Sun Kim

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

[diff] [blame]

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

Sai Cheemalapati

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

[diff] [blame]

1017

{

Bu Sun Kim

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

[diff] [blame]

1018

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

1019

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

1020

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

Sai Cheemalapati

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

[diff] [blame]

1021

},

1022

],

1023

},

Bu Sun Kim