Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / appengine_v1.apps.services.html
blob: 286fc664c6f26a622e5043723f41824f22088040 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="appengine_v1.html">Google App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.services.html">services</a></h1>
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">
89 <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
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">
95 <code><a href="#patch">patch(appsId, servicesId, body, migrateTraffic=None, updateMask=None, x__xgafv=None)</a></code></p>
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]114 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115 "a_key": "", # Properties of the object. Contains field @type with type URL.
116 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]117 "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: # The error result of the operation in case of failure or cancellation.
118 # Simple to use and understand for most users
119 # 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 that 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:
120 # 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.
121 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
122 # 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.
123 # 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.
124 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]125 "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.
126 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
127 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
128 {
129 "a_key": "", # Properties of the object. Contains field @type with type URL.
130 },
131 ],
132 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]133 "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 Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]134 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]135 "a_key": "", # Properties of the object. Contains field @type with type URL.
136 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]137 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]138 }</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="get">get(appsId, servicesId, x__xgafv=None)</code>
143 <pre>Gets the current configuration of the specified service.
144
145Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]146 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]147 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
148 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]152
153Returns:
154 An object of the form:
155
156 { # 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]157 "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
158 "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]159 "split": { # 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.
160 "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.
161 "allocations": { # 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.
162 "a_key": 3.14,
163 },
164 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
170 <pre>Lists all the services in the application.
171
172Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]173 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]174 pageSize: integer, Maximum results to return per page.
175 pageToken: string, Continuation token for fetching the next page of results.
176 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]177 Allowed values
178 1 - v1 error format
179 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]180
181Returns:
182 An object of the form:
183
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]184 { # Response message for Services.ListServices.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]185 "services": [ # The services belonging to the requested application.
186 { # 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]187 "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
188 "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]189 "split": { # 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.
190 "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.
191 "allocations": { # 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.
192 "a_key": 3.14,
193 },
194 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]195 },
196 ],
197 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
203 <pre>Retrieves the next page of results.
204
205Args:
206 previous_request: The request for the previous page. (required)
207 previous_response: The response from the request for the previous page. (required)
208
209Returns:
210 A request object that you can call 'execute()' on to request the next
211 page. Returns None if there are no more items in the collection.
212 </pre>
213</div>
214
215<div class="method">
216 <code class="details" id="patch">patch(appsId, servicesId, body, migrateTraffic=None, updateMask=None, x__xgafv=None)</code>
217 <pre>Updates the configuration of the specified service.
218
219Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]220 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]221 servicesId: string, Part of `name`. See documentation of `appsId`. (required)
222 body: object, The request body. (required)
223 The object takes the form of:
224
225{ # 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]226 "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
227 "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]228 "split": { # 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.
229 "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.
230 "allocations": { # 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.
231 "a_key": 3.14,
232 },
233 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]234 }
235
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]236 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]237 updateMask: string, Standard field mask for the set of fields to be updated.
238 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]242
243Returns:
244 An object of the form:
245
246 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]247 "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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]248 "a_key": "", # Properties of the object. Contains field @type with type URL.
249 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]250 "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: # The error result of the operation in case of failure or cancellation.
251 # Simple to use and understand for most users
252 # 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 that 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:
253 # 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.
254 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
255 # 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.
256 # 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.
257 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]258 "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.
259 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
260 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
261 {
262 "a_key": "", # Properties of the object. Contains field @type with type URL.
263 },
264 ],
265 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]266 "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 Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]267 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]268 "a_key": "", # Properties of the object. Contains field @type with type URL.
269 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]270 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]271 }</pre>
272</div>
273
274</body></html>