Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / appengine_v1.apps.services.html
blob: c9e59ba82f34c7a8369ec1b053498a2d5a26694e [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> . <a href="appengine_v1.apps.services.html">services</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="appengine_v1.apps.services.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, servicesId, x__xgafv=None)</a></code></p>
84<p class="firstline">Deletes the specified service and all enclosed versions.</p>
85<p class="toc_element">
86 <code><a href="#get">get(appsId, servicesId, x__xgafv=None)</a></code></p>
87<p class="firstline">Gets the current configuration of the specified service.</p>
88<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]89 <code><a href="#list">list(appsId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]90<p class="firstline">Lists all the services 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95 <code><a href="#patch">patch(appsId, servicesId, body=None, migrateTraffic=None, updateMask=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]96<p class="firstline">Updates the configuration of the specified service.</p>
97<h3>Method Details</h3>
98<div class="method">
99 <code class="details" id="delete">delete(appsId, servicesId, x__xgafv=None)</code>
100 <pre>Deletes the specified service and all enclosed versions.
101
102Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]103 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]104 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
105 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]109
110Returns:
111 An object of the form:
112
113 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]114 &quot;done&quot;: 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.
115 &quot;response&quot;: { # 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.
116 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]117 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]118 &quot;name&quot;: &quot;A String&quot;, # 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}.
119 &quot;error&quot;: { # 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.
120 &quot;details&quot;: [ # 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]121 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]122 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]123 },
124 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]125 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
126 &quot;message&quot;: &quot;A String&quot;, # 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.
127 },
128 &quot;metadata&quot;: { # 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.
129 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]130 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="get">get(appsId, servicesId, x__xgafv=None)</code>
136 <pre>Gets the current configuration of the specified service.
137
138Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]139 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]140 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
141 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]145
146Returns:
147 An object of the form:
148
149 { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]150 &quot;split&quot;: { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
151 &quot;shardBy&quot;: &quot;A String&quot;, # 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.
152 &quot;allocations&quot;: { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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.
153 &quot;a_key&quot;: 3.14,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]154 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]155 },
156 &quot;id&quot;: &quot;A String&quot;, # Relative name of the service within the application. Example: default.@OutputOnly
157 &quot;name&quot;: &quot;A String&quot;, # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
158 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]159</div>
160
161<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]162 <code class="details" id="list">list(appsId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]163 <pre>Lists all the services in the application.
164
165Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]166 appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]167 pageToken: string, Continuation token for fetching the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]168 pageSize: integer, Maximum results to return per page.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]169 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]173
174Returns:
175 An object of the form:
176
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]177 { # Response message for Services.ListServices.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]178 &quot;services&quot;: [ # The services belonging to the requested application.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]179 { # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]180 &quot;split&quot;: { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
181 &quot;shardBy&quot;: &quot;A String&quot;, # 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.
182 &quot;allocations&quot;: { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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.
183 &quot;a_key&quot;: 3.14,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]184 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]185 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]186 &quot;id&quot;: &quot;A String&quot;, # Relative name of the service within the application. Example: default.@OutputOnly
187 &quot;name&quot;: &quot;A String&quot;, # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
188 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]189 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]190 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
196 <pre>Retrieves the next page of results.
197
198Args:
199 previous_request: The request for the previous page. (required)
200 previous_response: The response from the request for the previous page. (required)
201
202Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]203 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]204 page. Returns None if there are no more items in the collection.
205 </pre>
206</div>
207
208<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]209 <code class="details" id="patch">patch(appsId, servicesId, body=None, migrateTraffic=None, updateMask=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]210 <pre>Updates the configuration of the specified service.
211
212Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]213 appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]214 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]215 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]216 The object takes the form of:
217
218{ # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]219 &quot;split&quot;: { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
220 &quot;shardBy&quot;: &quot;A String&quot;, # 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.
221 &quot;allocations&quot;: { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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.
222 &quot;a_key&quot;: 3.14,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]223 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]224 },
225 &quot;id&quot;: &quot;A String&quot;, # Relative name of the service within the application. Example: default.@OutputOnly
226 &quot;name&quot;: &quot;A String&quot;, # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
227}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]228
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service 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).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]230 updateMask: string, Standard field mask for the set of fields to be updated.
231 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]235
236Returns:
237 An object of the form:
238
239 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]240 &quot;done&quot;: 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.
241 &quot;response&quot;: { # 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.
242 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]243 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]244 &quot;name&quot;: &quot;A String&quot;, # 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}.
245 &quot;error&quot;: { # 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.
246 &quot;details&quot;: [ # 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]247 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]248 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]249 },
250 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]251 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
252 &quot;message&quot;: &quot;A String&quot;, # 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.
253 },
254 &quot;metadata&quot;: { # 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.
255 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]256 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]257 }</pre>
258</div>
259
260</body></html>