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

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

[diff] [blame]

85

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

86

87

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

88

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

89

Dmitry Frenkel

3e17f89

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

[diff] [blame]

90

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

91

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

92

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

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

95

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

Sai Cheemalapati

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

[diff] [blame]

98

Dan O'Meara

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

[diff] [blame]

99

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

Sai Cheemalapati

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

[diff] [blame]

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

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

[diff] [blame]

103

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

104

Bu Sun Kim

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

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

107

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

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

116

Dan O'Meara

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

[diff] [blame]

117

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

Sai Cheemalapati

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

[diff] [blame]

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

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

122

<h3>Method Details</h3>

123

Dan O'Meara

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

[diff] [blame]

124

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

Sai Cheemalapati

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

[diff] [blame]

125

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

126

127

Args:

128

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

129

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

130

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

Dan O'Meara

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

[diff] [blame]

131

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

132

The object takes the form of:

133

134

{

Yoshi Automation Bot

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

[diff] [blame]

135

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

136

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

137

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

138

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

139

# - global/httpHealthChecks/health-check

140

"healthCheck": "A String",

141

},

142

],

143

}

Sai Cheemalapati

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

[diff] [blame]

144

Bu Sun Kim

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

[diff] [blame]

145

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

146

147

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

148

149

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

Sai Cheemalapati

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

[diff] [blame]

150

151

Returns:

152

An object of the form:

153

Bu Sun Kim

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

[diff] [blame]

154

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

155

#

156

# Google Compute Engine has three Operation resources:

157

#

158

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

159

#

160

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

161

#

162

# Operations can be global, regional or zonal.

163

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

164

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

165

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

166

#

167

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

168

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

169

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

170

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

171

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

172

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

173

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

Bu Sun Kim

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

[diff] [blame]

174

{

Yoshi Automation Bot

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

[diff] [blame]

175

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

176

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

177

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

Bu Sun Kim

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

[diff] [blame]

178

},

179

],

Yoshi Automation Bot

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

[diff] [blame]

180

},

181

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

182

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

183

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

184

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

185

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

yoshi-code-bot

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

[diff] [blame^]

186

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

187

#

188

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

189

#

190

# Example 1: Pack and unpack a message in C++.

191

#

192

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

193

#

194

# Example 2: Pack and unpack a message in Java.

195

#

196

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

197

#

198

# Example 3: Pack and unpack a message in Python.

199

#

200

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

201

#

202

# Example 4: Pack and unpack a message in Go

203

#

204

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

205

#

206

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

211

#

212

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

213

#

214

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

215

#

216

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

217

#

218

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

219

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

220

#

221

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

222

#

223

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

224

#

225

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

226

#

227

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

228

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

229

},

Yoshi Automation Bot

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

[diff] [blame]

230

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

yoshi-code-bot

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

[diff] [blame^]

231

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

{

245

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

246

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

247

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

248

{

249

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

250

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

251

},

252

],

253

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

254

},

255

],

256

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

257

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

261

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

Sai Cheemalapati

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

[diff] [blame]

262

<pre>Adds an instance to a target pool.

263

264

Args:

265

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

266

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

267

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

Dan O'Meara

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

[diff] [blame]

268

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

269

The object takes the form of:

270

271

{

Yoshi Automation Bot

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

[diff] [blame]

272

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

273

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

274

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

275

# - zones/zone/instances/instance-name

276

{

277

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

278

},

279

],

280

}

Sai Cheemalapati

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

[diff] [blame]

281

Bu Sun Kim

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

[diff] [blame]

282

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.

283

284

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.

285

286

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

Sai Cheemalapati

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

[diff] [blame]

287

288

Returns:

289

An object of the form:

290

Bu Sun Kim

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

[diff] [blame]

291

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

292

#

293

# Google Compute Engine has three Operation resources:

294

#

295

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

296

#

297

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

298

#

299

# Operations can be global, regional or zonal.

300

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

301

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

302

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

303

#

304

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

305

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

306

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

307

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

308

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

309

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

310

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

Bu Sun Kim

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

[diff] [blame]

311

{

Yoshi Automation Bot

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

[diff] [blame]

312

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

313

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

314

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

Bu Sun Kim

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

[diff] [blame]

315

},

316

],

Yoshi Automation Bot

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

[diff] [blame]

317

},

318

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

319

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

320

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

321

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

322

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

yoshi-code-bot

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

[diff] [blame^]

323

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

324

#

325

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

326

#

327

# Example 1: Pack and unpack a message in C++.

328

#

329

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

330

#

331

# Example 2: Pack and unpack a message in Java.

