DetailedValidationError

java.lang.Object
- com.vmware.esx.settings.clusters.configuration.DetailedValidationError

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class DetailedValidationError
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The SchemaValidationError class contains details of validation errors for a property. This class was added in vSphere API 8.0.2.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DetailedValidationError.Builder` Builder class for `DetailedValidationError`.
`static class`	`DetailedValidationError.ErrorType` The `ErrorType` enum contains the possible types of errors related to property validation.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DetailedValidationError()` Default constructor.
`protected`	`DetailedValidationError(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static DetailedValidationError`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static DetailedValidationError`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getComponent()` For `SCHEMA_NOT_FOUND` errors, this will be the component portion of the unknown configuration.
`DependencyError`	`getDependencyError()` The dependency required by a union tag.
`java.lang.String`	`getExpectedType()` The expected type of the property.
`java.lang.String`	`getGroup()` For `SCHEMA_NOT_FOUND` errors, this will be the group portion of the unknown configuration.
`java.util.List<java.lang.String>`	`getHosts()` If this error is from a host-level validation performed during a precheck, the hosts that experienced this error will be added here.
`java.lang.String`	`getInstanceId()` The instance ID that was duplicated or is missing from the profile section.
`java.lang.String`	`getKey()` For `SCHEMA_NOT_FOUND` errors, this will be the key portion of the unknown configuration.
`java.lang.Long`	`getMaximumLength()` The maximum length allowed for a string or array property.
`java.lang.Long`	`getMaximumValue()` The maximum allowed value for a property.
`LocalizableMessage`	`getMessage()` A user-friendly description of the error.
`java.lang.Long`	`getMinimumLength()` The minimum length allowed for a string or array property.
`java.lang.Long`	`getMinimumValue()` The minimum allowed value for a property.
`java.lang.String`	`getPath()` The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added.
`java.lang.String`	`getPattern()` The pattern the property is required to match.
`java.lang.String`	`getPropertyName()` The name of the property that holds the instance ID.
`java.lang.String`	`getRequiredProperty()` The name of the required property that is missing from the profile section for this instance/key.
`DetailedValidationError.ErrorType`	`getType()` The type of error.
`int`	`hashCode()`
`void`	`setComponent(java.lang.String component)` For `SCHEMA_NOT_FOUND` errors, this will be the component portion of the unknown configuration.
`void`	`setDependencyError(DependencyError dependencyError)` The dependency required by a union tag.
`void`	`setExpectedType(java.lang.String expectedType)` The expected type of the property.
`void`	`setGroup(java.lang.String group)` For `SCHEMA_NOT_FOUND` errors, this will be the group portion of the unknown configuration.
`void`	`setHosts(java.util.List<java.lang.String> hosts)` If this error is from a host-level validation performed during a precheck, the hosts that experienced this error will be added here.
`void`	`setInstanceId(java.lang.String instanceId)` The instance ID that was duplicated or is missing from the profile section.
`void`	`setKey(java.lang.String key)` For `SCHEMA_NOT_FOUND` errors, this will be the key portion of the unknown configuration.
`void`	`setMaximumLength(java.lang.Long maximumLength)` The maximum length allowed for a string or array property.
`void`	`setMaximumValue(java.lang.Long maximumValue)` The maximum allowed value for a property.
`void`	`setMessage(LocalizableMessage message)` A user-friendly description of the error.
`void`	`setMinimumLength(java.lang.Long minimumLength)` The minimum length allowed for a string or array property.
`void`	`setMinimumValue(java.lang.Long minimumValue)` The minimum allowed value for a property.
`void`	`setPath(java.lang.String path)` The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added.
`void`	`setPattern(java.lang.String pattern)` The pattern the property is required to match.
`void`	`setPropertyName(java.lang.String propertyName)` The name of the property that holds the instance ID.
`void`	`setRequiredProperty(java.lang.String requiredProperty)` The name of the required property that is missing from the profile section for this instance/key.
`void`	`setType(DetailedValidationError.ErrorType type)` The type of error.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - DetailedValidationError
```
public DetailedValidationError()
```
    Default constructor.
  - DetailedValidationError
