com.vmware.esx.settings.clusters.configuration

Class DetailedValidationError.Builder

java.lang.Object

com.vmware.esx.settings.clusters.configuration.DetailedValidationError.Builder

Enclosing class:

DetailedValidationError

public static final class DetailedValidationError.Builder
extends java.lang.Object

Builder class for DetailedValidationError.

Constructor Summary

Constructors

Constructor and Description
Builder(LocalizableMessage message, DetailedValidationError.ErrorType type) Constructor with parameters for the required properties of DetailedValidationError.

Method Summary

Modifier and Type	Method and Description
DetailedValidationError	build()
DetailedValidationError.Builder	setComponent(java.lang.String component) For SCHEMA_NOT_FOUND errors, this will be the component portion of the unknown configuration.
DetailedValidationError.Builder	setDependencyError(DependencyError dependencyError) The dependency required by a union tag.
DetailedValidationError.Builder	setExpectedType(java.lang.String expectedType) The expected type of the property.
DetailedValidationError.Builder	setGroup(java.lang.String group) For SCHEMA_NOT_FOUND errors, this will be the group portion of the unknown configuration.
DetailedValidationError.Builder	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.
DetailedValidationError.Builder	setInstanceId(java.lang.String instanceId) The instance ID that was duplicated or is missing from the profile section.
DetailedValidationError.Builder	setKey(java.lang.String key) For SCHEMA_NOT_FOUND errors, this will be the key portion of the unknown configuration.
DetailedValidationError.Builder	setMaximumLength(java.lang.Long maximumLength) The maximum length allowed for a string or array property.
DetailedValidationError.Builder	setMaximumValue(java.lang.Long maximumValue) The maximum allowed value for a property.
DetailedValidationError.Builder	setMinimumLength(java.lang.Long minimumLength) The minimum length allowed for a string or array property.
DetailedValidationError.Builder	setMinimumValue(java.lang.Long minimumValue) The minimum allowed value for a property.
DetailedValidationError.Builder	setPath(java.lang.String path) The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added.
DetailedValidationError.Builder	setPattern(java.lang.String pattern) The pattern the property is required to match.
DetailedValidationError.Builder	setPropertyName(java.lang.String propertyName) The name of the property that holds the instance ID.
DetailedValidationError.Builder	setRequiredProperty(java.lang.String requiredProperty) The name of the required property that is missing from the profile section for this instance/key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(LocalizableMessage message,
               DetailedValidationError.ErrorType type)

Constructor with parameters for the required properties of DetailedValidationError.

Method Detail

setHosts

public DetailedValidationError.Builder 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.

setPattern

public DetailedValidationError.Builder 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.

setExpectedType

public DetailedValidationError.Builder 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.

setInstanceId

public DetailedValidationError.Builder 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.

setPropertyName

public DetailedValidationError.Builder 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.

setMaximumLength

public DetailedValidationError.Builder 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.

setMinimumLength

public DetailedValidationError.Builder 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.

setMaximumValue

public DetailedValidationError.Builder 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.

setMinimumValue

public DetailedValidationError.Builder 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.

setDependencyError

public DetailedValidationError.Builder 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.

setComponent

public DetailedValidationError.Builder 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.

setGroup

public DetailedValidationError.Builder 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.

setKey

public DetailedValidationError.Builder 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.

setPath

public DetailedValidationError.Builder 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.

setRequiredProperty

public DetailedValidationError.Builder 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.

build

public DetailedValidationError build()