Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / appengine_v1.apps.html
blob: 7c777125cad3293e4592f66d36b4d6f1ad49f5e0 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="appengine_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="appengine_v1.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_v1.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_v1.apps.domainMappings.html">domainMappings()</a></code>
89</p>
90<p class="firstline">Returns the domainMappings Resource.</p>
91
92<p class="toc_element">
93 <code><a href="appengine_v1.apps.firewall.html">firewall()</a></code>
94</p>
95<p class="firstline">Returns the firewall Resource.</p>
96
97<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98 <code><a href="appengine_v1.apps.locations.html">locations()</a></code>
99</p>
100<p class="firstline">Returns the locations Resource.</p>
101
102<p class="toc_element">
103 <code><a href="appengine_v1.apps.operations.html">operations()</a></code>
104</p>
105<p class="firstline">Returns the operations Resource.</p>
106
107<p class="toc_element">
108 <code><a href="appengine_v1.apps.services.html">services()</a></code>
109</p>
110<p class="firstline">Returns the services Resource.</p>
111
112<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]114<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields:</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]115<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]116 <code><a href="#get">get(appsId, x__xgafv=None)</a></code></p>
117<p class="firstline">Gets information about an application.</p>
118<p class="toc_element">
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]119 <code><a href="#patch">patch(appsId, body, updateMask=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]120<p class="firstline">Updates the specified Application resource. You can update the following fields:</p>
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]121<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 <code><a href="#repair">repair(appsId, body=None, x__xgafv=None)</a></code></p>
123<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. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]124<h3>Method Details</h3>
125<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]126 <code class="details" id="create">create(body, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]127 <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields:
128id - The ID of the target Cloud Platform project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129location - 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/standard/python/console/).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]130
131Args:
132 body: object, The request body. (required)
133 The object takes the form of:
134
135{ # An Application resource contains the top-level configuration of an App Engine application.
136 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
137 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]139 "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
140 "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]142 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]143 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]144 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
145 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
146 },
147 ],
148 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 "servingStatus": "A String", # Serving status of this application.
150 "locationId": "A String", # Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
151 "featureSettings": { # The feature specific settings to be used in the application. These define behaviors that are user configurable. # The feature specific settings to be used in the application.
152 "useContainerOptimizedOs": True or False, # If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.
153 "splitHealthChecks": True or False, # Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
154 },
155 "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.
156 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]157 "iap": { # Identity-Aware Proxy
158 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
159 "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.
160 "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
161 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
162 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]163 }
164
165 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]169
170Returns:
171 An object of the form:
172
173 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]178 "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.
179 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]181 {
182 "a_key": "", # Properties of the object. Contains field @type with type URL.
183 },
184 ],
185 },
186 "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 Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]187 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]188 "a_key": "", # Properties of the object. Contains field @type with type URL.
189 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 "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}.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]191 }</pre>
192</div>
193
194<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]195 <code class="details" id="get">get(appsId, x__xgafv=None)</code>
196 <pre>Gets information about an application.
197
198Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]199 appsId: string, Part of `name`. Name of the Application resource to get. Example: apps/myapp. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]200 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]204
205Returns:
206 An object of the form:
207
208 { # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]209 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
210 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]212 "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
213 "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]215 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]216 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]217 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
218 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]219 },
220 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]221 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "servingStatus": "A String", # Serving status of this application.
223 "locationId": "A String", # Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
224 "featureSettings": { # The feature specific settings to be used in the application. These define behaviors that are user configurable. # The feature specific settings to be used in the application.
225 "useContainerOptimizedOs": True or False, # If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.
226 "splitHealthChecks": True or False, # Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
227 },
228 "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.
229 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]230 "iap": { # Identity-Aware Proxy
231 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
232 "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.
233 "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
234 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
235 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]236 }</pre>
237</div>
238
239<div class="method">
240 <code class="details" id="patch">patch(appsId, body, updateMask=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]241 <pre>Updates the specified Application resource. You can update the following fields:
242auth_domain - Google authentication domain for controlling user access to the application.
243default_cookie_expiration - Cookie expiration policy for the application.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]244
245Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]246 appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required)
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]247 body: object, The request body. (required)
248 The object takes the form of:
249
250{ # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]251 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
252 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]254 "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
255 "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]257 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]258 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]259 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
260 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]261 },
262 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]263 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 "servingStatus": "A String", # Serving status of this application.
265 "locationId": "A String", # Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
266 "featureSettings": { # The feature specific settings to be used in the application. These define behaviors that are user configurable. # The feature specific settings to be used in the application.
267 "useContainerOptimizedOs": True or False, # If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.
268 "splitHealthChecks": True or False, # Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
269 },
270 "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.
271 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]272 "iap": { # Identity-Aware Proxy
273 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
274 "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.
275 "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
276 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
277 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]278 }
279
280 updateMask: string, Standard field mask for the set of fields to be updated.
281 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]282 Allowed values
283 1 - v1 error format
284 2 - v2 error format
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]285
286Returns:
287 An object of the form:
288
289 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]290 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]291 "a_key": "", # Properties of the object. Contains field @type with type URL.
292 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]294 "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.
295 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]297 {
298 "a_key": "", # Properties of the object. Contains field @type with type URL.
299 },
300 ],
301 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]302 "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 Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]303 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]304 "a_key": "", # Properties of the object. Contains field @type with type URL.
305 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 "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}.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]307 }</pre>
308</div>
309
310<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 <code class="details" id="repair">repair(appsId, body=None, x__xgafv=None)</code>
312 <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. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]313
314Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]315 appsId: string, Part of `name`. Name of the application to repair. Example: apps/myapp (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]317 The object takes the form of:
318
319{ # Request message for 'Applications.RepairApplication'.
320 }
321
322 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]323 Allowed values
324 1 - v1 error format
325 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]326
327Returns:
328 An object of the form:
329
330 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]331 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]332 "a_key": "", # Properties of the object. Contains field @type with type URL.
333 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]335 "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.
336 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]338 {
339 "a_key": "", # Properties of the object. Contains field @type with type URL.
340 },
341 ],
342 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]343 "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 Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]344 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]345 "a_key": "", # Properties of the object. Contains field @type with type URL.
346 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347 "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}.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]348 }</pre>
349</div>
350
351</body></html>