vapi std errors: canceled
canceled error indicates that the operation canceled itself in response to an explicit request to do so. Operations being "canceled" for other reasons (for example the client connection was closed, a time out occured, or due to excessive resource consumption) should not report this error. Examples:
- A user is monitoring the progress of the operation in a GUI and sees that it is likely to take longer than he is willing to wait and clicks the cancel button.
- A user invokes the operation using a command-line tool and decides that she didn't really want to invoke that operation, and presses CTRL-c.
Counterexamples:
- The client's connection to the server was closed. Reporting an error is pointless since the client will not receive the error response because the connection has been closed.
- The request is taking longer than some amount of time. The vapi.std.errors.timed_out error would be reported if the time was specified as part of the input or is documented in the API contract.
Representations:
"type": "com.vmware.vapi.std.errors.canceled",
"value": {
"data": {},
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
}
}
<ns0:Error xmlns:ns0="http://vmware.com/vapi/rest/base" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<data>
</data>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</value>
<type>com.vmware.vapi.std.errors.canceled</type>
</ns0:Error>
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| messages | localizable_message[] | Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message. |
| Optional | ||
| data | object | Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The vapi.std.errors.argument_locations, vapi.std.errors.file_locations, and vapi.std.errors.transient_indication structures are intended as possible values for this field. vapi.std.dynamic_ID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations. Optional. Some operations will not set this field when reporting errors. |