Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 85c2c6d80859c466d29946e66ccd6a1c3a2df748 / . / docs / dyn / appengine_v1beta4.apps.modules.versions.instances.html
blob: a21db3f09f9ebb99c12e89a73a6ccffd9b85d9f8 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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> . <a href="appengine_v1beta4.apps.modules.versions.html">versions</a> . <a href="appengine_v1beta4.apps.modules.versions.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#debug">debug(appsId, modulesId, versionsId, instancesId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
82<p class="firstline">Stops a running instance.</p>
83<p class="toc_element">
84 <code><a href="#get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets instance information.</p>
86<p class="toc_element">
87 <code><a href="#list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists the instances of a version.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="debug">debug(appsId, modulesId, versionsId, instancesId, body, x__xgafv=None)</code>
95 <pre>Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.
96
97Args:
98 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
99 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
100 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
101 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # Request message for `Instances.DebugInstance`.
106 }
107
108 x__xgafv: string, V1 error format.
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.
114 "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`.
115 "a_key": "", # Properties of the object. Contains field @type with type URL.
116 },
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: - 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.
118 "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.
119 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
120 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
121 {
122 "a_key": "", # Properties of the object. Contains field @type with type URL.
123 },
124 ],
125 },
126 "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.
127 "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`.
128 "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.
129 "a_key": "", # Properties of the object. Contains field @type with type URL.
130 },
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="delete">delete(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code>
136 <pre>Stops a running instance.
137
138Args:
139 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
140 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
141 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
142 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
143 x__xgafv: string, V1 error format.
144
145Returns:
146 An object of the form:
147
148 { # This resource represents a long-running operation that is the result of a network API call.
149 "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`.
150 "a_key": "", # Properties of the object. Contains field @type with type URL.
151 },
152 "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.
153 "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.
154 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
155 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
156 {
157 "a_key": "", # Properties of the object. Contains field @type with type URL.
158 },
159 ],
160 },
161 "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.
162 "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`.
163 "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.
164 "a_key": "", # Properties of the object. Contains field @type with type URL.
165 },
166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="get">get(appsId, modulesId, versionsId, instancesId, x__xgafv=None)</code>
171 <pre>Gets instance information.
172
173Args:
174 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. (required)
175 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
176 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
177 instancesId: string, Part of `name`. See documentation of `appsId`. (required)
178 x__xgafv: string, V1 error format.
179
180Returns:
181 An object of the form:
182
183 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
184 "errors": 42, # Number of errors since this instance was started. @OutputOnly
185 "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. @OutputOnly
186 "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
187 "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
188 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
189 "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
190 "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
191 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
192 "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
193 "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
194 "requests": 42, # Number of requests since this instance was started. @OutputOnly
195 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
196 "availability": "A String", # Availability of the instance. @OutputOnly
197 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
198 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
204 <pre>Lists the instances of a version.
205
206Args:
207 appsId: string, Part of `name`. Name of the resource requested. Example: `apps/myapp/modules/default/versions/v1`. (required)
208 modulesId: string, Part of `name`. See documentation of `appsId`. (required)
209 versionsId: string, Part of `name`. See documentation of `appsId`. (required)
210 pageSize: integer, Maximum results to return per page.
211 pageToken: string, Continuation token for fetching the next page of results.
212 x__xgafv: string, V1 error format.
213
214Returns:
215 An object of the form:
216
217 { # Response message for `Instances.ListInstances`.
218 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
219 "instances": [ # The instances belonging to the requested version.
220 { # An Instance resource is the computing unit that App Engine uses to automatically scale an application.
221 "errors": 42, # Number of errors since this instance was started. @OutputOnly
222 "name": "A String", # Full path to the Instance resource in the API. Example: `apps/myapp/modules/default/versions/v1/instances/instance-1`. @OutputOnly
223 "startTimestamp": "A String", # Time that this instance was started. @OutputOnly
224 "appEngineRelease": "A String", # App Engine release this instance is running on. @OutputOnly
225 "vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. @OutputOnly
226 "memoryUsage": "A String", # Total memory in use (bytes). @OutputOnly
227 "id": "A String", # Relative name of the instance within the version. Example: `instance-1`. @OutputOnly
228 "vmUnlocked": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. @OutputOnly
229 "averageLatency": 42, # Average latency (ms) over the last minute. @OutputOnly
230 "qps": 3.14, # Average queries per second (QPS) over the last minute. @OutputOnly
231 "requests": 42, # Number of requests since this instance was started. @OutputOnly
232 "vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
233 "availability": "A String", # Availability of the instance. @OutputOnly
234 "vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. @OutputOnly
235 "vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. @OutputOnly
236 },
237 ],
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
250 A request object that you can call 'execute()' on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255</body></html>