332

#

333

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

334

#

335

# Example 3: Pack and unpack a message in Python.

336

#

337

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

338

#

339

# Example 4: Pack and unpack a message in Go

340

#

341

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

342

#

343

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

348

#

349

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

350

#

351

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

352

#

353

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

354

#

355

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

356

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

357

#

358

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

359

#

360

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

361

#

362

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

363

#

364

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

365

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

366

},

Yoshi Automation Bot

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

[diff] [blame]

367

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

yoshi-code-bot

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

[diff] [blame^]

368

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

{

382

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

383

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

384

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

385

{

386

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

387

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

388

},

389

],

390

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

391

},

392

],

393

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

394

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

398

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

Sai Cheemalapati

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

[diff] [blame]

399

<pre>Retrieves an aggregated list of target pools.

400

401

Args:

402

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

Dan O'Meara

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

[diff] [blame]

403

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

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

[diff] [blame]

404

Dan O'Meara

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

[diff] [blame]

405

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

Sai Cheemalapati

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

[diff] [blame]

406

Dan O'Meara

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

[diff] [blame]

407

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

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

[diff] [blame]

408

Bu Sun Kim

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

[diff] [blame]

409

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]

410

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]

411

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

412

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

413

414

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.

415

416

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

417

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame^]

418

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

419

420

Returns:

421

An object of the form:

422

423

{

Yoshi Automation Bot

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

[diff] [blame]

424

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

425

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

426

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

427

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

428

{ # Represents a Target Pool resource.

429

#

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

#

Yoshi Automation Bot

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

[diff] [blame]

433

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

434

#

435

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

436

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

437

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

438

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

439

#

440

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

441

#

442

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

yoshi-code-bot

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

[diff] [blame^]

443

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

Yoshi Automation Bot

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

[diff] [blame]

444

"A String",

Sai Cheemalapati

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

[diff] [blame]

445

],

Yoshi Automation Bot

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

[diff] [blame]

446

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

447

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

448

"A String",

449

],

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

Bu Sun Kim

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

[diff] [blame]

459

},

460

],

Yoshi Automation Bot

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

[diff] [blame]

461

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

462

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

463

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

464

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

465

{

466

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

467

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

468

},

469

],

470

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

471

},

Bu Sun Kim

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

[diff] [blame]

472

},

Yoshi Automation Bot

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

[diff] [blame]

473

},

474

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

475

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

476

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

477

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

478

"A String",

479

],

480

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

481

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

482

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

483

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

484

{

485

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

486

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

487

},

488

],

489

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

490

},

491

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

496

<pre>Retrieves the next page of results.

497

498

Args:

499

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

500

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

501

502

Returns:

Bu Sun Kim

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

[diff] [blame]

503

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

Sai Cheemalapati

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

[diff] [blame]

504

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]

509

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

510

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

514

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

Sai Cheemalapati

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

[diff] [blame]

515

<pre>Deletes the specified target pool.

516

517

Args:

518

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

519

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

520

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

Bu Sun Kim

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

[diff] [blame]

521

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.

522

523

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.

524

525

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

Sai Cheemalapati

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

[diff] [blame]

526

527

Returns:

528

An object of the form:

529

Bu Sun Kim

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

[diff] [blame]

530

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

531

#

532

# Google Compute Engine has three Operation resources:

533

#

534

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

535

#

536

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

537

#

538

# Operations can be global, regional or zonal.

539

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

540

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

541

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

542

#

543

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

544

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

545

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

546

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

547

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

548

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

549

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

Bu Sun Kim

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

[diff] [blame]

550

{

Yoshi Automation Bot

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

[diff] [blame]

551

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

552

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

553

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

Bu Sun Kim

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

[diff] [blame]

554

},

555

],

Yoshi Automation Bot

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

[diff] [blame]

556

},

557

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

558

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

559

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

560

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

561

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

yoshi-code-bot

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

[diff] [blame^]

562

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

563

#

564

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

565

#

566

# Example 1: Pack and unpack a message in C++.

567

#

568

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

569

#

570

# Example 2: Pack and unpack a message in Java.

571

#

572

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

573

#

574

# Example 3: Pack and unpack a message in Python.

575

#

576

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

577

#

578

# Example 4: Pack and unpack a message in Go

579

#

580

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

581

#

582

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

587

#

588

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

589

#

590

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

591

#

592

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

593

#

594

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

595

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

596

#

597

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

598

#

599

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

600

#

601

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

602

#

603

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

604

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

605

},

Yoshi Automation Bot

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

[diff] [blame]

606

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

yoshi-code-bot

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

