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

2016-02-19 16:02:29 -0800

[diff] [blame]

85

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame]

93

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

94

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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>

John Asmuth

2014-04-24 15:46:26 -0400

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

103

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

104

Dmitry Frenkel

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

[diff] [blame]

105

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

106

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

112

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

115

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

118

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

119

<h3>Method Details</h3>

120

Dan O'Meara

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

[diff] [blame]

121

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

122

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

123

124

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

125

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

126

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

127

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]

128

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

129

The object takes the form of:

130

131

{

Bu Sun Kim

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

[diff] [blame]

132

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

133

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

134

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

135

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

136

# - global/httpHealthChecks/health-check

Bu Sun Kim

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

[diff] [blame]

137

"healthCheck": "A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

142

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.

143

144

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.

145

146

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

147

148

Returns:

149

An object of the form:

150

Bu Sun Kim

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

[diff] [blame]

151

{ # Represents an Operation resource.

152

#

Dan O'Meara

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

[diff] [blame]

153

# Google Compute Engine has three Operation resources:

154

#

155

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

156

#

Bu Sun Kim

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

[diff] [blame]

157

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

158

#

159

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

160

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

161

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

162

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

Bu Sun Kim

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

[diff] [blame]

163

#

Dan O'Meara

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

[diff] [blame]

164

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

165

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

166

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

167

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

168

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

169

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

170

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

171

{

Bu Sun Kim

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

[diff] [blame]

172

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

173

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

174

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

175

},

176

],

177

},

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

{

196

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

197

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

198

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

199

{

200

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

201

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

202

},

203

],

204

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

205

},

206

],

207

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

212

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

213

<pre>Adds an instance to a target pool.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

214

215

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

216

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

217

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

218

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

Dan O'Meara

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

[diff] [blame]

219

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

220

The object takes the form of:

221

222

{

Bu Sun Kim

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

[diff] [blame]

223

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

224

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

225

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

226

# - zones/zone/instances/instance-name

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

227

{

Bu Sun Kim

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

[diff] [blame]

228

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

233

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.

234

235

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.

236

237

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

238

239

Returns:

240

An object of the form:

241

Bu Sun Kim

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

[diff] [blame]

242

{ # Represents an Operation resource.

243

#

Dan O'Meara

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

[diff] [blame]

244

# Google Compute Engine has three Operation resources:

245

#

246

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

247

#

Bu Sun Kim

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

[diff] [blame]

248

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

249

#

250

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

251

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

252

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

253

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

Bu Sun Kim

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

[diff] [blame]

254

#

Dan O'Meara

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

[diff] [blame]

255

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

256

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

257

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

258

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

259

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

260

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

261

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

262

{

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

266

},

267

],

268

},

Bu Sun Kim

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

[diff] [blame]

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

{

287

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

288

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

289

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

290

{

291

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

292

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

293

},

294

],

295

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

296

},

297

],

298

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

303

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

304

<pre>Retrieves an aggregated list of target pools.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

305

306

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

307

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

Dan O'Meara

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

[diff] [blame]

308

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

309

Dan O'Meara

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

[diff] [blame]

310

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

311

Dan O'Meara

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

[diff] [blame]

312

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

313

Bu Sun Kim

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

[diff] [blame]

314

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]

315

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]

316

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

317

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

318

319

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.

320

321

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

322

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.

Dmitry Frenkel

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

[diff] [blame]

323

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

324

325

Returns:

326

An object of the form:

327

328

{

Bu Sun Kim

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

[diff] [blame]

329

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

330

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

331

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

332

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

333

{ # Represents a Target Pool resource.

334

#

335

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

336

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

337

#

338

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

339

#

340

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

341

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

342

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

343

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

344

#

345

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

346

#

347

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

348

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

349

"A String",

350

],

351

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

352

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

353

"A String",

354

],

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

},

364

],

365

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

366

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

367

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

368

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

369

{

Bu Sun Kim

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

[diff] [blame]

370

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

371

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

372

},

373

],

Bu Sun Kim

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

[diff] [blame]

374

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

375

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

376

},

377

},

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

380

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

Dmitry Frenkel

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

[diff] [blame]

381

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

382

"A String",

383

],

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

{

Bu Sun Kim

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

[diff] [blame]

389

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

390

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

391

},

392

],

Bu Sun Kim

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

[diff] [blame]

393

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

394

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

400

<pre>Retrieves the next page of results.

401

402

Args:

403

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

404

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

405

406

Returns:

Bu Sun Kim

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

