VMware vSphere Automation SDK for .NET 7.0.0.1
|
The Error
error describes thefields common to all standard errors.
More...
Inherited by vmware::vcenter::tokenservice::InvalidGrant, vmware::vcenter::tokenservice::InvalidRequest, and vmware::vcenter::tokenservice::InvalidScope.
Classes | |
class | Builder |
Builder class for Error. More... | |
Public Member Functions | |
Error (global::System.Collections.Generic.List< vmware.vapi.std.LocalizableMessage > messages, vmware.vapi.bindings.IStructure data) | |
Generate all-fields constructor only for errors and standard structures that have relevant fields. | |
Error () | |
Creates a default new instance. | |
global::System.Collections.Generic.List < vmware.vapi.std.LocalizableMessage > | GetMessages () |
Stack of one or more localizable messages for human error consumers. | |
void | SetMessages (global::System.Collections.Generic.List< vmware.vapi.std.LocalizableMessage > messages) |
Stack of one or more localizable messages for human error consumers. | |
vmware.vapi.bindings.IStructure | GetData () |
Data to facilitate clients responding to the method reporting a standard error to indicating that it was unable to complete successfully. | |
void | SetData (vmware.vapi.bindings.IStructure data) |
Data to facilitate clients responding to the method reporting a standard error to indicating that it was unable to complete successfully. | |
virtual vmware.vapi.bindings.type.StructType | _GetType () |
override vmware.vapi.data.StructValue | _GetDataValue () |
virtual void | _Validate () |
override bool | _HasTypeNameOf< T > () |
override T | _ConvertTo< T > () |
override bool | Equals (object obj) |
override int | GetHashCode () |
Properties | |
override string | Message [get] |
The Error
error describes thefields common to all standard errors.
This error serves two purposes:
vmware::vcenter::tokenservice::Error::Error | ( | global::System.Collections.Generic.List< vmware.vapi.std.LocalizableMessage > | messages, |
vmware.vapi.bindings.IStructure | data | ||
) | [inline] |
Generate all-fields constructor only for errors and standard structures that have relevant fields.
vmware::vcenter::tokenservice::Error::Error | ( | ) | [inline] |
Creates a default new instance.
override T vmware::vcenter::tokenservice::Error::_ConvertTo< T > | ( | ) | [inline] |
override vmware.vapi.data.StructValue vmware::vcenter::tokenservice::Error::_GetDataValue | ( | ) | [inline] |
virtual vmware.vapi.bindings.type.StructType vmware::vcenter::tokenservice::Error::_GetType | ( | ) | [inline, virtual] |
override bool vmware::vcenter::tokenservice::Error::_HasTypeNameOf< T > | ( | ) | [inline] |
virtual void vmware::vcenter::tokenservice::Error::_Validate | ( | ) | [inline, virtual] |
override bool vmware::vcenter::tokenservice::Error::Equals | ( | object | obj | ) | [inline] |
vmware.vapi.bindings.IStructure vmware::vcenter::tokenservice::Error::GetData | ( | ) | [inline] |
Data to facilitate clients responding to the method reporting a standard error to indicating that it was unable to complete successfully.
Methods 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 method reporting the error, different methods that report the same error may provide different data in the error. The documentation for each each method will describe what, if any, data it provides for each error it reports. The null, null, and null classs are intended as possible values for this field. vmware.vapi.std.DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some interfaces may provide their own specific classs for use as the value of this field when reporting errors from their methods.
override int vmware::vcenter::tokenservice::Error::GetHashCode | ( | ) | [inline] |
global::System.Collections.Generic.List<vmware.vapi.std.LocalizableMessage> vmware::vcenter::tokenservice::Error::GetMessages | ( | ) | [inline] |
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 method the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.
void vmware::vcenter::tokenservice::Error::SetData | ( | vmware.vapi.bindings.IStructure | data | ) | [inline] |
Data to facilitate clients responding to the method reporting a standard error to indicating that it was unable to complete successfully.
Methods 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 method reporting the error, different methods that report the same error may provide different data in the error. The documentation for each each method will describe what, if any, data it provides for each error it reports. The null, null, and null classs are intended as possible values for this field. vmware.vapi.std.DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some interfaces may provide their own specific classs for use as the value of this field when reporting errors from their methods.
void vmware::vcenter::tokenservice::Error::SetMessages | ( | global::System.Collections.Generic.List< vmware.vapi.std.LocalizableMessage > | messages | ) | [inline] |
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 method the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.
override string vmware::vcenter::tokenservice::Error::Message [get] |