[diff] [blame^]

607

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

{

621

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

622

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

623

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

624

{

625

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

626

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

627

},

628

],

629

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

630

},

631

],

632

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

633

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

638

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

Sai Cheemalapati

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

[diff] [blame]

639

640

Args:

641

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

642

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

643

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

644

645

Returns:

646

An object of the form:

647

Dan O'Meara

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

[diff] [blame]

648

{ # Represents a Target Pool resource.

Yoshi Automation Bot

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

[diff] [blame]

649

#

650

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

651

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

Bu Sun Kim

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

[diff] [blame]

652

#

Yoshi Automation Bot

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

[diff] [blame]

653

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

654

#

655

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

656

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

657

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

658

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

659

#

660

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

661

#

662

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

yoshi-code-bot

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

[diff] [blame^]

663

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

Yoshi Automation Bot

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

[diff] [blame]

664

"A String",

665

],

666

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

667

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

668

"A String",

669

],

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

683

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

Sai Cheemalapati

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

[diff] [blame]

684

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

685

686

Args:

687

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

688

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

689

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]

690

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

691

The object takes the form of:

692

693

{

Bu Sun Kim

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

[diff] [blame]

694

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

Sai Cheemalapati

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

[diff] [blame]

}

Returns:

An object of the form:

700

701

{

Yoshi Automation Bot

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

[diff] [blame]

702

"healthStatus": [

703

{

704

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

705

"a_key": "A String",

Sai Cheemalapati

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

[diff] [blame]

706

},

Yoshi Automation Bot

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

[diff] [blame]

707

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

708

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

yoshi-code-bot

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

[diff] [blame^]

709

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

Yoshi Automation Bot

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

[diff] [blame]

710

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

yoshi-code-bot

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

[diff] [blame^]

711

"weight": "A String",

712

"weightError": "A String",

Yoshi Automation Bot

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

[diff] [blame]

713

},

714

],

715

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

716

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

720

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

Sai Cheemalapati

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

[diff] [blame]

721

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

722

723

Args:

724

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

725

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

Dan O'Meara

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

[diff] [blame]

726

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

727

The object takes the form of:

728

Dan O'Meara

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

[diff] [blame]

729

{ # Represents a Target Pool resource.

Bu Sun Kim

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

[diff] [blame]

730

#

731

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

Bu Sun Kim

673ec5c

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

[diff] [blame]

732

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

Dan O'Meara

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

[diff] [blame]

733

#

Bu Sun Kim

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

[diff] [blame]

734

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

735

#

736

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

737

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

738

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

739

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

740

#

741

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

742

#

743

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

yoshi-code-bot

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

[diff] [blame^]

744

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

Bu Sun Kim

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

[diff] [blame]

745

"A String",

746

],

747

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

748

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

749

"A String",

750

],

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

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

759

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

760

}

Sai Cheemalapati

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

[diff] [blame]

761

Bu Sun Kim

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

[diff] [blame]

762

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.

763

764

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.

765

766

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

Sai Cheemalapati

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

[diff] [blame]

767

768

Returns:

769

An object of the form:

770

Bu Sun Kim

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

[diff] [blame]

771

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

772

#

773

# Google Compute Engine has three Operation resources:

774

#

775

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

776

#

777

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

778

#

779

# Operations can be global, regional or zonal.

780

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

781

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

782

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

783

#

784

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

785

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

786

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

787

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

788

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

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

791

{

Yoshi Automation Bot

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

[diff] [blame]

792

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

793

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

794

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

Bu Sun Kim

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

[diff] [blame]

795

},

796

],

Yoshi Automation Bot

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

[diff] [blame]

797

},

798

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

799

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

800

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

801

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

802

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

yoshi-code-bot

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

[diff] [blame^]

803

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

804

#

805

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

806

#

807

# Example 1: Pack and unpack a message in C++.

808

#

809

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

810

#

811

# Example 2: Pack and unpack a message in Java.

812

#

813

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

814

#

815

# Example 3: Pack and unpack a message in Python.

816

#

817

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

818

#

819

# Example 4: Pack and unpack a message in Go

820

#

821

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

822

#

823

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

828

#

829

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

830

#

831

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

832

#

833

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

834

#

835

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

836

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

837

#

838

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

839

#

840

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

841

#

842

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

843

#

844

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

845

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

846

},

Yoshi Automation Bot

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

[diff] [blame]

847

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

yoshi-code-bot

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

[diff] [blame^]

848

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

{

862

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

863

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

864

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

865

{

866

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

867

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

868

},

869

],

870

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

871

},

872

],

873

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

