Blame - docs/dyn/servicemanagement_v1.operations.html - platform/external/python/google-api-python-client

2016-08-16 12:44:29 -0700

[diff] [blame]

106

# programming environments, including REST APIs and RPC APIs. It is used by

107

# [gRPC](https://github.com/grpc). The error model is designed to be:

108

#

109

# - Simple to use and understand for most users

110

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

115

# and error details. The error code should be an enum value of

116

# google.rpc.Code, but it may accept additional error codes if needed. The

117

# error message should be a developer-facing English message that helps

118

# developers *understand* and *resolve* the error. If a localized user-facing

119

# error message is needed, put the localized message in the error details or

120

# localize it in the client. The optional error details may contain arbitrary

121

# information about the error. There is a predefined set of error detail types

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

122

# in the package `google.rpc` that can be used for common error conditions.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

127

# is not necessarily the actual wire format. When the `Status` message is

128

# exposed in different client libraries and different wire protocols, it can be

129

# mapped differently. For example, it will likely be mapped to some exceptions

130

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

135

# environments, either with or without APIs, to provide a

136

# consistent developer experience across different environments.

137

#

138

# Example uses of this error model include:

139

#

140

# - Partial errors. If a service needs to return partial errors to the client,

141

# it may embed the `Status` in the normal response to indicate the partial

142

# errors.

143

#

144

# - Workflow errors. A typical workflow has multiple steps. Each step may

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

145

# have a `Status` message for error reporting.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

146

#

147

# - Batch operations. If a client uses batch request and batch response, the

148

# `Status` message should be used directly inside batch response, one for

149

# each error sub-response.

150

#

151

# - Asynchronous operations. If an API call embeds asynchronous operation

152

# results in its response, the status of those operations should be

153

# represented directly using the `Status` message.

154

#

155

# - Logging. If some API errors are stored in logs, the message `Status` could

156

# be used directly after any stripping needed for security/privacy reasons.

157

"message": "A String", # A developer-facing error message, which should be in English. Any

158

# user-facing error message should be localized and sent in the

159

# google.rpc.Status.details field, or localized by the client.

160

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

161

"details": [ # A list of messages that carry the error details. There will be a

162

# common set of message types for APIs to use.

163

{

164

"a_key": "", # Properties of the object. Contains field @type with type URL.

165

},

166

],

167

},

Sai Cheemalapati

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

[diff] [blame]

168

"done": True or False, # If the value is `false`, it means the operation is still in progress.

169

# If true, the operation is completed, and either `error` or `response` is

170

# available.

171

"response": { # The normal response of the operation in case of success. If the original

172

# method returns no data on success, such as `Delete`, the response is

173

# `google.protobuf.Empty`. If the original method is standard

174

# `Get`/`Create`/`Update`, the response should be the resource. For other

175

# methods, the response should have the type `XxxResponse`, where `Xxx`

176

# is the original method name. For example, if the original method name

177

# is `TakeSnapshot()`, the inferred response type is

178

# `TakeSnapshotResponse`.

179

"a_key": "", # Properties of the object. Contains field @type with type URL.

180

},

181

"name": "A String", # The server-assigned name, which is only unique within the same service that

182

# originally returns it. If you use the default HTTP mapping, the

183

# `name` should have the format of `operations/some/unique/name`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

184

