1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="servicemanagement_v1.html">Google Service Management API</a> . <a href="servicemanagement_v1.operations.html">operations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p> 80<p class="toc_element"> 81 <code><a href="#list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Lists service operations that match the specified filter in the request.</p> 83<p class="toc_element"> 84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 85<p class="firstline">Retrieves the next page of results.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="get">get(name, x__xgafv=None)</code> 89 <pre>Gets the latest state of a long-running operation. Clients can use this 90method to poll the operation result at intervals as recommended by the API 91service. 92 93Args: 94 name: string, The name of the operation resource. (required) 95 x__xgafv: string, V1 error format. 96 Allowed values 97 1 - v1 error format 98 2 - v2 error format 99 100Returns: 101 An object of the form: 102 103 { # This resource represents a long-running operation that is the result of a 104 # network API call. 105 "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. 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 111 # 112 # # Overview 113 # 114 # 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 122 # in the package `google.rpc` that can be used for common error conditions. 123 # 124 # # Language mapping 125 # 126 # 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. 131 # 132 # # Other uses 133 # 134 # 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 145 # have a `Status` message for error reporting. 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 }, 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`. 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 }, 190 }</pre> 191</div> 192 193<div class="method"> 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. 196 197Args: 198 name: string, Not used. 199 pageSize: integer, The maximum number of operations to return. If unspecified, defaults to 20050. 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 213 logical operator. 214 215 Examples: 216 217 * `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")` 221 pageToken: string, The standard list page token. 222 x__xgafv: string, V1 error format. 223 Allowed values 224 1 - v1 error format 225 2 - v2 error format 226 227Returns: 228 An object of the form: 229 230 { # The response message for Operations.ListOperations. 231 "nextPageToken": "A String", # The standard List next-page token. 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. 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 241 # 242 # # Overview 243 # 244 # 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 252 # in the package `google.rpc` that can be used for common error conditions. 253 # 254 # # Language mapping 255 # 256 # 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. 261 # 262 # # Other uses 263 # 264 # 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 275 # have a `Status` message for error reporting. 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. 295 }, 296 ], 297 }, 298 "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`. 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 }, 320 }, 321 ], 322 }</pre> 323</div> 324 325<div class="method"> 326 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 327 <pre>Retrieves the next page of results. 328 329Args: 330 previous_request: The request for the previous page. (required) 331 previous_response: The response from the request for the previous page. (required) 332 333Returns: 334 A request object that you can call 'execute()' on to request the next 335 page. Returns None if there are no more items in the collection. 336 </pre> 337</div> 338 339</body></html>