Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c1f8beda2812f174908cf495687a15638482e309 / . / docs / dyn / compute_v1.projects.html
blob: b09ba932ff8b125ed28cf976f28e386bbcd169d8 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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_v1.html">Compute Engine API</a> . <a href="compute_v1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project)</a></code></p>
79<p class="firstline">Returns the specified project resource.</p>
80<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]81 <code><a href="#moveDisk">moveDisk(project, body)</a></code></p>
82<p class="firstline">Moves a persistent disk from one zone to another.</p>
83<p class="toc_element">
84 <code><a href="#moveInstance">moveInstance(project, body)</a></code></p>
85<p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</p>
86<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]87 <code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</a></code></p>
88<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]91<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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="get">get(project)</code>
95 <pre>Returns the specified project resource.
96
97Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99
100Returns:
101 An object of the form:
102
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]103 { # A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console.
104 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]105 "description": "A String", # An optional textual description of the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]106 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
108 {
109 "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.
110 "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.
111 },
112 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
114 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 "quotas": [ # [Output Only] Quotas assigned to this project.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]117 { # A quotas entry.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "usage": 3.14, # [Output Only] Current usage of this metric.
119 "metric": "A String", # [Output Only] Name of the quota metric.
120 "limit": 3.14, # [Output Only] Quota limit for this metric.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121 },
122 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]123 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The location in Cloud Storage and naming method of the daily usage report.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]124 "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 is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it.
125 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]126 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]127 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
128 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
129 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 "name": "A String", # Name of the resource.
131 }</pre>
132</div>
133
134<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]135 <code class="details" id="moveDisk">moveDisk(project, body)</code>
136 <pre>Moves a persistent disk from one zone to another.
137
138Args:
139 project: string, Project ID for this request. (required)
140 body: object, The request body. (required)
141 The object takes the form of:
142
143{
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]144 "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:
145 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
146 # - projects/project/zones/zone/disks/disk
147 # - zones/zone/disks/disk
148 "destinationZone": "A String", # The URL of the destination zone to move the disk to. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
149 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
150 # - projects/project/zones/zone
151 # - zones/zone
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 }
153
154
155Returns:
156 An object of the form:
157
158 { # An operation resource, used to manage asynchronous API requests.
159 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]160 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]161 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
162 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
163 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
164 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
165 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]166 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]167 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
168 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
169 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
170 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
171 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
172 {
173 "message": "A String", # [Output Only] Optional human-readable details for this warning.
174 "code": "A String", # [Output Only] The warning type identifier for this warning.
175 "data": [ # [Output Only] Metadata for this warning in key: value format.
176 {
177 "value": "A String", # [Output Only] A warning data value corresponding to the key.
178 "key": "A String", # [Output Only] A key for the warning data.
179 },
180 ],
181 },
182 ],
183 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
184 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
185 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
186 "name": "A String", # [Output Only] Name of the resource.
187 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
188 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
189 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
190 {
191 "message": "A String", # [Output Only] An optional, human-readable error message.
192 "code": "A String", # [Output Only] The error type identifier for this error.
193 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
194 },
195 ],
196 },
197 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
198 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
199 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="moveInstance">moveInstance(project, body)</code>
205 <pre>Moves an instance and its attached persistent disks from one zone to another.
206
207Args:
208 project: string, Project ID for this request. (required)
209 body: object, The request body. (required)
210 The object takes the form of:
211
212{
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]213 "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:
214 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
215 # - projects/project/zones/zone/instances/instance
216 # - zones/zone/instances/instance
217 "destinationZone": "A String", # The URL of the destination zone to move the instance to. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
218 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone
219 # - projects/project/zones/zone
220 # - zones/zone
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]221 }
222
223
224Returns:
225 An object of the form:
226
227 { # An operation resource, used to manage asynchronous API requests.
228 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]229 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]230 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
231 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
232 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
233 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
234 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]235 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]236 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
237 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
238 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
239 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
240 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
241 {
242 "message": "A String", # [Output Only] Optional human-readable details for this warning.
243 "code": "A String", # [Output Only] The warning type identifier for this warning.
244 "data": [ # [Output Only] Metadata for this warning in key: value format.
245 {
246 "value": "A String", # [Output Only] A warning data value corresponding to the key.
247 "key": "A String", # [Output Only] A key for the warning data.
248 },
249 ],
250 },
251 ],
252 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
253 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
254 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
255 "name": "A String", # [Output Only] Name of the resource.
256 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
257 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
258 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
259 {
260 "message": "A String", # [Output Only] An optional, human-readable error message.
261 "code": "A String", # [Output Only] The error type identifier for this error.
262 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
263 },
264 ],
265 },
266 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
267 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
268 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
269 }</pre>
270</div>
271
272<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 <code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</code>
274 <pre>Sets metadata common to all instances within the specified project using the data included in the request.
275
276Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]277 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]278 body: object, The request body. (required)
279 The object takes the form of:
280
281{ # A metadata key/value entry.
282 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
283 {
284 "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.
285 "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.
286 },
287 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]288 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
289 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290}
291
292
293Returns:
294 An object of the form:
295
296 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]297 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]298 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]299 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]300 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]301 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
302 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
303 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]304 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]305 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]306 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]307 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
308 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
309 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]310 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]311 "message": "A String", # [Output Only] Optional human-readable details for this warning.
312 "code": "A String", # [Output Only] The warning type identifier for this warning.
313 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]315 "value": "A String", # [Output Only] A warning data value corresponding to the key.
316 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 },
318 ],
319 },
320 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]321 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
322 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
323 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
324 "name": "A String", # [Output Only] Name of the resource.
325 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
326 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]327 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]329 "message": "A String", # [Output Only] An optional, human-readable error message.
330 "code": "A String", # [Output Only] The error type identifier for this error.
331 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]332 },
333 ],
334 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]335 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]336 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]337 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]338 }</pre>
339</div>
340
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]341<div class="method">
342 <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]343 <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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]344
345Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]346 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]347 body: object, The request body. (required)
348 The object takes the form of:
349
350{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]351 "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 is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it.
352 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]353 }
354
355
356Returns:
357 An object of the form:
358
359 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]360 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]361 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]363 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]364 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
365 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
366 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]367 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]368 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]369 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]370 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
371 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
372 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]373 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]374 "message": "A String", # [Output Only] Optional human-readable details for this warning.
375 "code": "A String", # [Output Only] The warning type identifier for this warning.
376 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]377 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]378 "value": "A String", # [Output Only] A warning data value corresponding to the key.
379 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]380 },
381 ],
382 },
383 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]384 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
385 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
386 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
387 "name": "A String", # [Output Only] Name of the resource.
388 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
389 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]390 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]391 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]392 "message": "A String", # [Output Only] An optional, human-readable error message.
393 "code": "A String", # [Output Only] The error type identifier for this error.
394 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]395 },
396 ],
397 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]398 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]399 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]400 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]401 }</pre>
402</div>
403
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404</body></html>