• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="clouduseraccounts_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_beta.users.html">users</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#addPublicKey">addPublicKey(project, user, body)</a></code></p>
79<p class="firstline">Adds a public key to the specified User resource with the data included in the request.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(project, user)</a></code></p>
82<p class="firstline">Deletes the specified User resource.</p>
83<p class="toc_element">
84  <code><a href="#get">get(project, user)</a></code></p>
85<p class="firstline">Returns the specified User resource.</p>
86<p class="toc_element">
87  <code><a href="#insert">insert(project, body)</a></code></p>
88<p class="firstline">Creates a User resource in the specified project using the data included in the request.</p>
89<p class="toc_element">
90  <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves a list of users contained within the specified project.</p>
92<p class="toc_element">
93  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96  <code><a href="#removePublicKey">removePublicKey(project, user, fingerprint)</a></code></p>
97<p class="firstline">Removes the specified public key from the user.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="addPublicKey">addPublicKey(project, user, body)</code>
101  <pre>Adds a public key to the specified User resource with the data included in the request.
102
103Args:
104  project: string, Project ID for this request. (required)
105  user: string, Name of the user for this request. (required)
106  body: object, The request body. (required)
107    The object takes the form of:
108
109{ # A public key for authenticating to guests.
110  "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
111  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
112  "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
113  "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
114  "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
115}
116
117
118Returns:
119  An object of the form:
120
121    { # An Operation resource, used to manage asynchronous API requests.
122    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
123    "clientOperationId": "A String", # [Output Only] Reserved for future use.
124    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
125    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
126    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
127    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
128    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
129    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
130    "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.
131    "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.
132    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
133    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
134    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
135    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
136      {
137        "message": "A String", # [Output Only] A human-readable description of the warning code.
138        "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.
139        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
140            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
141          {
142            "value": "A String", # [Output Only] A warning data value corresponding to the key.
143            "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).
144          },
145        ],
146      },
147    ],
148    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
149    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
150    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
151    "name": "A String", # [Output Only] Name of the resource.
152    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
153    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
154      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
155        {
156          "message": "A String", # [Output Only] An optional, human-readable error message.
157          "code": "A String", # [Output Only] The error type identifier for this error.
158          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
159        },
160      ],
161    },
162    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
163    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
164    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
165  }</pre>
166</div>
167
168<div class="method">
169    <code class="details" id="delete">delete(project, user)</code>
170  <pre>Deletes the specified User resource.
171
172Args:
173  project: string, Project ID for this request. (required)
174  user: string, Name of the user resource to delete. (required)
175
176Returns:
177  An object of the form:
178
179    { # An Operation resource, used to manage asynchronous API requests.
180    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
181    "clientOperationId": "A String", # [Output Only] Reserved for future use.
182    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
183    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
184    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
185    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
186    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
187    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
188    "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.
189    "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.
190    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
191    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
192    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
193    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
194      {
195        "message": "A String", # [Output Only] A human-readable description of the warning code.
196        "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.
197        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
198            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
199          {
200            "value": "A String", # [Output Only] A warning data value corresponding to the key.
201            "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).
202          },
203        ],
204      },
205    ],
206    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
207    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
208    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
209    "name": "A String", # [Output Only] Name of the resource.
210    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
211    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
212      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
213        {
214          "message": "A String", # [Output Only] An optional, human-readable error message.
215          "code": "A String", # [Output Only] The error type identifier for this error.
216          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
217        },
218      ],
219    },
220    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
221    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
222    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
223  }</pre>
224</div>
225
226<div class="method">
227    <code class="details" id="get">get(project, user)</code>
228  <pre>Returns the specified User resource.
229
230Args:
231  project: string, Project ID for this request. (required)
232  user: string, Name of the user resource to return. (required)
233
234Returns:
235  An object of the form:
236
237    { # A User resource.
238      "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
239      "name": "A String", # Name of the resource; provided by the client when the resource is created.
240      "publicKeys": [ # [Output Only] Public keys that this user may use to login.
241        { # A public key for authenticating to guests.
242          "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
243          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
244          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
245          "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
246          "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
247        },
248      ],
249      "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
250        "A String",
251      ],
252      "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
253      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
254      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
255      "selfLink": "A String", # [Output Only] Server defined URL for the resource.
256      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
257    }</pre>
258</div>
259
260<div class="method">
261    <code class="details" id="insert">insert(project, body)</code>
262  <pre>Creates a User resource in the specified project using the data included in the request.
263
264Args:
265  project: string, Project ID for this request. (required)
266  body: object, The request body. (required)
267    The object takes the form of:
268
269{ # A User resource.
270    "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
271    "name": "A String", # Name of the resource; provided by the client when the resource is created.
272    "publicKeys": [ # [Output Only] Public keys that this user may use to login.
273      { # A public key for authenticating to guests.
274        "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
275        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
276        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
277        "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
278        "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
279      },
280    ],
281    "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
282      "A String",
283    ],
284    "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
285    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
286    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
287    "selfLink": "A String", # [Output Only] Server defined URL for the resource.
288    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
289  }
290
291
292Returns:
293  An object of the form:
294
295    { # An Operation resource, used to manage asynchronous API requests.
296    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
297    "clientOperationId": "A String", # [Output Only] Reserved for future use.
298    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
299    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
300    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
301    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
302    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
303    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
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 when the operation will be complete. This number should monotonically increase as the operation progresses.
305    "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.
306    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
307    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
308    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
309    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
310      {
311        "message": "A String", # [Output Only] A human-readable description of the warning code.
312        "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.
313        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
314            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
315          {
316            "value": "A String", # [Output Only] A warning data value corresponding to the key.
317            "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).
318          },
319        ],
320      },
321    ],
322    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
323    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
324    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
325    "name": "A String", # [Output Only] Name of the resource.
326    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
327    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
328      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
329        {
330          "message": "A String", # [Output Only] An optional, human-readable error message.
331          "code": "A String", # [Output Only] The error type identifier for this error.
332          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
333        },
334      ],
335    },
336    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
337    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
338    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
339  }</pre>
340</div>
341
342<div class="method">
343    <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
344  <pre>Retrieves a list of users contained within the specified project.
345
346Args:
347  project: string, Project ID for this request. (required)
348  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
349
350You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
351
352Currently, only sorting by name or creationTimestamp desc is supported.
353  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
354  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
355  filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
356
357The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
358
359For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
360
361Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
362
363The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
364
365Returns:
366  An object of the form:
367
368    {
369    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
370    "items": [ # [Output Only] A list of User resources.
371      { # A User resource.
372          "kind": "clouduseraccounts#user", # [Output Only] Type of the resource. Always clouduseraccounts#user for users.
373          "name": "A String", # Name of the resource; provided by the client when the resource is created.
374          "publicKeys": [ # [Output Only] Public keys that this user may use to login.
375            { # A public key for authenticating to guests.
376              "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
377              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
378              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
379              "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
380              "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
381            },
382          ],
383          "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
384            "A String",
385          ],
386          "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
387          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
388          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
389          "selfLink": "A String", # [Output Only] Server defined URL for the resource.
390          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
391        },
392    ],
393    "kind": "clouduseraccounts#userList", # [Output Only] Type of resource. Always clouduseraccounts#userList for lists of users.
394    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
395    "selfLink": "A String", # [Output Only] Server defined URL for this resource.
396  }</pre>
397</div>
398
399<div class="method">
400    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
401  <pre>Retrieves the next page of results.
402
403Args:
404  previous_request: The request for the previous page. (required)
405  previous_response: The response from the request for the previous page. (required)
406
407Returns:
408  A request object that you can call 'execute()' on to request the next
409  page. Returns None if there are no more items in the collection.
410    </pre>
411</div>
412
413<div class="method">
414    <code class="details" id="removePublicKey">removePublicKey(project, user, fingerprint)</code>
415  <pre>Removes the specified public key from the user.
416
417Args:
418  project: string, Project ID for this request. (required)
419  user: string, Name of the user for this request. (required)
420  fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)
421
422Returns:
423  An object of the form:
424
425    { # An Operation resource, used to manage asynchronous API requests.
426    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
427    "clientOperationId": "A String", # [Output Only] Reserved for future use.
428    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
429    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
430    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
431    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
432    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
433    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
434    "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.
435    "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.
436    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
437    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
438    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
439    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
440      {
441        "message": "A String", # [Output Only] A human-readable description of the warning code.
442        "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.
443        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
444            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
445          {
446            "value": "A String", # [Output Only] A warning data value corresponding to the key.
447            "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).
448          },
449        ],
450      },
451    ],
452    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
453    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
454    "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
455    "name": "A String", # [Output Only] Name of the resource.
456    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
457    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
458      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
459        {
460          "message": "A String", # [Output Only] An optional, human-readable error message.
461          "code": "A String", # [Output Only] The error type identifier for this error.
462          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
463        },
464      ],
465    },
466    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
467    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
468    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
469  }</pre>
470</div>
471
472</body></html>