Blame - docs/dyn/compute_beta.globalOperations.html - platform/external/python/google-api-python-client

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

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of all operations.</p>

80

81

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

82

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

83

Dmitry Frenkel

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

[diff] [blame]

84

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

85

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

86

Sai Cheemalapati

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

[diff] [blame]

87

<code><a href="#delete">delete(project, operation)</a></code></p>

88

<p class="firstline">Deletes the specified Operations resource.</p>

89

90

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

Dan O'Meara

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

[diff] [blame]

91

<p class="firstline">Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.</p>

Sai Cheemalapati

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

[diff] [blame]

92

Dmitry Frenkel

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

<p class="firstline">Retrieves a list of Operation resources contained within the specified project.</p>

95

96

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

97

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

Dan O'Meara

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

[diff] [blame]

98

99

<code><a href="#wait">wait(project, operation)</a></code></p>

100

<p class="firstline">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.</p>

Sai Cheemalapati

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

[diff] [blame]

101

<h3>Method Details</h3>

102

Dmitry Frenkel

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

[diff] [blame]

103

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

104

<pre>Retrieves an aggregated list of all operations.

105

106

Args:

107

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

Dan O'Meara

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

[diff] [blame]

108

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]

109

Dan O'Meara

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

[diff] [blame]

110

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]

111

Dan O'Meara

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

[diff] [blame]

112

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]

113

Bu Sun Kim

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

[diff] [blame]

114

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]

115

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]

116

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

117

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

118

119

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.

120

121

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

122

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

Dmitry Frenkel

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

[diff] [blame]

123

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

Sai Cheemalapati

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

[diff] [blame]

124

125

Returns:

126

An object of the form:

127

128

{

Bu Sun Kim

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

[diff] [blame]

129

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

130

"items": { # [Output Only] A map of scoped operation lists.

131

"a_key": { # [Output Only] Name of the scope containing this set of operations.

132

"operations": [ # [Output Only] A list of operations contained in this scope.

Bu Sun Kim

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

[diff] [blame]

133

{ # Represents an Operation resource.

134

#

Dan O'Meara

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

[diff] [blame]

135

# Google Compute Engine has three Operation resources:

136

#

137

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

138

#

Bu Sun Kim

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

[diff] [blame]

139

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

140

#

141

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

142

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

143

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

144

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

Bu Sun Kim

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

[diff] [blame]

145

#

Dan O'Meara

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

152

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

Sai Cheemalapati

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

[diff] [blame]

153

{

Bu Sun Kim

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

[diff] [blame]

154

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

155

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

156

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

Sai Cheemalapati

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

[diff] [blame]

157

},

158

],

159

},

Bu Sun Kim

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

[diff] [blame]

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

{

178

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

179

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

180

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

181

{

182

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

183

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

184

},

185

],

186

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

187

},

188

],

189

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

Sai Cheemalapati

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

[diff] [blame]

190

},

191

],

Bu Sun Kim

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

[diff] [blame]

192

"warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty.

193

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

194

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

195

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

Sai Cheemalapati

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

[diff] [blame]

196

{

Bu Sun Kim

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

[diff] [blame]

197

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

198

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

Sai Cheemalapati

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

[diff] [blame]

199

},

200

],

Bu Sun Kim

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

[diff] [blame]

201

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

Sai Cheemalapati

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

[diff] [blame]

202

},

203

},

204

},

Bu Sun Kim

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

[diff] [blame]

205

"kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations.

206

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

207

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

Dmitry Frenkel

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

[diff] [blame]

208

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

209

"A String",

210

],

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

213

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

214

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

Bu Sun Kim

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

[diff] [blame]

215

{

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

Bu Sun Kim

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

[diff] [blame]

218

},

219

],

Bu Sun Kim

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

[diff] [blame]

220

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

221

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

227

<pre>Retrieves the next page of results.

228

229

Args:

230

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

231

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

232

233

Returns:

Bu Sun Kim

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

[diff] [blame]

234

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

Sai Cheemalapati

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

[diff] [blame]

235

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]

240

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

241

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

245

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

246

<pre>Deletes the specified Operations resource.

247

248

Args:

249

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

250

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

</pre>

</div>

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

Dan O'Meara

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