[diff] [blame]

407

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

408

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]

413

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

414

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

418

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

419

<pre>Deletes the specified target pool.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

420

421

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

422

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

423

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

424

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

Bu Sun Kim

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

[diff] [blame]

425

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.

426

427

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.

428

429

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

430

431

Returns:

432

An object of the form:

433

Bu Sun Kim

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

[diff] [blame]

434

{ # Represents an Operation resource.

435

#

Dan O'Meara

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

[diff] [blame]

436

# Google Compute Engine has three Operation resources:

437

#

438

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

439

#

Bu Sun Kim

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

[diff] [blame]

440

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

441

#

442

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

443

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

444

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

445

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

Bu Sun Kim

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

[diff] [blame]

446

#

Dan O'Meara

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

[diff] [blame]

447

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

448

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

449

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

450

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

451

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

452

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

453

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

454

{

Bu Sun Kim

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

[diff] [blame]

455

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

456

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

457

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

458

},

459

],

460

},

Bu Sun Kim

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

[diff] [blame]

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

{

479

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

480

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

481

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

482

{

483

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

484

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

485

},

486

],

487

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

488

},

489

],

490

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

John Asmuth

2014-04-24 15:46:26 -0400

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

496

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

497

498

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

499

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

500

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

501

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

502

503

Returns:

504

An object of the form:

505

Dan O'Meara

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

[diff] [blame]

506

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

507

#

508

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

509

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

510

#

Bu Sun Kim

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

[diff] [blame]

511

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

512

#

513

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

514

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

515

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

516

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

517

#

518

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

519

#

520

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

521

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

522

"A String",

523

],

524

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

525

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

526

"A String",

527

],

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

540

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

541

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

542

543

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

544

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

545

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

546

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]

547

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

548

The object takes the form of:

549

550

{

Bu Sun Kim

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

[diff] [blame]

551

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

557

558

{

Bu Sun Kim

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

[diff] [blame]

559

"healthStatus": [

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

560

{

Bu Sun Kim

d059ad8

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

[diff] [blame]

561

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

562

"a_key": "A String",

563

},

Bu Sun Kim

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

[diff] [blame]

564

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

565

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

566

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

567

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

568

},

569

],

Bu Sun Kim

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

[diff] [blame]

570

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

575

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

576

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

577

578

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

579

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

580

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

Dan O'Meara

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

[diff] [blame]

581

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

582

The object takes the form of:

583

Dan O'Meara

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

[diff] [blame]

584

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

585

#

586

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

587

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

588

#

Bu Sun Kim

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

[diff] [blame]

589

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

590

#

591

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

592

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

593

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

594

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

595

#

596

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

597

#

598

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

599

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

600

"A String",

601

],

602

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

603

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

604

"A String",

605

],

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

615

Bu Sun Kim

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

[diff] [blame]

616

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.

617

618

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.

619

620

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

621

622

Returns:

623

An object of the form:

624

Bu Sun Kim

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

[diff] [blame]

625

{ # Represents an Operation resource.

626

#

Dan O'Meara

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

[diff] [blame]

627

# Google Compute Engine has three Operation resources:

628

#

629

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

630

#

Bu Sun Kim

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

[diff] [blame]

631

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

632

#

633

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

634

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

635

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

636

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

Bu Sun Kim

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

[diff] [blame]

637

#

Dan O'Meara

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

[diff] [blame]

638

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

639

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

640

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

641

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

642

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

643

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

644

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

645

{

Bu Sun Kim

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

[diff] [blame]

646

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

647

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

648

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

649

},

650

],

651

},

Bu Sun Kim

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

[diff] [blame]

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

{

670

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

671

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

672

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

673

{

674

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

675

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

676

},

677

],

678

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

679

},

680

],

681

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

686

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

687

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

688

689

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

690

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

691

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

Dan O'Meara

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

[diff] [blame]

692

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

693

Dan O'Meara

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

[diff] [blame]

694

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

695

Dan O'Meara

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

[diff] [blame]

696

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

697

Bu Sun Kim

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

[diff] [blame]

698

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

699

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

700

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

701

702

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.

703

704

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

705

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.

Dmitry Frenkel

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

[diff] [blame]

706

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

707

708

Returns:

709

An object of the form:

710

711

{ # Contains a list of TargetPool resources.

Bu Sun Kim

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

[diff] [blame]

712

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

713

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

Dan O'Meara

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

[diff] [blame]

714

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

715

#

716

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

717

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

718

#

Bu Sun Kim

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

[diff] [blame]

719

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

720

#

721

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

722

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

723

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

724

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

725

#

726

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

727

#

728

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

729

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

730

"A String",

731

],

732

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

733

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

734

"A String",

735

],

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

745

],

Bu Sun Kim

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

[diff] [blame]

746

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

747

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

748

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

749

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

750

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

751

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

752

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

Bu Sun Kim

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

[diff] [blame]

753

{

Bu Sun Kim

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

[diff] [blame]

754

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

755

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

756

},

757

],

Bu Sun Kim

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

[diff] [blame]

758

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

759

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

765

<pre>Retrieves the next page of results.

766

767

Args:

768

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

769

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

770

771

Returns:

Bu Sun Kim

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

[diff] [blame]

772

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

773

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]

778

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

779

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

780

781

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

782

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

783

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

784

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]

785

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

786

The object takes the form of:

787

788

{

Bu Sun Kim

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

[diff] [blame]

789

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

790

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

791

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

792

# - global/httpHealthChecks/health-check

793

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

794

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

795

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

796

# - global/httpHealthChecks/health-check

Bu Sun Kim

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

[diff] [blame]

797

"healthCheck": "A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

802

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.

803

804

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.

805

806

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

807

808

Returns:

809

An object of the form:

810

Bu Sun Kim

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

[diff] [blame]

811

{ # Represents an Operation resource.

812

#

Dan O'Meara

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

[diff] [blame]

813

# Google Compute Engine has three Operation resources:

814

#

815

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

816

#

Bu Sun Kim

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

[diff] [blame]

817

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

818

#

819

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

820

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

821

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

822

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

Bu Sun Kim

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

[diff] [blame]

823

#

Dan O'Meara

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

[diff] [blame]

824

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

825

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

826

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

827

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

828

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

829

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

830

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

831

{

Bu Sun Kim

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

[diff] [blame]

832

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

833

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

834

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

835

},

836

],

837

},

Bu Sun Kim

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

[diff] [blame]

838

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

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

{

856

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

857

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

858

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

859

{

860

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

861

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

862

},

863

],

864

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

865

},

866

],

867

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

872

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

873

<pre>Removes instance URL from a target pool.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

874

875

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

876

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

877

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

878

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

Dan O'Meara

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

[diff] [blame]

879

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

880

The object takes the form of:

881

882

{

Bu Sun Kim

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

[diff] [blame]

883

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

884

{

Bu Sun Kim

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

[diff] [blame]

885

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

890

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.

891

892

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.

893

894

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

895

896

Returns:

897

An object of the form:

898

Bu Sun Kim

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

[diff] [blame]

899

{ # Represents an Operation resource.

900

#

Dan O'Meara

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

[diff] [blame]

901

# Google Compute Engine has three Operation resources:

902

#

903

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

904

#

Bu Sun Kim

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

[diff] [blame]

905

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

906

#

907

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

908

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

909

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

910

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

Bu Sun Kim

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

[diff] [blame]

911

#

Dan O'Meara

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

[diff] [blame]

912

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

913

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

914

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

915

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

916

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

917

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

918

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

919

{

Bu Sun Kim

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

[diff] [blame]

920

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

921

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

922

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

923

},

924

],

925

},

Bu Sun Kim

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

[diff] [blame]

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

937

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

938

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

939

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

940

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

941

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

942

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

943

{

944

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

945

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

946

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

947

{

948

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

949

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

950

},

951

],

952

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

953

},

954

],

955

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

960

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

961

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

962

963

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

964

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

965

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

966

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]

967

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

968

The object takes the form of:

969

970

{

Bu Sun Kim

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

[diff] [blame]

971

"target": "A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

972

}

973

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

974

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

Bu Sun Kim

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

[diff] [blame]

975

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.

976

977

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.

978

979

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

980

981

Returns:

982

An object of the form:

983

Bu Sun Kim

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

[diff] [blame]

984

{ # Represents an Operation resource.

985

#

Dan O'Meara

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

[diff] [blame]

986

# Google Compute Engine has three Operation resources:

987

#

988

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

989

#

Bu Sun Kim

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

[diff] [blame]

990

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

991

#

992

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

993

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

994

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

995

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

Bu Sun Kim

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

[diff] [blame]

996

#

Dan O'Meara

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

[diff] [blame]

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1004

{

Bu Sun Kim

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

[diff] [blame]

1005

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

1006

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

1007

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1008

},

1009

],

1010

},

Bu Sun Kim