"metadata": { # Service-specific metadata associated with the operation. It typically

185

# contains progress information and common metadata such as create time.

186

# Some services might not provide such metadata. Any method that returns a

187

# long-running operation should document the metadata type, if any.

188

"a_key": "", # Properties of the object. Contains field @type with type URL.

189

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

193

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

194

<code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>

195

<pre>Lists service operations that match the specified filter in the request.

Sai Cheemalapati

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

[diff] [blame]

196

197

Args:

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

198

name: string, Not used.

199

pageSize: integer, The maximum number of operations to return. If unspecified, defaults to

200

50. The maximum value is 100.

201

filter: string, A string for filtering Operations.

202

The following filter fields are supported:

203

204

* serviceName: Required. Only `=` operator is allowed.

205

* startTime: The time this job was started, in ISO 8601 format.

206

Allowed operators are `>=`, `>`, `<=`, and `<`.

207

* status: Can be `done`, `in_progress`, or `failed`. Allowed

208

operators are `=`, and `!=`.

209

210

Filter expression supports conjunction (AND) and disjunction (OR)

211

logical operators. However, the serviceName restriction must be at the

212

top-level and can only be combined with other restrictions via the AND

logical operator.

Examples:

* `serviceName={some-service}.googleapis.com`

218

* `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"`

219

* `serviceName={some-service}.googleapis.com AND status=done`

220

* `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`

Sai Cheemalapati

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

[diff] [blame]

221

pageToken: string, The standard list page token.

222

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

229

230

{ # The response message for Operations.ListOperations.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

231

"nextPageToken": "A String", # The standard List next-page token.

Sai Cheemalapati

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

[diff] [blame]

232

"operations": [ # A list of operations that matches the specified filter in the request.

233

{ # This resource represents a long-running operation that is the result of a

234

# network API call.

Sai Cheemalapati

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

[diff] [blame]

235

"error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.

236

# programming environments, including REST APIs and RPC APIs. It is used by

237

# [gRPC](https://github.com/grpc). The error model is designed to be:

238

#

239

# - Simple to use and understand for most users

240

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

245

# and error details. The error code should be an enum value of

246

# google.rpc.Code, but it may accept additional error codes if needed. The

247

# error message should be a developer-facing English message that helps

248

# developers *understand* and *resolve* the error. If a localized user-facing

249

# error message is needed, put the localized message in the error details or

250

# localize it in the client. The optional error details may contain arbitrary

251

# information about the error. There is a predefined set of error detail types

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

252

# in the package `google.rpc` that can be used for common error conditions.

Sai Cheemalapati

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

[diff] [blame]

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

257

# is not necessarily the actual wire format. When the `Status` message is

258

# exposed in different client libraries and different wire protocols, it can be

259

# mapped differently. For example, it will likely be mapped to some exceptions

260

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

265

# environments, either with or without APIs, to provide a

266

# consistent developer experience across different environments.

267

#

268

# Example uses of this error model include:

269

#

270

# - Partial errors. If a service needs to return partial errors to the client,

271

# it may embed the `Status` in the normal response to indicate the partial

272

# errors.

273

#

274

# - Workflow errors. A typical workflow has multiple steps. Each step may

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

275

# have a `Status` message for error reporting.

Sai Cheemalapati

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

[diff] [blame]

276

#

277

# - Batch operations. If a client uses batch request and batch response, the

278

# `Status` message should be used directly inside batch response, one for

279

# each error sub-response.

280

#

281

# - Asynchronous operations. If an API call embeds asynchronous operation

282

# results in its response, the status of those operations should be

283

# represented directly using the `Status` message.

284

#

285

# - Logging. If some API errors are stored in logs, the message `Status` could

286

# be used directly after any stripping needed for security/privacy reasons.

287

"message": "A String", # A developer-facing error message, which should be in English. Any

288

# user-facing error message should be localized and sent in the

289

# google.rpc.Status.details field, or localized by the client.

290

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

291

"details": [ # A list of messages that carry the error details. There will be a

292

# common set of message types for APIs to use.

293

{

294

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

299

# If true, the operation is completed, and either `error` or `response` is

300

# available.

301

"response": { # The normal response of the operation in case of success. If the original

302

# method returns no data on success, such as `Delete`, the response is

303

# `google.protobuf.Empty`. If the original method is standard

304

# `Get`/`Create`/`Update`, the response should be the resource. For other

305

# methods, the response should have the type `XxxResponse`, where `Xxx`

306

# is the original method name. For example, if the original method name

307

# is `TakeSnapshot()`, the inferred response type is

308

# `TakeSnapshotResponse`.

309

"a_key": "", # Properties of the object. Contains field @type with type URL.

310

},

311

"name": "A String", # The server-assigned name, which is only unique within the same service that

312

# originally returns it. If you use the default HTTP mapping, the

313

# `name` should have the format of `operations/some/unique/name`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

314

"metadata": { # Service-specific metadata associated with the operation. It typically

315

# contains progress information and common metadata such as create time.

316

# Some services might not provide such metadata. Any method that returns a

317

# long-running operation should document the metadata type, if any.

318

"a_key": "", # Properties of the object. Contains field @type with type URL.

319

},

Sai Cheemalapati