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="ml_v1.html">Cloud Machine Learning Engine</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.operations.html">operations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p> 79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p> 83<p class="toc_element"> 84 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p> 85<p class="firstline">Lists operations that match the specified filter in the request. If the</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code> 92 <pre>Starts asynchronous cancellation on a long-running operation. The server 93makes a best effort to cancel the operation, but success is not 94guaranteed. If the server doesn't support this method, it returns 95`google.rpc.Code.UNIMPLEMENTED`. Clients can use 96Operations.GetOperation or 97other methods to check whether the cancellation succeeded or whether the 98operation completed despite cancellation. On successful cancellation, 99the operation is not deleted; instead, it becomes an operation with 100an Operation.error value with a google.rpc.Status.code of 1, 101corresponding to `Code.CANCELLED`. 102 103Args: 104 name: string, The name of the operation resource to be cancelled. (required) 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { # A generic empty message that you can re-use to avoid defining duplicated 114 # empty messages in your APIs. A typical example is to use it as the request 115 # or the response type of an API method. For instance: 116 # 117 # service Foo { 118 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 119 # } 120 # 121 # The JSON representation for `Empty` is empty JSON object `{}`. 122 }</pre> 123</div> 124 125<div class="method"> 126 <code class="details" id="get">get(name, x__xgafv=None)</code> 127 <pre>Gets the latest state of a long-running operation. Clients can use this 128method to poll the operation result at intervals as recommended by the API 129service. 130 131Args: 132 name: string, The name of the operation resource. (required) 133 x__xgafv: string, V1 error format. 134 Allowed values 135 1 - v1 error format 136 2 - v2 error format 137 138Returns: 139 An object of the form: 140 141 { # This resource represents a long-running operation that is the result of a 142 # network API call. 143 "metadata": { # Service-specific metadata associated with the operation. It typically 144 # contains progress information and common metadata such as create time. 145 # Some services might not provide such metadata. Any method that returns a 146 # long-running operation should document the metadata type, if any. 147 "a_key": "", # Properties of the object. Contains field @type with type URL. 148 }, 149 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 150 # different programming environments, including REST APIs and RPC APIs. It is 151 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 152 # three pieces of data: error code, error message, and error details. 153 # 154 # You can find out more about this error model and how to work with it in the 155 # [API Design Guide](https://cloud.google.com/apis/design/errors). 156 "message": "A String", # A developer-facing error message, which should be in English. Any 157 # user-facing error message should be localized and sent in the 158 # google.rpc.Status.details field, or localized by the client. 159 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 160 "details": [ # A list of messages that carry the error details. There is a common set of 161 # message types for APIs to use. 162 { 163 "a_key": "", # Properties of the object. Contains field @type with type URL. 164 }, 165 ], 166 }, 167 "done": True or False, # If the value is `false`, it means the operation is still in progress. 168 # If `true`, the operation is completed, and either `error` or `response` is 169 # available. 170 "response": { # The normal response of the operation in case of success. If the original 171 # method returns no data on success, such as `Delete`, the response is 172 # `google.protobuf.Empty`. If the original method is standard 173 # `Get`/`Create`/`Update`, the response should be the resource. For other 174 # methods, the response should have the type `XxxResponse`, where `Xxx` 175 # is the original method name. For example, if the original method name 176 # is `TakeSnapshot()`, the inferred response type is 177 # `TakeSnapshotResponse`. 178 "a_key": "", # Properties of the object. Contains field @type with type URL. 179 }, 180 "name": "A String", # The server-assigned name, which is only unique within the same service that 181 # originally returns it. If you use the default HTTP mapping, the 182 # `name` should be a resource name ending with `operations/{unique_id}`. 183 }</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code> 188 <pre>Lists operations that match the specified filter in the request. If the 189server doesn't support this method, it returns `UNIMPLEMENTED`. 190 191NOTE: the `name` binding allows API services to override the binding 192to use different resource name schemes, such as `users/*/operations`. To 193override the binding, API services can add a binding such as 194`"/v1/{name=users/*}/operations"` to their service configuration. 195For backwards compatibility, the default name includes the operations 196collection id, however overriding users must ensure the name binding 197is the parent resource, without the operations collection id. 198 199Args: 200 name: string, The name of the operation's parent resource. (required) 201 pageToken: string, The standard list page token. 202 x__xgafv: string, V1 error format. 203 Allowed values 204 1 - v1 error format 205 2 - v2 error format 206 pageSize: integer, The standard list page size. 207 filter: string, The standard list filter. 208 209Returns: 210 An object of the form: 211 212 { # The response message for Operations.ListOperations. 213 "operations": [ # A list of operations that matches the specified filter in the request. 214 { # This resource represents a long-running operation that is the result of a 215 # network API call. 216 "metadata": { # Service-specific metadata associated with the operation. It typically 217 # contains progress information and common metadata such as create time. 218 # Some services might not provide such metadata. Any method that returns a 219 # long-running operation should document the metadata type, if any. 220 "a_key": "", # Properties of the object. Contains field @type with type URL. 221 }, 222 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 223 # different programming environments, including REST APIs and RPC APIs. It is 224 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 225 # three pieces of data: error code, error message, and error details. 226 # 227 # You can find out more about this error model and how to work with it in the 228 # [API Design Guide](https://cloud.google.com/apis/design/errors). 229 "message": "A String", # A developer-facing error message, which should be in English. Any 230 # user-facing error message should be localized and sent in the 231 # google.rpc.Status.details field, or localized by the client. 232 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 233 "details": [ # A list of messages that carry the error details. There is a common set of 234 # message types for APIs to use. 235 { 236 "a_key": "", # Properties of the object. Contains field @type with type URL. 237 }, 238 ], 239 }, 240 "done": True or False, # If the value is `false`, it means the operation is still in progress. 241 # If `true`, the operation is completed, and either `error` or `response` is 242 # available. 243 "response": { # The normal response of the operation in case of success. If the original 244 # method returns no data on success, such as `Delete`, the response is 245 # `google.protobuf.Empty`. If the original method is standard 246 # `Get`/`Create`/`Update`, the response should be the resource. For other 247 # methods, the response should have the type `XxxResponse`, where `Xxx` 248 # is the original method name. For example, if the original method name 249 # is `TakeSnapshot()`, the inferred response type is 250 # `TakeSnapshotResponse`. 251 "a_key": "", # Properties of the object. Contains field @type with type URL. 252 }, 253 "name": "A String", # The server-assigned name, which is only unique within the same service that 254 # originally returns it. If you use the default HTTP mapping, the 255 # `name` should be a resource name ending with `operations/{unique_id}`. 256 }, 257 ], 258 "nextPageToken": "A String", # The standard List next-page token. 259 }</pre> 260</div> 261 262<div class="method"> 263 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 264 <pre>Retrieves the next page of results. 265 266Args: 267 previous_request: The request for the previous page. (required) 268 previous_response: The response from the request for the previous page. (required) 269 270Returns: 271 A request object that you can call 'execute()' on to request the next 272 page. Returns None if there are no more items in the collection. 273 </pre> 274</div> 275 276</body></html>