Vapi.Std.Errors.Error

Vapi.Std.Errors.Error
Vapi.Std.Errors.Error

The Vapi.Std.Errors.Error error describes theproperties common to all standard errors.

This error serves two purposes:

  1. It is the error that clients in many programming languages can catch to handle all standard errors. Typically those clients will display one or more of the localizable messages from Vapi.Std.Errors.Error.messages to a human.
  2. It is the error that operations can report when they need to report some error, but the error doesn't fit into any other standard error, and in fact the only reasonable way for a client to react to the error is to display the message(s) to a human.
JSON Example
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi.Std.NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
array of Vapi.Std.LocalizableMessage
messages
Required

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.

object
data
Optional

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.ArgumentLocations, Vapi.Std.Errors.FileLocations, and Vapi.Std.Errors.TransientIndication schemas are intended as possible values for this property. Vapi.Std.DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

Possible values:

  • ERROR: Discriminator for the Vapi.Std.Errors.Error type.
  • ALREADY_EXISTS: Discriminator for the Vapi.Std.Errors.AlreadyExists type.
  • ALREADY_IN_DESIRED_STATE: Discriminator for the Vapi.Std.Errors.AlreadyInDesiredState type.
  • CANCELED: Discriminator for the Vapi.Std.Errors.Canceled type.
  • CONCURRENT_CHANGE: Discriminator for the Vapi.Std.Errors.ConcurrentChange type.
  • FEATURE_IN_USE: Discriminator for the Vapi.Std.Errors.FeatureInUse type.
  • INTERNAL_SERVER_ERROR: Discriminator for the Vapi.Std.Errors.InternalServerError type.
  • INVALID_ARGUMENT: Discriminator for the Vapi.Std.Errors.InvalidArgument type.
  • INVALID_ELEMENT_CONFIGURATION: Discriminator for the Vapi.Std.Errors.InvalidElementConfiguration type.
  • INVALID_ELEMENT_TYPE: Discriminator for the Vapi.Std.Errors.InvalidElementType type.
  • INVALID_REQUEST: Discriminator for the Vapi.Std.Errors.InvalidRequest type.
  • NOT_ALLOWED_IN_CURRENT_STATE: Discriminator for the Vapi.Std.Errors.NotAllowedInCurrentState type.
  • NOT_FOUND: Discriminator for the Vapi.Std.Errors.NotFound type.
  • OPERATION_NOT_FOUND: Discriminator for the Vapi.Std.Errors.OperationNotFound type.
  • RESOURCE_BUSY: Discriminator for the Vapi.Std.Errors.ResourceBusy type.
  • RESOURCE_IN_USE: Discriminator for the Vapi.Std.Errors.ResourceInUse type.
  • RESOURCE_INACCESSIBLE: Discriminator for the Vapi.Std.Errors.ResourceInaccessible type.
  • SERVICE_UNAVAILABLE: Discriminator for the Vapi.Std.Errors.ServiceUnavailable type.
  • TIMED_OUT: Discriminator for the Vapi.Std.Errors.TimedOut type.
  • UNABLE_TO_ALLOCATE_RESOURCE: Discriminator for the Vapi.Std.Errors.UnableToAllocateResource type.
  • UNAUTHENTICATED: Discriminator for the Vapi.Std.Errors.Unauthenticated type.
  • UNAUTHORIZED: Discriminator for the Vapi.Std.Errors.Unauthorized type.
  • UNEXPECTED_INPUT: Discriminator for the Vapi.Std.Errors.UnexpectedInput type.
  • UNSUPPORTED: Discriminator for the Vapi.Std.Errors.Unsupported type.
  • UNVERIFIED_PEER: Discriminator for the Vapi.Std.Errors.UnverifiedPeer type.

For more information see: Vapi.Std.Errors.Error.Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

Used By