```
protected DetailedValidationError(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getHosts
```
public java.util.List<java.lang.String> getHosts()
```
    If this error is from a host-level validation performed during a precheck, the hosts that experienced this error will be added here. This property was added in vSphere API 8.0.2.0.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - setHosts
```
public void setHosts(java.util.List<java.lang.String> hosts)
```
    If this error is from a host-level validation performed during a precheck, the hosts that experienced this error will be added here. This property was added in vSphere API 8.0.2.0.
    
    Parameters:
    
    hosts - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: HostSystem. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: HostSystem.
  - getMessage
```
public LocalizableMessage getMessage()
```
    A user-friendly description of the error. This property was added in vSphere API 8.0.2.0.
    
    Returns:
    
    The current value of the property.
  - setMessage
```
public void setMessage(LocalizableMessage message)
```
    A user-friendly description of the error. This property was added in vSphere API 8.0.2.0.
    
    Parameters:
    
    message - New value for the property.
  - getType
```
public DetailedValidationError.ErrorType getType()
```
    The type of error. Additional information may be set for some types of errors. This property was added in vSphere API 8.0.2.0.
    
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(DetailedValidationError.ErrorType type)
```
    The type of error. Additional information may be set for some types of errors. This property was added in vSphere API 8.0.2.0.
    
    Parameters:
    
    type - New value for the property.
  - getPattern
```
public java.lang.String getPattern()
```
    The pattern the property is required to match. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.PATTERN_MISMATCH or DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH.
    
    Returns:
    
    The current value of the property.
  - setPattern
```
public void setPattern(java.lang.String pattern)
```
    The pattern the property is required to match. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.PATTERN_MISMATCH or DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH.
    
    Parameters:
    
    pattern - New value for the property.
  - getExpectedType
```
public java.lang.String getExpectedType()
```
    The expected type of the property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.INVALID_TYPE.
    
    Returns:
    
    The current value of the property.
  - setExpectedType
```
public void setExpectedType(java.lang.String expectedType)
```
    The expected type of the property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.INVALID_TYPE.
    
    Parameters:
    
    expectedType - New value for the property.
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The instance ID that was duplicated or is missing from the profile section. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID or DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE.
    
    Returns:
    
    The current value of the property.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The instance ID that was duplicated or is missing from the profile section. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID or DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE.
    
    Parameters:
    
    instanceId - New value for the property.
  - getPropertyName
```
public java.lang.String getPropertyName()
```
    The name of the property that holds the instance ID. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.MISSING_INSTANCE_ID.
    
    Returns:
    
    The current value of the property.
  - setPropertyName
```
public void setPropertyName(java.lang.String propertyName)
```
    The name of the property that holds the instance ID. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.MISSING_INSTANCE_ID.
    
    Parameters:
    
    propertyName - New value for the property.
  - getMaximumLength
```
public java.lang.Long getMaximumLength()
```
    The maximum length allowed for a string or array property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MAX_STRING_LENGTH or DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH.
    
    Returns:
    
    The current value of the property.
  - setMaximumLength
```
public void setMaximumLength(java.lang.Long maximumLength)
```
    The maximum length allowed for a string or array property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MAX_STRING_LENGTH or DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH.
    
    Parameters:
    
    maximumLength - New value for the property.
  - getMinimumLength
```
public java.lang.Long getMinimumLength()
```
    The minimum length allowed for a string or array property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MIN_STRING_LENGTH or DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH.
    
    Returns:
    
    The current value of the property.
  - setMinimumLength
```
public void setMinimumLength(java.lang.Long minimumLength)
```
    The minimum length allowed for a string or array property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MIN_STRING_LENGTH or DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH.
    
    Parameters:
    
    minimumLength - New value for the property.
  - getMaximumValue
