Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e833b79ffee531ae64e11175718bb2fffc504950 / . / docs / dyn / appengine_v1.apps.html
blob: 70aba840e632f92216ceada24e25804774824f65 [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
75<h1><a href="appengine_v1.html">Google App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="appengine_v1.apps.locations.html">locations()</a></code>
79</p>
80<p class="firstline">Returns the locations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="appengine_v1.apps.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
88 <code><a href="appengine_v1.apps.services.html">services()</a></code>
89</p>
90<p class="firstline">Returns the services Resource.</p>
91
92<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]93 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]94<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>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]95<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]96 <code><a href="#get">get(appsId, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets information about an application.</p>
98<p class="toc_element">
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]99 <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^]100<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>
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]101<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]102 <code><a href="#repair">repair(appsId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]103<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>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]104<h3>Method Details</h3>
105<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]106 <code class="details" id="create">create(body, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]107 <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/).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]108
109Args:
110 body: object, The request body. (required)
111 The object takes the form of:
112
113{ # An Application resource contains the top-level configuration of an App Engine application.
114 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
115 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]116 "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]117 "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
118 "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^]119 "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
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]120 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]121 "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]122 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
123 "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
124 },
125 ],
126 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]127 "servingStatus": "A String", # Serving status of this application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]128 "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 Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]129 "iap": { # Identity-Aware Proxy
130 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
131 "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.
132 "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
133 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
134 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]135 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
136 "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.
137 }
138
139 x__xgafv: string, V1 error format.
140
141Returns:
142 An object of the form:
143
144 { # This resource represents a long-running operation that is the result of a network API call.
145 "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.
146 "a_key": "", # Properties of the object. Contains field @type with type URL.
147 },
148 "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.
149 "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.
150 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
151 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
152 {
153 "a_key": "", # Properties of the object. Contains field @type with type URL.
154 },
155 ],
156 },
157 "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.
158 "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.
159 "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.
160 "a_key": "", # Properties of the object. Contains field @type with type URL.
161 },
162 }</pre>
163</div>
164
165<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]166 <code class="details" id="get">get(appsId, x__xgafv=None)</code>
167 <pre>Gets information about an application.
168
169Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]170 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]171 x__xgafv: string, V1 error format.
172
173Returns:
174 An object of the form:
175
176 { # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]177 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
178 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]179 "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]180 "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
181 "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^]182 "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
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]183 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]184 "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]185 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
186 "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]187 },
188 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]189 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]190 "servingStatus": "A String", # Serving status of this application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]191 "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 Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]192 "iap": { # Identity-Aware Proxy
193 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
194 "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.
195 "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
196 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
197 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]198 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
199 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="patch">patch(appsId, body, updateMask=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]205 <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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]206
207Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]208 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]209 body: object, The request body. (required)
210 The object takes the form of:
211
212{ # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]213 "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
214 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]215 "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]216 "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
217 "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^]218 "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
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]219 { # Rules to match an HTTP request and dispatch that request to a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]220 "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]221 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
222 "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]223 },
224 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]225 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]226 "servingStatus": "A String", # Serving status of this application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]227 "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 Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]228 "iap": { # Identity-Aware Proxy
229 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
230 "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.
231 "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
232 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
233 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]234 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
235 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]236 }
237
238 updateMask: string, Standard field mask for the set of fields to be updated.
239 x__xgafv: string, V1 error format.
240
241Returns:
242 An object of the form:
243
244 { # This resource represents a long-running operation that is the result of a network API call.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]245 "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]246 "a_key": "", # Properties of the object. Contains field @type with type URL.
247 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]248 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]249 "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.
250 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
251 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
252 {
253 "a_key": "", # Properties of the object. Contains field @type with type URL.
254 },
255 ],
256 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]257 "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.
258 "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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]259 "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.
260 "a_key": "", # Properties of the object. Contains field @type with type URL.
261 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]262 }</pre>
263</div>
264
265<div class="method">
266 <code class="details" id="repair">repair(appsId, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]267 <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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]268
269Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]270 appsId: string, Part of `name`. Name of the application to repair. Example: apps/myapp (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]271 body: object, The request body. (required)
272 The object takes the form of:
273
274{ # Request message for 'Applications.RepairApplication'.
275 }
276
277 x__xgafv: string, V1 error format.
278
279Returns:
280 An object of the form:
281
282 { # This resource represents a long-running operation that is the result of a network API call.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]283 "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]284 "a_key": "", # Properties of the object. Contains field @type with type URL.
285 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]286 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]287 "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.
288 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
289 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
290 {
291 "a_key": "", # Properties of the object. Contains field @type with type URL.
292 },
293 ],
294 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]295 "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.
296 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]297 "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.
298 "a_key": "", # Properties of the object. Contains field @type with type URL.
299 },
300 }</pre>
301</div>
302
303</body></html>