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

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

[diff] [blame]

95

<h3>Method Details</h3>

96

Dmitry Frenkel

3e17f89

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

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

102

<code class="details" id="delete">delete(project, zone, operation)</code>

103

<pre>Deletes the specified zone-specific Operations resource.

Jon Wayne Parrott

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

[diff] [blame]

104

105

Args:

Sai Cheemalapati

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

[diff] [blame]

106

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

107

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

108

operation: string, Name of the Operations resource to delete. (required)

</pre>

</div>

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

114

<pre>Retrieves the specified zone-specific Operations resource.

115

116

Args:

117

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

118

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

119

operation: string, Name of the Operations resource to return. (required)

Jon Wayne Parrott

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

[diff] [blame]

120

121

Returns:

122

An object of the form:

123

Bu Sun Kim

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

[diff] [blame]

124

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

125

#

126

# Google Compute Engine has three Operation resources:

127

#

128

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

129

#

130

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

131

#

132

# Operations can be global, regional or zonal.

133

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

134

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

135

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

136

#

137

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

138

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

139

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

140

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

141

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

142

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

143

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

Bu Sun Kim

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

[diff] [blame]

144

{

Yoshi Automation Bot

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

[diff] [blame]

145

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

146

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

147

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

Bu Sun Kim

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

[diff] [blame]

148

},

149

],

Yoshi Automation Bot

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

[diff] [blame]

150

},

151

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

152

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

153

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

154

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

155

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

156

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

yoshi-code-bot

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

[diff] [blame]

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

{

171

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

172

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

173

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

174

{

175

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

176

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

177

},

178

],

179

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

180

},

181

],

182

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

183

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

187

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

Sai Cheemalapati

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

[diff] [blame]

188

<pre>Retrieves a list of Operation resources contained within the specified zone.

Jon Wayne Parrott

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

[diff] [blame]

189

190

Args:

Sai Cheemalapati

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

[diff] [blame]

191

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

192

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

Dan O'Meara

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

[diff] [blame]

193

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

Jon Wayne Parrott

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

[diff] [blame]

194

Dan O'Meara

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

[diff] [blame]

195

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

Jon Wayne Parrott

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

[diff] [blame]

196

Dan O'Meara

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

[diff] [blame]

197

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

Jon Wayne Parrott

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

[diff] [blame]

198

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

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

202

203

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.

204

205

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

206

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]

207

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

Jon Wayne Parrott

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

[diff] [blame]

208

209

Returns:

210

An object of the form:

211

Sai Cheemalapati

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

[diff] [blame]

212

{ # Contains a list of Operation resources.

Yoshi Automation Bot

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

[diff] [blame]

213

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

214

"items": [ # [Output Only] A list of Operation resources.

215

{ # Represents an Operation resource.

216

#

217

# Google Compute Engine has three Operation resources:

218

#

219

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

220

#

221

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

222

#

223

# Operations can be global, regional or zonal.

224

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

225

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

226

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

227

#

228

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

229

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

230

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

231

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

232

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

233

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

234

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

Bu Sun Kim

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

[diff] [blame]

235

{

Yoshi Automation Bot

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

[diff] [blame]

236

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

237

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

238

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

Bu Sun Kim

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

[diff] [blame]

239

},

240

],

Jon Wayne Parrott

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

[diff] [blame]

241

},

Yoshi Automation Bot

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

[diff] [blame]

242

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

243

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

244

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

245

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

246

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

247

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

yoshi-code-bot

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

[diff] [blame]

248

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

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

{

Yoshi Automation Bot

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

[diff] [blame]

262

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

263

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

264

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

265

{

266

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

267

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

268

},

269

],

270

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

Bu Sun Kim

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

[diff] [blame]

271

},

272

],

Yoshi Automation Bot

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

[diff] [blame]

273

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

Bu Sun Kim

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

[diff] [blame]

274

},

Yoshi Automation Bot

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

[diff] [blame]

275

],

276

"kind": "compute#operationList", # [Output Only] Type of resource. Always `compute#operations` for Operations resource.

277

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

278

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

279

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

280

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

281

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

282

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

283

{

284

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

285

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

286

},

287

],

288

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

289

},

290

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

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

295

<pre>Retrieves the next page of results.

296

297

Args:

298

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

299

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

300

301

Returns:

Bu Sun Kim

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

[diff] [blame]

302

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

Jon Wayne Parrott

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

[diff] [blame]

303

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

307

308

<code class="details" id="wait">wait(project, zone, operation)</code>

Dan O'Meara

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

[diff] [blame]

309

<pre>Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress.

310

311

This method is called on a best-effort basis. Specifically:

312

- In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds.

313

- If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.

Bu Sun Kim

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

[diff] [blame]

314

315

Args:

316

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

317

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

318

operation: string, Name of the Operations resource to return. (required)

319

320

Returns:

321

An object of the form:

322

323

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

324

#

325

# Google Compute Engine has three Operation resources:

326

#

327

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

328

#

329

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

330

#

331

# Operations can be global, regional or zonal.

332

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

333

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

334

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

335

#

336

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

337

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

338

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

339

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

340

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

341

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

342

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

Bu Sun Kim

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

[diff] [blame]

343

{

Yoshi Automation Bot

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

[diff] [blame]

344

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

345

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

346

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

Bu Sun Kim

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

[diff] [blame]

347

},

348

],

Yoshi Automation Bot

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

[diff] [blame]

349

},

350

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

351

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

352

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

353

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

354

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

355

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

yoshi-code-bot

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

[diff] [blame]

356

"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