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

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

[diff] [blame]

79

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

John Asmuth

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

[diff] [blame]

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

84

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

Takashi Matsuo

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

[diff] [blame]

85

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

John Asmuth

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

[diff] [blame]

86

87

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

Dan O'Meara

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

[diff] [blame]

88

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

John Asmuth

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

[diff] [blame]

89

Bu Sun Kim

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

[diff] [blame]

90

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

Jon Wayne Parrott

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

[diff] [blame]

91

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

John Asmuth

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

[diff] [blame]

92

93

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

94

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

Dan O'Meara

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

[diff] [blame]

95

96

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

97

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

John Asmuth

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

[diff] [blame]

98

<h3>Method Details</h3>

99

Bu Sun Kim

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

[diff] [blame]

100

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

Jon Wayne Parrott

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

[diff] [blame]

101

<pre>Retrieves an aggregated list of all operations.

John Asmuth

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

[diff] [blame]

102

103

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

104

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

Dan O'Meara

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

[diff] [blame]

105

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

Takashi Matsuo

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

[diff] [blame]

106

Dan O'Meara

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

[diff] [blame]

107

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

Takashi Matsuo

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

[diff] [blame]

108

Dan O'Meara

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

[diff] [blame]

109

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]

110

Bu Sun Kim

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

[diff] [blame]

111

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]

112

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]

113

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

114

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

115

116

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.

117

118

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

119

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.

John Asmuth

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

[diff] [blame]

120

121

Returns:

122

An object of the form:

123

124

{

Bu Sun Kim

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

[diff] [blame]

125

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

126

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

127

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

128

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

Bu Sun Kim

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

[diff] [blame]

129

{ # Represents an Operation resource.

130

#

Dan O'Meara

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

[diff] [blame]

131

# Google Compute Engine has three Operation resources:

132

#

133

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

134

#

Bu Sun Kim

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

[diff] [blame]

135

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

136

#

137

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

138

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

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

#

Dan O'Meara

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

[diff] [blame]

142

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

143

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

144

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

145

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

146

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

147

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

148

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

John Asmuth

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

[diff] [blame]

149

{

Bu Sun Kim

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

[diff] [blame]

150

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

151

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

152

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

John Asmuth

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

[diff] [blame]

153

},

154

],

155

},

Bu Sun Kim

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

[diff] [blame]

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

{

174

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

175

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

176

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

177

{

178

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

179

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

180

},

181

],

182

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

183

},

184

],

185

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

John Asmuth

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

[diff] [blame]

186

},

187

],

Bu Sun Kim

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

[diff] [blame]

188

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

189

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

190

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

191

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

John Asmuth

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

[diff] [blame]

192

{

Bu Sun Kim

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

[diff] [blame]

193

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

194

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

John Asmuth

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

[diff] [blame]

195

},

196

],

Bu Sun Kim

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

[diff] [blame]

197

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

John Asmuth

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

[diff] [blame]

198

},

199

},

200

},

Bu Sun Kim

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

[diff] [blame]

201

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

202

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

203

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

204

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

205

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

206

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

207

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

Bu Sun Kim

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

[diff] [blame]

208

{

Bu Sun Kim

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

[diff] [blame]

209

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

210

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

211

},

212

],

Bu Sun Kim

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

[diff] [blame]

213

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

214

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

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

220

<pre>Retrieves the next page of results.

221

222

Args:

223

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

224

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

225

226

Returns:

Bu Sun Kim

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

[diff] [blame]

227

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

John Asmuth

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

[diff] [blame]

228

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

</pre>

</div>

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

Takashi Matsuo

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

[diff] [blame]

234

<pre>Deletes the specified Operations resource.

John Asmuth

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

[diff] [blame]

235

236

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

237

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

Takashi Matsuo

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

[diff] [blame]

238

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

John Asmuth

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

[diff] [blame]

</pre>

</div>

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

Dan O'Meara

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

[diff] [blame]

244

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

John Asmuth

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

[diff] [blame]

245

246

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

247

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

Takashi Matsuo

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

[diff] [blame]

248

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

John Asmuth

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