[diff] [blame]

256

<pre>Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.

Sai Cheemalapati

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

[diff] [blame]

257

258

Args:

259

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

260

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

261

262

Returns:

263

An object of the form:

264

Bu Sun Kim

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

[diff] [blame]

265

{ # Represents an Operation resource.

266

#

Dan O'Meara

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

[diff] [blame]

267

# Google Compute Engine has three Operation resources:

268

#

269

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

270

#

Bu Sun Kim

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

[diff] [blame]

271

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

272

#

273

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

274

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

275

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

276

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

Bu Sun Kim

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

[diff] [blame]

277

#

Dan O'Meara

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

[diff] [blame]

278

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

Bu Sun Kim

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

[diff] [blame]

279

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

280

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

281

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

282

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

283

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

284

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

Sai Cheemalapati

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

[diff] [blame]

285

{

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

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

Sai Cheemalapati

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

[diff] [blame]

289

},

290

],

291

},

Bu Sun Kim

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

[diff] [blame]

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

{

310

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

311

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

312

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

313

{

314

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

315

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

316

},

317

],

318

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

319

},

320

],

321

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

326

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

Sai Cheemalapati

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

[diff] [blame]

327

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

328

329

Args:

330

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

Dan O'Meara

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

[diff] [blame]

331

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]

332

Dan O'Meara

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

[diff] [blame]

333

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]

334

Dan O'Meara

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

[diff] [blame]

335

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]

336

Bu Sun Kim

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

[diff] [blame]

337

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

338

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

339

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

340

341

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.

342

343

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

344

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

Dmitry Frenkel

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

[diff] [blame]

345

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

Sai Cheemalapati

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

[diff] [blame]

346

347

Returns:

348

An object of the form:

349

350

{ # Contains a list of Operation resources.

Bu Sun Kim

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

[diff] [blame]

351

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

352

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

Bu Sun Kim

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

[diff] [blame]

353

{ # Represents an Operation resource.

354

#

Dan O'Meara

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

[diff] [blame]

355

# Google Compute Engine has three Operation resources:

356

#

357

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

358

#

Bu Sun Kim

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

[diff] [blame]

359

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

360

#

361

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

362

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

363

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

364

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

Bu Sun Kim

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

[diff] [blame]

365

#

Dan O'Meara

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

[diff] [blame]

366

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

Bu Sun Kim

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

[diff] [blame]

367

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

368

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

369

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

370

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

371

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

372

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

Sai Cheemalapati

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

[diff] [blame]

373

{

Bu Sun Kim

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

[diff] [blame]

374

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

375

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

376

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

Sai Cheemalapati

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

[diff] [blame]

377

},

378

],

379

},

Bu Sun Kim

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

[diff] [blame]

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

{

398

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

399

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

400

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

401

{

402

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

403

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

404

},

405

],

406

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

407

},

408

],

409

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

Sai Cheemalapati

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

[diff] [blame]

410

},

411

],

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

414

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

415

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

416

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

417

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

418

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

Bu Sun Kim

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

[diff] [blame]

419

{

Bu Sun Kim

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

[diff] [blame]

420

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

421

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

Bu Sun Kim

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

[diff] [blame]

422

},

423

],

Bu Sun Kim

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

[diff] [blame]

424

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

425

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

431

<pre>Retrieves the next page of results.

432

433

Args:

434

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

435

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

436

437

Returns:

Bu Sun Kim

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

[diff] [blame]

438

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

Sai Cheemalapati

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

[diff] [blame]

439

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]

443

444

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

445

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

446

447

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

448

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

449

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

450

451

Args:

452

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

453

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

454

455

Returns:

456

An object of the form:

457

458

{ # Represents an Operation resource.

459

#

460

# Google Compute Engine has three Operation resources:

461

#

462

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

463

#

464

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

465

#

466

# Operations can be global, regional or zonal.

467

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

468

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

469

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

470

#

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

473

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

474

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

475

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

476

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

477

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

Dan O'Meara

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

[diff] [blame]

478

{

Bu Sun Kim

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

[diff] [blame]

479

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

480

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

481

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

Dan O'Meara

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

[diff] [blame]

482

},

483

],

484

},

Bu Sun Kim