Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / appengine_v1beta5.apps.html
blob: e0b38033f2771a22ae7874b5d534e23361136c5e [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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_v1beta5.html">Google App Engine Admin API</a> . <a href="appengine_v1beta5.apps.html">apps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]78 <code><a href="appengine_v1beta5.apps.locations.html">locations()</a></code>
79</p>
80<p class="firstline">Returns the locations Resource.</p>
81
82<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]83 <code><a href="appengine_v1beta5.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_v1beta5.apps.services.html">services()</a></code>
89</p>
90<p class="firstline">Returns the services Resource.</p>
91
92<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]95<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]96 <code><a href="#get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</a></code></p>
97<p class="firstline">Gets information about an application.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#patch">patch(appsId, body, mask=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]100<p class="firstline">Updates the specified Application resource. You can update the following fields: auth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain) default_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103 <code class="details" id="create">create(body, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]104 <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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]105
106Args:
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{ # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]111 "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine.@OutputOnly
112 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
113 "codeBucket": "A String", # A 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
114 "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly
115 "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116 { # Rules to match an HTTP request and dispatch that request to a service.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]117 "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.
118 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
119 "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]120 },
121 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]122 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]123 "iap": { # Identity-Aware Proxy
124 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
125 "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.
126 "oauth2ClientSecret": "A String", # 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
127 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
128 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]129 "location": "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
130 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
131 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]132 }
133
134 x__xgafv: string, V1 error format.
135
136Returns:
137 An object of the form:
138
139 { # 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]140 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]141 "a_key": "", # Properties of the object. Contains field @type with type URL.
142 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]143 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]144 "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.
145 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
146 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
147 {
148 "a_key": "", # Properties of the object. Contains field @type with type URL.
149 },
150 ],
151 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]152 "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.
153 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]154 "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.
155 "a_key": "", # Properties of the object. Contains field @type with type URL.
156 },
157 }</pre>
158</div>
159
160<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]161 <code class="details" id="get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</code>
162 <pre>Gets information about an application.
163
164Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]165 appsId: string, Part of `name`. Name of the application to get. Example: apps/myapp. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]166 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]167 ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]168
169Returns:
170 An object of the form:
171
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]172 { # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]173 "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine.@OutputOnly
174 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
175 "codeBucket": "A String", # A 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
176 "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly
177 "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 { # Rules to match an HTTP request and dispatch that request to a service.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]179 "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.
180 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
181 "service": "A String", # Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]182 },
183 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]184 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]185 "iap": { # Identity-Aware Proxy
186 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
187 "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.
188 "oauth2ClientSecret": "A String", # 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
189 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
190 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]191 "location": "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
192 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
193 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]194 }</pre>
195</div>
196
197<div class="method">
198 <code class="details" id="patch">patch(appsId, body, mask=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]199 <pre>Updates the specified Application resource. You can update the following fields: auth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain) default_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]200
201Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]202 appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]203 body: object, The request body. (required)
204 The object takes the form of:
205
206{ # An Application resource contains the top-level configuration of an App Engine application.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]207 "defaultHostname": "A String", # Hostname used to reach the application, as resolved by App Engine.@OutputOnly
208 "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
209 "codeBucket": "A String", # A 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
210 "defaultBucket": "A String", # A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly
211 "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]212 { # Rules to match an HTTP request and dispatch that request to a service.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]213 "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.
214 "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
215 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]216 },
217 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]218 "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]219 "iap": { # Identity-Aware Proxy
220 "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
221 "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.
222 "oauth2ClientSecret": "A String", # 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
223 "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
224 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]225 "location": "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
226 "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
227 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]228 }
229
230 mask: string, Standard field mask for the set of fields to be updated.
231 x__xgafv: string, V1 error format.
232
233Returns:
234 An object of the form:
235
236 { # 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]237 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]238 "a_key": "", # Properties of the object. Contains field @type with type URL.
239 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]240 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]241 "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.
242 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
243 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
244 {
245 "a_key": "", # Properties of the object. Contains field @type with type URL.
246 },
247 ],
248 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]249 "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.
250 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]251 "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.
252 "a_key": "", # Properties of the object. Contains field @type with type URL.
253 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]254 }</pre>
255</div>
256
257</body></html>