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="appengine_v1alpha.html">App Engine Admin API</a> . <a href="appengine_v1alpha.projects.html">projects</a> . <a href="appengine_v1alpha.projects.locations.html">locations</a> . <a href="appengine_v1alpha.projects.locations.operations.html">operations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(projectsId, locationsId, operationsId, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</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="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(projectsId, locationsId, operationsId, x__xgafv=None)</code> 97 <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. 98 99Args: 100 projectsId: string, Part of `name`. The name of the operation resource. (required) 101 locationsId: string, Part of `name`. See documentation of `projectsId`. (required) 102 operationsId: string, Part of `name`. See documentation of `projectsId`. (required) 103 x__xgafv: string, V1 error format. 104 Allowed values 105 1 - v1 error format 106 2 - v2 error format 107 108Returns: 109 An object of the form: 110 111 { # This resource represents a long-running operation that is the result of a network API call. 112 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. 113 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 114 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 115 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 116 { 117 "a_key": "", # Properties of the object. Contains field @type with type URL. 118 }, 119 ], 120 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 121 }, 122 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 123 "a_key": "", # Properties of the object. Contains field @type with type URL. 124 }, 125 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. 126 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. 127 "a_key": "", # Properties of the object. Contains field @type with type URL. 128 }, 129}</pre> 130</div> 131 132<div class="method"> 133 <code class="details" id="list">list(projectsId, locationsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 134 <pre>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. 135 136Args: 137 projectsId: string, Part of `name`. The name of the operation's parent resource. (required) 138 locationsId: string, Part of `name`. See documentation of `projectsId`. (required) 139 filter: string, The standard list filter. 140 pageSize: integer, The standard list page size. 141 pageToken: string, The standard list page token. 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # The response message for Operations.ListOperations. 151 "nextPageToken": "A String", # The standard List next-page token. 152 "operations": [ # A list of operations that matches the specified filter in the request. 153 { # This resource represents a long-running operation that is the result of a network API call. 154 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. 155 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 156 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 157 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 158 { 159 "a_key": "", # Properties of the object. Contains field @type with type URL. 160 }, 161 ], 162 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 163 }, 164 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 165 "a_key": "", # Properties of the object. Contains field @type with type URL. 166 }, 167 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. 168 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. 169 "a_key": "", # Properties of the object. Contains field @type with type URL. 170 }, 171 }, 172 ], 173}</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 178 <pre>Retrieves the next page of results. 179 180Args: 181 previous_request: The request for the previous page. (required) 182 previous_response: The response from the request for the previous page. (required) 183 184Returns: 185 A request object that you can call 'execute()' on to request the next 186 page. Returns None if there are no more items in the collection. 187 </pre> 188</div> 189 190</body></html>