Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 85c2c6d80859c466d29946e66ccd6a1c3a2df748 / . / docs / dyn / appengine_v1beta4.apps.modules.html
blob: 70dbc030377104a3919480acb044d1d2a5700de1 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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_v1beta4.html">Google App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.modules.html">modules</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="appengine_v1beta4.apps.modules.versions.html">versions()</a></code>
79</p>
80<p class="firstline">Returns the versions Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#delete">delete(appsId, modulesId, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]84<p class="firstline">Deletes the specified module and all enclosed versions.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="toc_element">
86 <code><a href="#get">get(appsId, modulesId, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]87<p class="firstline">Gets the current configuration of the specified module.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Lists all the modules in the application.</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<p class="toc_element">
95 <code><a href="#patch">patch(appsId, modulesId, body, migrateTraffic=None, mask=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Updates the configuration of the specified module.</p>
97<h3>Method Details</h3>
98<div class="method">
99 <code class="details" id="delete">delete(appsId, modulesId, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100 <pre>Deletes the specified module and all enclosed versions.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101
102Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
105 x__xgafv: string, V1 error format.
106
107Returns:
108 An object of the form:
109
110 { # This resource represents a long-running operation that is the result of a network API call.
111 "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]112 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]114 "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 needs # Overview The `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 mapping The `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 uses The 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.
115 "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.
116 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]117 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
118 {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]119 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120 },
121 ],
122 },
123 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]124 "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`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]126 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]127 },
128 }</pre>
129</div>
130
131<div class="method">
132 <code class="details" id="get">get(appsId, modulesId, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]133 <pre>Gets the current configuration of the specified module.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]134
135Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]136 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]137 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
138 x__xgafv: string, V1 error format.
139
140Returns:
141 An object of the form:
142
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]143 { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
144 "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
145 "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
146 "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]147 "a_key": 3.14,
148 },
149 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]150 "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
151 "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
157 <pre>Lists all the modules in the application.
158
159Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]161 pageSize: integer, Maximum results to return per page.
162 pageToken: string, Continuation token for fetching the next page of results.
163 x__xgafv: string, V1 error format.
164
165Returns:
166 An object of the form:
167
168 { # Response message for `Modules.ListModules`.
169 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
170 "modules": [ # The modules belonging to the requested application.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]171 { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
172 "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
173 "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
174 "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 "a_key": 3.14,
176 },
177 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
179 "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 },
181 ],
182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
187 <pre>Retrieves the next page of results.
188
189Args:
190 previous_request: The request for the previous page. (required)
191 previous_response: The response from the request for the previous page. (required)
192
193Returns:
194 A request object that you can call 'execute()' on to request the next
195 page. Returns None if there are no more items in the collection.
196 </pre>
197</div>
198
199<div class="method">
200 <code class="details" id="patch">patch(appsId, modulesId, body, migrateTraffic=None, mask=None, x__xgafv=None)</code>
201 <pre>Updates the configuration of the specified module.
202
203Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]204 appsId: string, Part of `name`. Name of the resource to update. Example: `apps/myapp/modules/default`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]205 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
206 body: object, The request body. (required)
207 The object takes the form of:
208
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]209{ # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.
210 "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module.
211 "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
212 "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213 "a_key": 3.14,
214 },
215 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]216 "name": "A String", # Full path to the Module resource in the API. Example: `apps/myapp/modules/default`. @OutputOnly
217 "id": "A String", # Relative name of the module within the application. Example: `default`. @OutputOnly
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]218 }
219
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]220 migrateTraffic: boolean, Set to `true` to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both [warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see [Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]221 mask: string, Standard field mask for the set of fields to be updated.
222 x__xgafv: string, V1 error format.
223
224Returns:
225 An object of the form:
226
227 { # This resource represents a long-running operation that is the result of a network API call.
228 "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]229 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]230 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]231 "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 needs # Overview The `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 mapping The `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 uses The 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.
232 "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.
233 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]234 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
235 {
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]236 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]237 },
238 ],
239 },
240 "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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]241 "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`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]242 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]243 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]244 },
245 }</pre>
246</div>
247
248</body></html>