[diff] [blame]

249

250

Returns:

251

An object of the form:

252

Bu Sun Kim

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

[diff] [blame]

253

{ # Represents an Operation resource.

254

#

Dan O'Meara

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

[diff] [blame]

255

# Google Compute Engine has three Operation resources:

256

#

257

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

258

#

Bu Sun Kim

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

[diff] [blame]

259

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

260

#

261

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

262

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

263

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

264

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

Bu Sun Kim

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

[diff] [blame]

265

#

Dan O'Meara

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

[diff] [blame]

266

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

267

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

268

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

269

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

270

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

271

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

272

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

John Asmuth

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

[diff] [blame]

273

{

Bu Sun Kim

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

[diff] [blame]

274

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

275

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

276

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

John Asmuth

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

[diff] [blame]

277

},

278

],

279

},

Bu Sun Kim

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

[diff] [blame]

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

{

298

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

299

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

300

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

301

{

302

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

303

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

304

},

305

],

306

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

307

},

308

],

309

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

314

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

Jon Wayne Parrott

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

[diff] [blame]

315

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

John Asmuth

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

[diff] [blame]

316

317

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

318

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

Dan O'Meara

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

[diff] [blame]

319

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

Takashi Matsuo

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

[diff] [blame]

320

Dan O'Meara

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

[diff] [blame]

321

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

Takashi Matsuo

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

[diff] [blame]

322

Dan O'Meara

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

[diff] [blame]

323

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]

324

Bu Sun Kim

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

[diff] [blame]

325

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

326

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

327

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

328

329

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.

330

331

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

332

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.

John Asmuth

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

[diff] [blame]

333

334

Returns:

335

An object of the form:

336

Takashi Matsuo

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

[diff] [blame]

337

{ # Contains a list of Operation resources.

Bu Sun Kim

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

[diff] [blame]

338

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

339

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

Bu Sun Kim

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

[diff] [blame]

340

{ # Represents an Operation resource.

341

#

Dan O'Meara

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

[diff] [blame]

342

# Google Compute Engine has three Operation resources:

343

#

344

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

345

#

Bu Sun Kim

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

[diff] [blame]

346

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

347

#

348

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

349

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

350

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

351

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

Bu Sun Kim

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

[diff] [blame]

352

#

Dan O'Meara

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

[diff] [blame]

353

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

354

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

355

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

356

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

357

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

358

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

359

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

John Asmuth

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

[diff] [blame]

360

{

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

363

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

John Asmuth

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

[diff] [blame]

364

},

365

],

366

},

Bu Sun Kim

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

[diff] [blame]

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

{

385

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

386

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

387

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

388

{

389

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

390

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

391

},

392

],

393

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

394

},

395

],

396

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

John Asmuth

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

[diff] [blame]

397

},

398

],

Bu Sun Kim

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

[diff] [blame]

399

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

400

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

401

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

402

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

403

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

404

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

405

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

Bu Sun Kim

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

[diff] [blame]

406

{

Bu Sun Kim

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

[diff] [blame]

407

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

408

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

409

},

410

],

Bu Sun Kim

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

[diff] [blame]

411

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

412

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

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

418

<pre>Retrieves the next page of results.

419

420

Args:

421

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

422

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

423

424

Returns:

Bu Sun Kim

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

[diff] [blame]

425

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

John Asmuth

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

[diff] [blame]

426

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]

430

431

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

432

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

433

434

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

435

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

436

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

437

438

Args:

439

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

440

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

441

442

Returns:

443

An object of the form:

444

445

{ # Represents an Operation resource.

446

#

447

# Google Compute Engine has three Operation resources:

448

#

449

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

450

#

451

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

452

#

453

# Operations can be global, regional or zonal.

454

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

455

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

456

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

457

#

458

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

459

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

460

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

461

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

462

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

463

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

464

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

Dan O'Meara

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

[diff] [blame]

465

{

Bu Sun Kim

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

[diff] [blame]

466

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

467

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

468

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

Dan O'Meara

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

[diff] [blame]

469

},

470

],

471

},

Bu Sun Kim