1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.operations.html">operations</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#get">get(appsId, operationsId, x__xgafv=None)</a></code></p> 79 <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> 80 <p class="toc_element"> 81 <code><a href="#list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> 82 <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> 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(appsId, operationsId, x__xgafv=None)</code> 89 <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. 90 91 Args: 92 appsId: string, Part of `name`. The name of the operation resource. (required) 93 operationsId: string, Part of `name`. See documentation of `appsId`. (required) 94 x__xgafv: string, V1 error format. 95 Allowed values 96 1 - v1 error format 97 2 - v2 error format 98 99 Returns: 100 An object of the form: 101 102 { # This resource represents a long-running operation that is the result of a network API call. 103 "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). The error model is designed to be: # The error result of the operation in case of failure or cancellation. 104 # Simple to use and understand for most users 105 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 106 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. 107 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 108 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. 109 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. 110 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 111 "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. 112 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 113 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. 114 { 115 "a_key": "", # Properties of the object. Contains field @type with type URL. 116 }, 117 ], 118 }, 119 "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. 120 "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. 121 "a_key": "", # Properties of the object. Contains field @type with type URL. 122 }, 123 "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 have the format of operations/some/unique/name. 124 "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. 125 "a_key": "", # Properties of the object. Contains field @type with type URL. 126 }, 127 }</pre> 128 </div> 129 130 <div class="method"> 131 <code class="details" id="list">list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> 132 <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. 133 134 Args: 135 appsId: string, Part of `name`. The name of the operation's parent resource. (required) 136 pageSize: integer, The standard list page size. 137 filter: string, The standard list filter. 138 pageToken: string, The standard list page token. 139 x__xgafv: string, V1 error format. 140 Allowed values 141 1 - v1 error format 142 2 - v2 error format 143 144 Returns: 145 An object of the form: 146 147 { # The response message for Operations.ListOperations. 148 "nextPageToken": "A String", # The standard List next-page token. 149 "operations": [ # A list of operations that matches the specified filter in the request. 150 { # This resource represents a long-running operation that is the result of a network API call. 151 "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). The error model is designed to be: # The error result of the operation in case of failure or cancellation. 152 # Simple to use and understand for most users 153 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 154 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. 155 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 156 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. 157 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. 158 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 159 "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. 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 common set of 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. If true, the operation is completed, and either error or response is available. 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 "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 have the format of operations/some/unique/name. 172 "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. 173 "a_key": "", # Properties of the object. Contains field @type with type URL. 174 }, 175 }, 176 ], 177 }</pre> 178 </div> 179 180 <div class="method"> 181 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 182 <pre>Retrieves the next page of results. 183 184 Args: 185 previous_request: The request for the previous page. (required) 186 previous_response: The response from the request for the previous page. (required) 187 188 Returns: 189 A request object that you can call 'execute()' on to request the next 190 page. Returns None if there are no more items in the collection. 191 </pre> 192 </div> 193 194 </body></html>
