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="cloudfunctions_v1beta2.html">Cloud Functions API</a> . <a href="cloudfunctions_v1beta2.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, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p> 82<p class="firstline">Lists operations that match the specified filter in the request. If the</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 "metadata": { # Service-specific metadata associated with the operation. It typically 106 # contains progress information and common metadata such as create time. 107 # Some services might not provide such metadata. Any method that returns a 108 # long-running operation should document the metadata type, if any. 109 "a_key": "", # Properties of the object. Contains field @type with type URL. 110 }, 111 "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. 112 # different programming environments, including REST APIs and RPC APIs. It is 113 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 114 # 115 # - Simple to use and understand for most users 116 # - Flexible enough to meet unexpected needs 117 # 118 # # Overview 119 # 120 # The `Status` message contains three pieces of data: error code, error 121 # message, and error details. The error code should be an enum value of 122 # google.rpc.Code, but it may accept additional error codes if needed. The 123 # error message should be a developer-facing English message that helps 124 # developers *understand* and *resolve* the error. If a localized user-facing 125 # error message is needed, put the localized message in the error details or 126 # localize it in the client. The optional error details may contain arbitrary 127 # information about the error. There is a predefined set of error detail types 128 # in the package `google.rpc` that can be used for common error conditions. 129 # 130 # # Language mapping 131 # 132 # The `Status` message is the logical representation of the error model, but it 133 # is not necessarily the actual wire format. When the `Status` message is 134 # exposed in different client libraries and different wire protocols, it can be 135 # mapped differently. For example, it will likely be mapped to some exceptions 136 # in Java, but more likely mapped to some error codes in C. 137 # 138 # # Other uses 139 # 140 # The error model and the `Status` message can be used in a variety of 141 # environments, either with or without APIs, to provide a 142 # consistent developer experience across different environments. 143 # 144 # Example uses of this error model include: 145 # 146 # - Partial errors. If a service needs to return partial errors to the client, 147 # it may embed the `Status` in the normal response to indicate the partial 148 # errors. 149 # 150 # - Workflow errors. A typical workflow has multiple steps. Each step may 151 # have a `Status` message for error reporting. 152 # 153 # - Batch operations. If a client uses batch request and batch response, the 154 # `Status` message should be used directly inside batch response, one for 155 # each error sub-response. 156 # 157 # - Asynchronous operations. If an API call embeds asynchronous operation 158 # results in its response, the status of those operations should be 159 # represented directly using the `Status` message. 160 # 161 # - Logging. If some API errors are stored in logs, the message `Status` could 162 # be used directly after any stripping needed for security/privacy reasons. 163 "message": "A String", # A developer-facing error message, which should be in English. Any 164 # user-facing error message should be localized and sent in the 165 # google.rpc.Status.details field, or localized by the client. 166 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 167 "details": [ # A list of messages that carry the error details. There is a common set of 168 # message types for APIs to use. 169 { 170 "a_key": "", # Properties of the object. Contains field @type with type URL. 171 }, 172 ], 173 }, 174 "done": True or False, # If the value is `false`, it means the operation is still in progress. 175 # If `true`, the operation is completed, and either `error` or `response` is 176 # available. 177 "response": { # The normal response of the operation in case of success. If the original 178 # method returns no data on success, such as `Delete`, the response is 179 # `google.protobuf.Empty`. If the original method is standard 180 # `Get`/`Create`/`Update`, the response should be the resource. For other 181 # methods, the response should have the type `XxxResponse`, where `Xxx` 182 # is the original method name. For example, if the original method name 183 # is `TakeSnapshot()`, the inferred response type is 184 # `TakeSnapshotResponse`. 185 "a_key": "", # Properties of the object. Contains field @type with type URL. 186 }, 187 "name": "A String", # The server-assigned name, which is only unique within the same service that 188 # originally returns it. If you use the default HTTP mapping, the 189 # `name` should be a resource name ending with `operations/{unique_id}`. 190 }</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code> 195 <pre>Lists operations that match the specified filter in the request. If the 196server doesn't support this method, it returns `UNIMPLEMENTED`. 197 198NOTE: the `name` binding allows API services to override the binding 199to use different resource name schemes, such as `users/*/operations`. To 200override the binding, API services can add a binding such as 201`"/v1/{name=users/*}/operations"` to their service configuration. 202For backwards compatibility, the default name includes the operations 203collection id, however overriding users must ensure the name binding 204is the parent resource, without the operations collection id. 205 206Args: 207 name: string, Must not be set. 208 pageToken: string, The standard list page token. 209 x__xgafv: string, V1 error format. 210 Allowed values 211 1 - v1 error format 212 2 - v2 error format 213 pageSize: integer, The standard list page size. 214 filter: string, Required. A filter for matching the requested operations.<br><br> The supported formats of <b>filter</b> are:<br> To query for specific function: <code>project:*,location:*,function:*</code><br> To query for all of the latest operations for a project: <code>project:*,latest:true</code> 215 216Returns: 217 An object of the form: 218 219 { # The response message for Operations.ListOperations. 220 "nextPageToken": "A String", # The standard List next-page token. 221 "operations": [ # A list of operations that matches the specified filter in the request. 222 { # This resource represents a long-running operation that is the result of a 223 # network API call. 224 "metadata": { # Service-specific metadata associated with the operation. It typically 225 # contains progress information and common metadata such as create time. 226 # Some services might not provide such metadata. Any method that returns a 227 # long-running operation should document the metadata type, if any. 228 "a_key": "", # Properties of the object. Contains field @type with type URL. 229 }, 230 "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. 231 # different programming environments, including REST APIs and RPC APIs. It is 232 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 233 # 234 # - Simple to use and understand for most users 235 # - Flexible enough to meet unexpected needs 236 # 237 # # Overview 238 # 239 # The `Status` message contains three pieces of data: error code, error 240 # message, and error details. The error code should be an enum value of 241 # google.rpc.Code, but it may accept additional error codes if needed. The 242 # error message should be a developer-facing English message that helps 243 # developers *understand* and *resolve* the error. If a localized user-facing 244 # error message is needed, put the localized message in the error details or 245 # localize it in the client. The optional error details may contain arbitrary 246 # information about the error. There is a predefined set of error detail types 247 # in the package `google.rpc` that can be used for common error conditions. 248 # 249 # # Language mapping 250 # 251 # The `Status` message is the logical representation of the error model, but it 252 # is not necessarily the actual wire format. When the `Status` message is 253 # exposed in different client libraries and different wire protocols, it can be 254 # mapped differently. For example, it will likely be mapped to some exceptions 255 # in Java, but more likely mapped to some error codes in C. 256 # 257 # # Other uses 258 # 259 # The error model and the `Status` message can be used in a variety of 260 # environments, either with or without APIs, to provide a 261 # consistent developer experience across different environments. 262 # 263 # Example uses of this error model include: 264 # 265 # - Partial errors. If a service needs to return partial errors to the client, 266 # it may embed the `Status` in the normal response to indicate the partial 267 # errors. 268 # 269 # - Workflow errors. A typical workflow has multiple steps. Each step may 270 # have a `Status` message for error reporting. 271 # 272 # - Batch operations. If a client uses batch request and batch response, the 273 # `Status` message should be used directly inside batch response, one for 274 # each error sub-response. 275 # 276 # - Asynchronous operations. If an API call embeds asynchronous operation 277 # results in its response, the status of those operations should be 278 # represented directly using the `Status` message. 279 # 280 # - Logging. If some API errors are stored in logs, the message `Status` could 281 # be used directly after any stripping needed for security/privacy reasons. 282 "message": "A String", # A developer-facing error message, which should be in English. Any 283 # user-facing error message should be localized and sent in the 284 # google.rpc.Status.details field, or localized by the client. 285 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 286 "details": [ # A list of messages that carry the error details. There is a common set of 287 # message types for APIs to use. 288 { 289 "a_key": "", # Properties of the object. Contains field @type with type URL. 290 }, 291 ], 292 }, 293 "done": True or False, # If the value is `false`, it means the operation is still in progress. 294 # If `true`, the operation is completed, and either `error` or `response` is 295 # available. 296 "response": { # The normal response of the operation in case of success. If the original 297 # method returns no data on success, such as `Delete`, the response is 298 # `google.protobuf.Empty`. If the original method is standard 299 # `Get`/`Create`/`Update`, the response should be the resource. For other 300 # methods, the response should have the type `XxxResponse`, where `Xxx` 301 # is the original method name. For example, if the original method name 302 # is `TakeSnapshot()`, the inferred response type is 303 # `TakeSnapshotResponse`. 304 "a_key": "", # Properties of the object. Contains field @type with type URL. 305 }, 306 "name": "A String", # The server-assigned name, which is only unique within the same service that 307 # originally returns it. If you use the default HTTP mapping, the 308 # `name` should be a resource name ending with `operations/{unique_id}`. 309 }, 310 ], 311 }</pre> 312</div> 313 314<div class="method"> 315 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 316 <pre>Retrieves the next page of results. 317 318Args: 319 previous_request: The request for the previous page. (required) 320 previous_response: The response from the request for the previous page. (required) 321 322Returns: 323 A request object that you can call 'execute()' on to request the next 324 page. Returns None if there are no more items in the collection. 325 </pre> 326</div> 327 328</body></html>