Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 25fba648ea647b62f2a6edc54ae927c1ed381b45 / . / docs / dyn / appengine_v1.apps.services.html
blob: b84298cd0bb50018729a1cd10ebab53d89a964e2 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]86 <code><a href="#delete">delete(appsId, servicesId, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes the specified service and all enclosed versions.</p>
88<p class="toc_element">
89 <code><a href="#get">get(appsId, servicesId, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets the current configuration of the specified service.</p>
91<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 <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]93<p class="firstline">Lists all the services in the application.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]98 <code><a href="#patch">patch(appsId, servicesId, body=None, updateMask=None, migrateTraffic=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]99<p class="firstline">Updates the configuration of the specified service.</p>
100<h3>Method Details</h3>
101<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102 <code class="details" id="close">close()</code>
103 <pre>Close httplib2 connections.</pre>
104</div>
105
106<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]107 <code class="details" id="delete">delete(appsId, servicesId, x__xgafv=None)</code>
108 <pre>Deletes the specified service and all enclosed versions.
109
110Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]111 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]112 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
113 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]117
118Returns:
119 An object of the form:
120
121 { # 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]122 &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.
123 &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]124 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &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]126 },
127 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
129 &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.
130 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 &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.
133 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
134 },
135 &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}.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]136 &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.
137 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
138 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]139 }</pre>
140</div>
141
142<div class="method">
143 <code class="details" id="get">get(appsId, servicesId, x__xgafv=None)</code>
144 <pre>Gets the current configuration of the specified service.
145
146Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]147 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]148 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
149 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]153
154Returns:
155 An object of the form:
156
157 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]158 &quot;networkSettings&quot;: { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
159 &quot;ingressTrafficAllowed&quot;: &quot;A String&quot;, # The ingress settings for version or service.
160 },
161 &quot;name&quot;: &quot;A String&quot;, # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
162 &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.
163 &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.
164 &quot;a_key&quot;: 3.14,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]166 &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.
167 },
168 &quot;id&quot;: &quot;A String&quot;, # Relative name of the service within the application. Example: default.@OutputOnly
169 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]170</div>
171
172<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 <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]174 <pre>Lists all the services in the application.
175
176Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]177 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]178 pageToken: string, Continuation token for fetching the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 pageSize: integer, Maximum results to return per page.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]180 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]184
185Returns:
186 An object of the form:
187
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]188 { # Response message for Services.ListServices.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 &quot;services&quot;: [ # The services belonging to the requested application.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]191 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]192 &quot;networkSettings&quot;: { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
193 &quot;ingressTrafficAllowed&quot;: &quot;A String&quot;, # The ingress settings for version or service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]194 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]195 &quot;name&quot;: &quot;A String&quot;, # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
196 &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.
197 &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.
198 &quot;a_key&quot;: 3.14,
199 },
200 &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.
201 },
202 &quot;id&quot;: &quot;A String&quot;, # Relative name of the service within the application. Example: default.@OutputOnly
203 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]204 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]205 }</pre>
206</div>
207
208<div class="method">
209 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
210 <pre>Retrieves the next page of results.
211
212Args:
213 previous_request: The request for the previous page. (required)
214 previous_response: The response from the request for the previous page. (required)
215
216Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 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]218 page. Returns None if there are no more items in the collection.
219 </pre>
220</div>
221
222<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]223 <code class="details" id="patch">patch(appsId, servicesId, body=None, updateMask=None, migrateTraffic=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]224 <pre>Updates the configuration of the specified service.
225
226Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]227 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]228 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]229 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]230 The object takes the form of:
231
232{ # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]233 &quot;networkSettings&quot;: { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
234 &quot;ingressTrafficAllowed&quot;: &quot;A String&quot;, # The ingress settings for version or service.
235 },
236 &quot;name&quot;: &quot;A String&quot;, # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
237 &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.
238 &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.
239 &quot;a_key&quot;: 3.14,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]240 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]241 &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.
242 },
243 &quot;id&quot;: &quot;A String&quot;, # Relative name of the service within the application. Example: default.@OutputOnly
244}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]245
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]246 updateMask: string, Standard field mask for the set of fields to be updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]247 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]248 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]252
253Returns:
254 An object of the form:
255
256 { # 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]257 &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.
258 &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]259 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260 &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]261 },
262 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
264 &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.
265 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]266 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]267 &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.
268 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
269 },
270 &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}.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]271 &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.
272 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
273 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]274 }</pre>
275</div>
276
277</body></html>