```
public java.lang.Long getMaximumValue()
```
    The maximum allowed value for a property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.MAX_VALUE.
    
    Returns:
    
    The current value of the property.
  - setMaximumValue
```
public void setMaximumValue(java.lang.Long maximumValue)
```
    The maximum allowed value for a property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.MAX_VALUE.
    
    Parameters:
    
    maximumValue - New value for the property.
  - getMinimumValue
```
public java.lang.Long getMinimumValue()
```
    The minimum allowed value for a property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.MIN_VALUE.
    
    Returns:
    
    The current value of the property.
  - setMinimumValue
```
public void setMinimumValue(java.lang.Long minimumValue)
```
    The minimum allowed value for a property. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.MIN_VALUE.
    
    Parameters:
    
    minimumValue - New value for the property.
  - getDependencyError
```
public DependencyError getDependencyError()
```
    The dependency required by a union tag. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.INVALID_UNION_TAG or DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG.
    
    Returns:
    
    The current value of the property.
  - setDependencyError
```
public void setDependencyError(DependencyError dependencyError)
```
    The dependency required by a union tag. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.INVALID_UNION_TAG or DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG.
    
    Parameters:
    
    dependencyError - New value for the property.
  - getComponent
```
public java.lang.String getComponent()
```
    For SCHEMA_NOT_FOUND errors, this will be the component portion of the unknown configuration. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.
    
    Returns:
    
    The current value of the property.
  - setComponent
```
public void setComponent(java.lang.String component)
```
    For SCHEMA_NOT_FOUND errors, this will be the component portion of the unknown configuration. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.
    
    Parameters:
    
    component - New value for the property.
  - getGroup
```
public java.lang.String getGroup()
```
    For SCHEMA_NOT_FOUND errors, this will be the group portion of the unknown configuration. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.
    
    Returns:
    
    The current value of the property.
  - setGroup
```
public void setGroup(java.lang.String group)
```
    For SCHEMA_NOT_FOUND errors, this will be the group portion of the unknown configuration. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.
    
    Parameters:
    
    group - New value for the property.
  - getKey
```
public java.lang.String getKey()
```
    For SCHEMA_NOT_FOUND errors, this will be the key portion of the unknown configuration. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.
    
    Returns:
    
    The current value of the property.
  - setKey
```
public void setKey(java.lang.String key)
```
    For SCHEMA_NOT_FOUND errors, this will be the key portion of the unknown configuration. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND.
    
    Parameters:
    
    key - New value for the property.
  - getPath
```
public java.lang.String getPath()
```
    The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY.
    
    Returns:
    
    The current value of the property.
  - setPath
```
public void setPath(java.lang.String path)
```
    The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY.
    
    Parameters:
    
    path - New value for the property.
  - getRequiredProperty
```
public java.lang.String getRequiredProperty()
```
    The name of the required property that is missing from the profile section for this instance/key. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY.
    
    Returns:
    
    The current value of the property.
  - setRequiredProperty
```
public void setRequiredProperty(java.lang.String requiredProperty)
```
    The name of the required property that is missing from the profile section for this instance/key. This property was added in vSphere API 8.0.2.0. This property is optional and it is only relevant when the value of getType() is one of DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE or DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY.
    
    Parameters:
    
    requiredProperty - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static DetailedValidationError _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static DetailedValidationError _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class DetailedValidationError

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

DetailedValidationError

DetailedValidationError

Method Detail

getHosts

setHosts

getMessage

setMessage

getType

setType

getPattern

setPattern

getExpectedType

setExpectedType

getInstanceId

setInstanceId

getPropertyName

setPropertyName

getMaximumLength

setMaximumLength

getMinimumLength

setMinimumLength

getMaximumValue

setMaximumValue

getMinimumValue

setMinimumValue

getDependencyError

setDependencyError

getComponent

setComponent

getGroup

setGroup

getKey

setKey

getPath

setPath

getRequiredProperty

setRequiredProperty

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2