874

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

878

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

Sai Cheemalapati

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

[diff] [blame]

879

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

880

881

Args:

882

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

883

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

Dan O'Meara

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

[diff] [blame]

884

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

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

[diff] [blame]

885

Dan O'Meara

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

[diff] [blame]

886

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

Sai Cheemalapati

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

[diff] [blame]

887

Dan O'Meara

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

[diff] [blame]

888

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

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

[diff] [blame]

889

Bu Sun Kim

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

[diff] [blame]

890

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

891

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

892

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

893

894

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.

895

896

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

897

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame^]

898

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

899

900

Returns:

901

An object of the form:

902

903

{ # Contains a list of TargetPool resources.

Yoshi Automation Bot

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

[diff] [blame]

904

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

905

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

906

{ # Represents a Target Pool resource.

907

#

908

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

909

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

Bu Sun Kim

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

[diff] [blame]

910

#

Yoshi Automation Bot

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

[diff] [blame]

911

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

912

#

913

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

914

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

915

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

916

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

917

#

918

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

919

#

920

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

yoshi-code-bot

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

[diff] [blame^]

921

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

Yoshi Automation Bot

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

[diff] [blame]

922

"A String",

923

],

924

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

925

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

926

"A String",

927

],

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

937

},

938

],

939

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

940

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

941

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

942

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

943

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

944

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

945

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

946

{

947

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

948

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

Bu Sun Kim

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

[diff] [blame]

949

},

Sai Cheemalapati

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

[diff] [blame]

950

],

Yoshi Automation Bot

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

[diff] [blame]

951

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

952

},

953

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

958

<pre>Retrieves the next page of results.

959

960

Args:

961

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

962

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

963

964

Returns:

Bu Sun Kim

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

[diff] [blame]

965

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

Sai Cheemalapati

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

[diff] [blame]

966

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]

971

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

Sai Cheemalapati

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

[diff] [blame]

972

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

973

974

Args:

975

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

976

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

977

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]

978

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

979

The object takes the form of:

980

981

{

Yoshi Automation Bot

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

[diff] [blame]

982

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

983

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

984

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

985

# - global/httpHealthChecks/health-check

986

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

987

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

988

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

Sai Cheemalapati

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

[diff] [blame]

989

# - global/httpHealthChecks/health-check

Yoshi Automation Bot

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

[diff] [blame]

990

"healthCheck": "A String",

991

},

992

],

993

}

Sai Cheemalapati

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

[diff] [blame]

994

Bu Sun Kim

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

[diff] [blame]

995

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.

996

997

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.

998

999

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

Sai Cheemalapati

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

[diff] [blame]

1000

1001

Returns:

1002

An object of the form:

1003

Bu Sun Kim

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

[diff] [blame]

1004

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1005

#

1006

# Google Compute Engine has three Operation resources:

1007

#

1008

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

1009

#

1010

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

1011

#

1012

# Operations can be global, regional or zonal.

1013

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

1014

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

1015

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

1016

#

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

Bu Sun Kim

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

[diff] [blame]

1024

{

Yoshi Automation Bot

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

[diff] [blame]

1025

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

1026

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

1027

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

Bu Sun Kim

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

[diff] [blame]

1028

},

1029

],

Yoshi Automation Bot

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

[diff] [blame]

1030

},

1031

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

1032

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

1033

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

1034

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

1035

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

yoshi-code-bot

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

[diff] [blame^]

1036

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1037

#

1038

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1039

#

1040

# Example 1: Pack and unpack a message in C++.

1041

#

1042

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1043

#

1044

# Example 2: Pack and unpack a message in Java.

1045

#

1046

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1047

#

1048

# Example 3: Pack and unpack a message in Python.

1049

#

1050

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1051

#

1052

# Example 4: Pack and unpack a message in Go

1053

#

1054

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1055

#

1056

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1061

#

1062

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1063

#

1064

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1065

#

1066

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1067

#

1068

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1069

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1070

#

1071

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1072

#

1073

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1074

#

1075

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1076

#

1077

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1078

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1079

},

Yoshi Automation Bot

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

[diff] [blame]

1080

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

yoshi-code-bot

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

[diff] [blame^]

1081

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

1094

{

1095

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

1096

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

1097

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

1098

{

1099

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

1100

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

1101

},

1102

],

1103

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

1104

},

1105

],

1106

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

1107

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1111

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

Sai Cheemalapati

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

[diff] [blame]

1112

<pre>Removes instance URL from a target pool.

1113

1114

Args:

1115

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

1116

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

1117

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

Dan O'Meara

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

[diff] [blame]

