Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e833b79ffee531ae64e11175718bb2fffc504950 / . / docs / dyn / appengine_v1beta.apps.html
blob: c9433e37926728774d76f66bb47335db9c9a56b4 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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_v1beta.html">Google App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]78 <code><a href="appengine_v1beta.apps.authorizedCertificates.html">authorizedCertificates()</a></code>
79</p>
80<p class="firstline">Returns the authorizedCertificates Resource.</p>
81
82<p class="toc_element">
83 <code><a href="appengine_v1beta.apps.authorizedDomains.html">authorizedDomains()</a></code>
84</p>
85<p class="firstline">Returns the authorizedDomains Resource.</p>
86
87<p class="toc_element">
88 <code><a href="appengine_v1beta.apps.domainMappings.html">domainMappings()</a></code>
89</p>
90<p class="firstline">Returns the domainMappings Resource.</p>
91
92<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93 <code><a href="appengine_v1beta.apps.locations.html">locations()</a></code>
94</p>
95<p class="firstline">Returns the locations Resource.</p>
96
97<p class="toc_element">
98 <code><a href="appengine_v1beta.apps.operations.html">operations()</a></code>
99</p>
100<p class="firstline">Returns the operations Resource.</p>
101
102<p class="toc_element">
103 <code><a href="appengine_v1beta.apps.services.html">services()</a></code>
104</p>
105<p class="firstline">Returns the services Resource.</p>
106
107<p class="toc_element">
108 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]109<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110<p class="toc_element">
111 <code><a href="#get">get(appsId, x__xgafv=None)</a></code></p>
112<p class="firstline">Gets information about an application.</p>
113<p class="toc_element">
114 <code><a href="#patch">patch(appsId, body, updateMask=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]115<p class="firstline">Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]116<p class="toc_element">
117 <code><a href="#repair">repair(appsId, body, x__xgafv=None)</a></code></p>
118<p class="firstline">Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.</p>
119<h3>Method Details</h3>
120<div class="method">
121 <code class="details" id="create">create(body, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]122 <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]123
124Args:
125 body: object, The request body. (required)
126 The object takes the form of:
127
128{ # An Application resource contains the top-level configuration of an App Engine application.
129 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
130 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
131 "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
132 "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
133 "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]134 "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]135 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]136 "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
138 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
139 },
140 ],
141 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
142 "servingStatus": "A String", # Serving status of this application.
143 "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]144 "iap": { # Identity-Aware Proxy
145 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
146 "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
147 "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
148 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
149 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]150 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
151 "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]152 }
153
154 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155
156Returns:
157 An object of the form:
158
159 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]160 "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.
161 "a_key": "", # Properties of the object. Contains field @type with type URL.
162 },
163 "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: Simple to use and understand for most users 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 which 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: 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. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. 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. 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. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]164 "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.
165 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
166 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
167 {
168 "a_key": "", # Properties of the object. Contains field @type with type URL.
169 },
170 ],
171 },
172 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]173 "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.
174 "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.
175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="get">get(appsId, x__xgafv=None)</code>
182 <pre>Gets information about an application.
183
184Args:
185 appsId: string, Part of `name`. Name of the Application resource to get. Example: apps/myapp. (required)
186 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187
188Returns:
189 An object of the form:
190
191 { # An Application resource contains the top-level configuration of an App Engine application.
192 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
193 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
194 "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
195 "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
196 "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]197 "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]198 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]199 "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]200 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
201 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
202 },
203 ],
204 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
205 "servingStatus": "A String", # Serving status of this application.
206 "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]207 "iap": { # Identity-Aware Proxy
208 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
209 "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
210 "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
211 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
212 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]213 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
214 "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="patch">patch(appsId, body, updateMask=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]220 <pre>Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]221
222Args:
223 appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required)
224 body: object, The request body. (required)
225 The object takes the form of:
226
227{ # An Application resource contains the top-level configuration of an App Engine application.
228 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
229 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
230 "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
231 "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
232 "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]233 "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]234 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]235 "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]236 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
237 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
238 },
239 ],
240 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
241 "servingStatus": "A String", # Serving status of this application.
242 "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]243 "iap": { # Identity-Aware Proxy
244 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
245 "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
246 "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
247 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
248 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]249 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
250 "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]251 }
252
253 updateMask: string, Standard field mask for the set of fields to be updated.
254 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]255
256Returns:
257 An object of the form:
258
259 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]260 "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.
261 "a_key": "", # Properties of the object. Contains field @type with type URL.
262 },
263 "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: Simple to use and understand for most users 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 which 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: 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. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. 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. 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. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]264 "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.
265 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
266 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
267 {
268 "a_key": "", # Properties of the object. Contains field @type with type URL.
269 },
270 ],
271 },
272 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]273 "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.
274 "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.
275 "a_key": "", # Properties of the object. Contains field @type with type URL.
276 },
277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="repair">repair(appsId, body, x__xgafv=None)</code>
282 <pre>Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.
283
284Args:
285 appsId: string, Part of `name`. Name of the application to repair. Example: apps/myapp (required)
286 body: object, The request body. (required)
287 The object takes the form of:
288
289{ # Request message for 'Applications.RepairApplication'.
290 }
291
292 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]293
294Returns:
295 An object of the form:
296
297 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]298 "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.
299 "a_key": "", # Properties of the object. Contains field @type with type URL.
300 },
301 "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: Simple to use and understand for most users 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 which 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: 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. Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose. 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. 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. Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]302 "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.
303 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
304 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
305 {
306 "a_key": "", # Properties of the object. Contains field @type with type URL.
307 },
308 ],
309 },
310 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]311 "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.
312 "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.
313 "a_key": "", # Properties of the object. Contains field @type with type URL.
314 },
315 }</pre>
316</div>
317
318</body></html>