Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02bae1c909ec28088ebbc4007f3ef9b968b55e0a / . / docs / dyn / compute_alpha.projects.html
blob: 688ee1b23d24bf37981a6cf3310a280bba555ce7 [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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]78 <code><a href="#disableXpnHost">disableXpnHost(project, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Disable this project as an XPN host project.</p>
80<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]81 <code><a href="#disableXpnResource">disableXpnResource(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]82<p class="firstline">Disable an XPN resource associated with this host project.</p>
83<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]84 <code><a href="#enableXpnHost">enableXpnHost(project, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Enable this project as an XPN host project.</p>
86<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]87 <code><a href="#enableXpnResource">enableXpnResource(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.</p>
89<p class="toc_element">
90 <code><a href="#get">get(project)</a></code></p>
91<p class="firstline">Returns the specified Project resource.</p>
92<p class="toc_element">
93 <code><a href="#getXpnHost">getXpnHost(project)</a></code></p>
94<p class="firstline">Get the XPN host project that this project links to. May be empty if no link exists.</p>
95<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96 <code><a href="#getXpnResources">getXpnResources(project, order_by=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Get XPN resources associated with this host project.</p>
98<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]99 <code><a href="#getXpnResources_next">getXpnResources_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#listXpnHosts">listXpnHosts(project, body, order_by=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103<p class="firstline">List all XPN host projects visible to the user in an organization.</p>
104<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 <code><a href="#listXpnHosts_next">listXpnHosts_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#moveDisk">moveDisk(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]109<p class="firstline">Moves a persistent disk from one zone to another.</p>
110<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]111 <code><a href="#moveInstance">moveInstance(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]112<p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</p>
113<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]114 <code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]115<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>
116<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]117 <code><a href="#setDefaultServiceAccount">setDefaultServiceAccount(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]118<p class="firstline">Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".</p>
119<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]121<p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</p>
122<h3>Method Details</h3>
123<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]124 <code class="details" id="disableXpnHost">disableXpnHost(project, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]125 <pre>Disable this project as an XPN host project.
126
127Args:
128 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]129 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]130
131Returns:
132 An object of the form:
133
134 { # An Operation resource, used to manage asynchronous API requests.
135 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
136 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]138 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
139 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
140 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
141 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
142 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
143 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
144 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
145 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
146 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
147 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
148 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
149 {
150 "message": "A String", # [Output Only] A human-readable description of the warning code.
151 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
152 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
153 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
154 {
155 "value": "A String", # [Output Only] A warning data value corresponding to the key.
156 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
157 },
158 ],
159 },
160 ],
161 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
162 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
163 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
164 "name": "A String", # [Output Only] Name of the resource.
165 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
166 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
167 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
168 {
169 "message": "A String", # [Output Only] An optional, human-readable error message.
170 "code": "A String", # [Output Only] The error type identifier for this error.
171 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
172 },
173 ],
174 },
175 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
176 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]177 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 }</pre>
179</div>
180
181<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]182 <code class="details" id="disableXpnResource">disableXpnResource(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]183 <pre>Disable an XPN resource associated with this host project.
184
185Args:
186 project: string, Project ID for this request. (required)
187 body: object, The request body. (required)
188 The object takes the form of:
189
190{
191 "xpnResource": { # XpnResourceId # XPN resource ID.
192 "type": "A String", # The type of the XPN resource.
193 "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
194 },
195 }
196
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]197 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198
199Returns:
200 An object of the form:
201
202 { # An Operation resource, used to manage asynchronous API requests.
203 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
204 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]205 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]206 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
207 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
208 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
209 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
210 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
211 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
212 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
213 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
214 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
215 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
216 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
217 {
218 "message": "A String", # [Output Only] A human-readable description of the warning code.
219 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
220 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
221 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
222 {
223 "value": "A String", # [Output Only] A warning data value corresponding to the key.
224 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
225 },
226 ],
227 },
228 ],
229 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
230 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
231 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
232 "name": "A String", # [Output Only] Name of the resource.
233 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
234 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
235 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
236 {
237 "message": "A String", # [Output Only] An optional, human-readable error message.
238 "code": "A String", # [Output Only] The error type identifier for this error.
239 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
240 },
241 ],
242 },
243 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
244 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]245 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]246 }</pre>
247</div>
248
249<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]250 <code class="details" id="enableXpnHost">enableXpnHost(project, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]251 <pre>Enable this project as an XPN host project.
252
253Args:
254 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]255 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]256
257Returns:
258 An object of the form:
259
260 { # An Operation resource, used to manage asynchronous API requests.
261 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
262 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]263 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]264 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
265 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
266 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
267 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
268 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
269 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
270 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
271 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
272 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
273 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
274 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
275 {
276 "message": "A String", # [Output Only] A human-readable description of the warning code.
277 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
278 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
279 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
280 {
281 "value": "A String", # [Output Only] A warning data value corresponding to the key.
282 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
283 },
284 ],
285 },
286 ],
287 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
288 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
289 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
290 "name": "A String", # [Output Only] Name of the resource.
291 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
292 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
293 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
294 {
295 "message": "A String", # [Output Only] An optional, human-readable error message.
296 "code": "A String", # [Output Only] The error type identifier for this error.
297 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
298 },
299 ],
300 },
301 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
302 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]303 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]304 }</pre>
305</div>
306
307<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]308 <code class="details" id="enableXpnResource">enableXpnResource(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]309 <pre>Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.
310
311Args:
312 project: string, Project ID for this request. (required)
313 body: object, The request body. (required)
314 The object takes the form of:
315
316{
317 "xpnResource": { # XpnResourceId # XPN resource ID.
318 "type": "A String", # The type of the XPN resource.
319 "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
320 },
321 }
322
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]323 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]324
325Returns:
326 An object of the form:
327
328 { # An Operation resource, used to manage asynchronous API requests.
329 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
330 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]331 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]332 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
333 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
334 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
335 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
336 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
337 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
338 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
339 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
340 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
341 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
342 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
343 {
344 "message": "A String", # [Output Only] A human-readable description of the warning code.
345 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
346 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
347 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
348 {
349 "value": "A String", # [Output Only] A warning data value corresponding to the key.
350 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
351 },
352 ],
353 },
354 ],
355 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
356 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
357 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
358 "name": "A String", # [Output Only] Name of the resource.
359 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
360 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
361 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
362 {
363 "message": "A String", # [Output Only] An optional, human-readable error message.
364 "code": "A String", # [Output Only] The error type identifier for this error.
365 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
366 },
367 ],
368 },
369 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
370 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]371 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]372 }</pre>
373</div>
374
375<div class="method">
376 <code class="details" id="get">get(project)</code>
377 <pre>Returns the specified Project resource.
378
379Args:
380 project: string, Project ID for this request. (required)
381
382Returns:
383 An object of the form:
384
385 { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
386 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
387 "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
388 "enabledFeatures": [ # Restricted features enabled for use on this project.
389 "A String",
390 ],
391 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
392 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
393 {
394 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
395 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
396 },
397 ],
398 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
399 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
400 },
401 "quotas": [ # [Output Only] Quotas assigned to this project.
402 { # A quotas entry.
403 "usage": 3.14, # [Output Only] Current usage of this metric.
404 "metric": "A String", # [Output Only] Name of the quota metric.
405 "limit": 3.14, # [Output Only] Quota limit for this metric.
406 },
407 ],
408 "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
409 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
410 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
411 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
412 },
413 "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
414 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
415 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
416 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
417 "description": "A String", # An optional textual description of the resource.
418 }</pre>
419</div>
420
421<div class="method">
422 <code class="details" id="getXpnHost">getXpnHost(project)</code>
423 <pre>Get the XPN host project that this project links to. May be empty if no link exists.
424
425Args:
426 project: string, Project ID for this request. (required)
427
428Returns:
429 An object of the form:
430
431 { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
432 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
433 "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
434 "enabledFeatures": [ # Restricted features enabled for use on this project.
435 "A String",
436 ],
437 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
438 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
439 {
440 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
441 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
442 },
443 ],
444 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
445 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
446 },
447 "quotas": [ # [Output Only] Quotas assigned to this project.
448 { # A quotas entry.
449 "usage": 3.14, # [Output Only] Current usage of this metric.
450 "metric": "A String", # [Output Only] Name of the quota metric.
451 "limit": 3.14, # [Output Only] Quota limit for this metric.
452 },
453 ],
454 "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
455 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
456 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
457 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
458 },
459 "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
460 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
461 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
462 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
463 "description": "A String", # An optional textual description of the resource.
464 }</pre>
465</div>
466
467<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]468 <code class="details" id="getXpnResources">getXpnResources(project, order_by=None, maxResults=None, pageToken=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]469 <pre>Get XPN resources associated with this host project.
470
471Args:
472 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]473 order_by: string, A parameter
474 maxResults: integer, A parameter
475 pageToken: string, A parameter
476 filter: string, A parameter
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]477
478Returns:
479 An object of the form:
480
481 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]482 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]483 "kind": "compute#projectsGetXpnResources", # [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of XPN resources.
484 "resources": [ # XPN resources attached to this project as their XPN host.
485 { # XpnResourceId
486 "type": "A String", # The type of the XPN resource.
487 "id": "A String", # The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
488 },
489 ],
490 }</pre>
491</div>
492
493<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]494 <code class="details" id="getXpnResources_next">getXpnResources_next(previous_request, previous_response)</code>
495 <pre>Retrieves the next page of results.
496
497Args:
498 previous_request: The request for the previous page. (required)
499 previous_response: The response from the request for the previous page. (required)
500
501Returns:
502 A request object that you can call 'execute()' on to request the next
503 page. Returns None if there are no more items in the collection.
504 </pre>
505</div>
506
507<div class="method">
508 <code class="details" id="listXpnHosts">listXpnHosts(project, body, order_by=None, maxResults=None, pageToken=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]509 <pre>List all XPN host projects visible to the user in an organization.
510
511Args:
512 project: string, Project ID for this request. (required)
513 body: object, The request body. (required)
514 The object takes the form of:
515
516{
517 "organization": "A String", # Optional organization ID managed by Cloud Resource Manager, for which to list XPN host projects. If not specified, the organization will be inferred from the project.
518 }
519
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]520 order_by: string, A parameter
521 maxResults: integer, A parameter
522 pageToken: string, A parameter
523 filter: string, A parameter
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]524
525Returns:
526 An object of the form:
527
528 {
529 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
530 "items": [ # [Output Only] A list of XPN host project URLs.
531 { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.
532 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
533 "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
534 "enabledFeatures": [ # Restricted features enabled for use on this project.
535 "A String",
536 ],
537 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
538 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
539 {
540 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
541 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
542 },
543 ],
544 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
545 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
546 },
547 "quotas": [ # [Output Only] Quotas assigned to this project.
548 { # A quotas entry.
549 "usage": 3.14, # [Output Only] Current usage of this metric.
550 "metric": "A String", # [Output Only] Name of the quota metric.
551 "limit": 3.14, # [Output Only] Quota limit for this metric.
552 },
553 ],
554 "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
555 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
556 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
557 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
558 },
559 "xpnProjectStatus": "A String", # [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
560 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
561 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
562 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
563 "description": "A String", # An optional textual description of the resource.
564 },
565 ],
566 "kind": "compute#xpnHostList", # [Output Only] Type of resource. Always compute#xpnHostList for lists of XPN hosts.
567 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
568 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
569 }</pre>
570</div>
571
572<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]573 <code class="details" id="listXpnHosts_next">listXpnHosts_next(previous_request, previous_response)</code>
574 <pre>Retrieves the next page of results.
575
576Args:
577 previous_request: The request for the previous page. (required)
578 previous_response: The response from the request for the previous page. (required)
579
580Returns:
581 A request object that you can call 'execute()' on to request the next
582 page. Returns None if there are no more items in the collection.
583 </pre>
584</div>
585
586<div class="method">
587 <code class="details" id="moveDisk">moveDisk(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]588 <pre>Moves a persistent disk from one zone to another.
589
590Args:
591 project: string, Project ID for this request. (required)
592 body: object, The request body. (required)
593 The object takes the form of:
594
595{
596 "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
597 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
598 # - projects/project/zones/zone/disks/disk
599 # - zones/zone/disks/disk
600 "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
601 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
602 # - projects/project/zones/zone
603 # - zones/zone
604 }
605
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]606 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]607
608Returns:
609 An object of the form:
610
611 { # An Operation resource, used to manage asynchronous API requests.
612 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
613 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]614 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]615 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
616 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
617 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
618 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
619 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
620 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
621 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
622 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
623 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
624 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
625 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
626 {
627 "message": "A String", # [Output Only] A human-readable description of the warning code.
628 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
629 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
630 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
631 {
632 "value": "A String", # [Output Only] A warning data value corresponding to the key.
633 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
634 },
635 ],
636 },
637 ],
638 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
639 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
640 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
641 "name": "A String", # [Output Only] Name of the resource.
642 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
643 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
644 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
645 {
646 "message": "A String", # [Output Only] An optional, human-readable error message.
647 "code": "A String", # [Output Only] The error type identifier for this error.
648 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
649 },
650 ],
651 },
652 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
653 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]654 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]655 }</pre>
656</div>
657
658<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]659 <code class="details" id="moveInstance">moveInstance(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]660 <pre>Moves an instance and its attached persistent disks from one zone to another.
661
662Args:
663 project: string, Project ID for this request. (required)
664 body: object, The request body. (required)
665 The object takes the form of:
666
667{
668 "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
669 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
670 # - projects/project/zones/zone/instances/instance
671 # - zones/zone/instances/instance
672 "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
673 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
674 # - projects/project/zones/zone
675 # - zones/zone
676 }
677
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]678 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]679
680Returns:
681 An object of the form:
682
683 { # An Operation resource, used to manage asynchronous API requests.
684 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
685 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]686 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]687 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
688 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
689 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
690 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
691 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
692 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
693 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
694 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
695 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
696 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
697 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
698 {
699 "message": "A String", # [Output Only] A human-readable description of the warning code.
700 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
701 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
702 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
703 {
704 "value": "A String", # [Output Only] A warning data value corresponding to the key.
705 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
706 },
707 ],
708 },
709 ],
710 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
711 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
712 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
713 "name": "A String", # [Output Only] Name of the resource.
714 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
715 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
716 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
717 {
718 "message": "A String", # [Output Only] An optional, human-readable error message.
719 "code": "A String", # [Output Only] The error type identifier for this error.
720 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
721 },
722 ],
723 },
724 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
725 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]726 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]727 }</pre>
728</div>
729
730<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]731 <code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]732 <pre>Sets metadata common to all instances within the specified project using the data included in the request.
733
734Args:
735 project: string, Project ID for this request. (required)
736 body: object, The request body. (required)
737 The object takes the form of:
738
739{ # A metadata key/value entry.
740 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
741 {
742 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
743 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
744 },
745 ],
746 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
747 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
748}
749
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]750 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]751
752Returns:
753 An object of the form:
754
755 { # An Operation resource, used to manage asynchronous API requests.
756 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
757 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]758 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]759 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
760 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
761 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
762 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
763 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
764 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
765 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
766 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
767 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
768 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
769 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
770 {
771 "message": "A String", # [Output Only] A human-readable description of the warning code.
772 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
773 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
774 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
775 {
776 "value": "A String", # [Output Only] A warning data value corresponding to the key.
777 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
778 },
779 ],
780 },
781 ],
782 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
783 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
784 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
785 "name": "A String", # [Output Only] Name of the resource.
786 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
787 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
788 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
789 {
790 "message": "A String", # [Output Only] An optional, human-readable error message.
791 "code": "A String", # [Output Only] The error type identifier for this error.
792 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
793 },
794 ],
795 },
796 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
797 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]798 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]799 }</pre>
800</div>
801
802<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]803 <code class="details" id="setDefaultServiceAccount">setDefaultServiceAccount(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]804 <pre>Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".
805
806Args:
807 project: string, Project ID for this request. (required)
808 body: object, The request body. (required)
809 The object takes the form of:
810
811{
812 "email": "A String", # Email address of the service account.
813 }
814
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]815 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]816
817Returns:
818 An object of the form:
819
820 { # An Operation resource, used to manage asynchronous API requests.
821 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
822 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]823 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]824 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
825 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
826 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
827 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
828 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
829 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
830 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
831 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
832 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
833 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
834 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
835 {
836 "message": "A String", # [Output Only] A human-readable description of the warning code.
837 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
838 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
839 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
840 {
841 "value": "A String", # [Output Only] A warning data value corresponding to the key.
842 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
843 },
844 ],
845 },
846 ],
847 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
848 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
849 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
850 "name": "A String", # [Output Only] Name of the resource.
851 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
852 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
853 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
854 {
855 "message": "A String", # [Output Only] An optional, human-readable error message.
856 "code": "A String", # [Output Only] The error type identifier for this error.
857 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
858 },
859 ],
860 },
861 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
862 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]863 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]864 }</pre>
865</div>
866
867<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]868 <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]869 <pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
870
871Args:
872 project: string, Project ID for this request. (required)
873 body: object, The request body. (required)
874 The object takes the form of:
875
876{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
877 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
878 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
879}
880
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]881 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]882
883Returns:
884 An object of the form:
885
886 { # An Operation resource, used to manage asynchronous API requests.
887 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
888 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]889 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]890 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
891 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
892 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
893 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
894 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
895 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
896 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
897 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
898 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
899 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
900 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
901 {
902 "message": "A String", # [Output Only] A human-readable description of the warning code.
903 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
904 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
905 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
906 {
907 "value": "A String", # [Output Only] A warning data value corresponding to the key.
908 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
909 },
910 ],
911 },
912 ],
913 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
914 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
915 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
916 "name": "A String", # [Output Only] Name of the resource.
917 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
918 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
919 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
920 {
921 "message": "A String", # [Output Only] An optional, human-readable error message.
922 "code": "A String", # [Output Only] The error type identifier for this error.
923 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
924 },
925 ],
926 },
927 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
928 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]929 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]930 }</pre>
931</div>
932
933</body></html>