1118

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1119

The object takes the form of:

1120

1121

{

Yoshi Automation Bot

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

[diff] [blame]

1122

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

1123

{

1124

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

1125

},

1126

],

1127

}

Sai Cheemalapati

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

[diff] [blame]

1128

Bu Sun Kim

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

[diff] [blame]

1129

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.

1130

1131

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.

1132

1133

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

Sai Cheemalapati

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

[diff] [blame]

1134

1135

Returns:

1136

An object of the form:

1137

Bu Sun Kim

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

[diff] [blame]

1138

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1139

#

1140

# Google Compute Engine has three Operation resources:

1141

#

1142

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

1143

#

1144

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

1145

#

1146

# Operations can be global, regional or zonal.

1147

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

1148

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

1149

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

1150

#

1151

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

1152

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

1153

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

1154

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

1155

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

1156

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

1157

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

Bu Sun Kim

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

[diff] [blame]

1158

{

Yoshi Automation Bot

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

[diff] [blame]

1159

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

1160

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

1161

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

Bu Sun Kim

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

[diff] [blame]

1162

},

1163

],

Yoshi Automation Bot

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

[diff] [blame]

1164

},

1165

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

1166

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

1167

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

1168

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

1169

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

yoshi-code-bot

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

[diff] [blame^]

1170

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1171

#

1172

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1173

#

1174

# Example 1: Pack and unpack a message in C++.

1175

#

1176

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1177

#

1178

# Example 2: Pack and unpack a message in Java.

1179

#

1180

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1181

#

1182

# Example 3: Pack and unpack a message in Python.

1183

#

1184

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1185

#

1186

# Example 4: Pack and unpack a message in Go

1187

#

1188

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1189

#

1190

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1195

#

1196

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1197

#

1198

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1199

#

1200

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1201

#

1202

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1203

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1204

#

1205

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1206

#

1207

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1208

#

1209

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1210

#

1211

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1212

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1213

},

Yoshi Automation Bot

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

[diff] [blame]

1214

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

yoshi-code-bot

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

[diff] [blame^]

1215

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

1216

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

1217

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

1218

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

1219

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

1220

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

1221

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

1222

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

1223

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

1224

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

1225

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

1226

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

1227

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

1228

{

1229

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

1230

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

1231

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

1232

{

1233

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

1234

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

1235

},

1236

],

1237

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

1238

},

1239

],

1240

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

1241

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1245

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

1246

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

Sai Cheemalapati

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

[diff] [blame]

1247

1248

Args:

1249

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

1250

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

1251

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]

1252

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1253

The object takes the form of:

1254

1255

{

Yoshi Automation Bot

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

[diff] [blame]

1256

"target": "A String",

1257

}

Sai Cheemalapati

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

[diff] [blame]

1258

1259

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

Bu Sun Kim

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

[diff] [blame]

1260

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.

1261

1262

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.

1263

1264

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

Sai Cheemalapati

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

[diff] [blame]

1265

1266

Returns:

1267

An object of the form:

1268

Bu Sun Kim

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

[diff] [blame]

1269

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1270

#

1271

# Google Compute Engine has three Operation resources:

1272

#

1273

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

1274

#

1275

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

1276

#

1277

# Operations can be global, regional or zonal.

1278

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

1279

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

1280

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

1281

#

1282

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

1283

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

1284

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

1285

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

1286

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

1287

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

1288

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

Bu Sun Kim

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

[diff] [blame]

1289

{

Yoshi Automation Bot

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

[diff] [blame]

1290

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

1291

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

1292

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

Bu Sun Kim

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

[diff] [blame]

1293

},

1294

],

Yoshi Automation Bot

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

[diff] [blame]

1295

},

1296

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

1297

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

1298

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

1299

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

1300

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

yoshi-code-bot

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

[diff] [blame^]

1301

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1302

#

1303

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1304

#

1305

# Example 1: Pack and unpack a message in C++.

1306

#

1307

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1308

#

1309

# Example 2: Pack and unpack a message in Java.

1310

#

1311

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1312

#

1313

# Example 3: Pack and unpack a message in Python.

1314

#

1315

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1316

#

1317

# Example 4: Pack and unpack a message in Go

1318

#

1319

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1320

#

1321

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1326

#

1327

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1328

#

1329

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1330

#

1331

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1332

#

1333

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1334

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1335

#

1336

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1337

#

1338

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1339

#

1340

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1341

#

1342

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1343

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1344

},

Yoshi Automation Bot

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

[diff] [blame]

1345

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

yoshi-code-bot

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

[diff] [blame^]

1346

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot