Settings_Clusters_Configuration_DetailedValidationError
The SchemaValidationError structure contains details of validation errors for a property.
{
"hosts": [
"string"
],
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"type": "string",
"pattern": "string",
"expected_type": "string",
"instance_id": "string",
"property_name": "string",
"maximum_length": 0,
"minimum_length": 0,
"maximum_value": 0,
"minimum_value": 0,
"dependency_error": {
"required_value": "string",
"current_value": "string",
"possible_values": "string"
},
"component": "string",
"group": "string",
"key": "string",
"path": "string",
"required_property": "string"
}If this error is from a host-level validation performed during a precheck, the hosts that experienced this error will be added here. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.
The DetailedValidationError.ErrorType enum contains the possible types of errors related to property validation.
GENERIC : A generic error. Check the message property for more information.
ADDITIONAL_PROPERTY : A property that is not specified in the schema was found.
INVALID_ENUM_OPTION : The value of an enum property does not match one of the allowed values.
INVALID_TYPE : The value of a property is not the expected type.
MAX_STRING_LENGTH : The length of a string is larger than the maximum allowed.
MIN_STRING_LENGTH : The length of a string is smaller than the minimum allowed.
MISSING_REQUIRED : A required property is missing.
INVALID_UNION_TAG : A property that is dependent on another property is invalid.
DUPLICATE_INSTANCE_ID : An instance has an instance ID that was already used in another instance.
MAX_ARRAY_LENGTH : The length of an array is larger than the maximum allowed.
MIN_ARRAY_LENGTH : The length of an array is smaller than the minimum allowed.
MAX_VALUE : The value of a numeric property is larger than the maximum allowed.
MIN_VALUE : The value of a numeric property is smaller than the minimum allowed.
PATTERN_MISMATCH : The value of a string property does not match the allowed pattern.
SCHEMA_NOT_FOUND : A configuration was found for software that is not in the image associated with the cluster.
NULL_VALUE : A property has a null value.
INVALID_DELETE_DEFAULT : The property is only valid for mutable default configurations.
HOST_SPECIFIC_IN_PROFILE : The property is host-specific, but was found in the profile section.
NOT_HOST_SPECIFIC : The property is not host-specific, but was found in the host-specific section.
MISSING_INSTANCE_ID : An instance does not have the required ID property.
EMPTY_PROPERTY : An object or array property is empty.
KEY_IN_HOST_OVERRIDE : The configuration exists in both host-override and host-specific sections.
PLACEHOLDER_FOUND : The property contains a placeholder that must be replaced.
PROPERTY_NAME_MISMATCH : A property name does not match the required pattern.
MISSING_REQUIRED_PROFILE_INSTANCE : The host-specific configuration refers to an instance that does not exist in the profile section.
MISSING_REQUIRED_PROFILE_KEY : The host-specific configuration refers to a configuration key that does not exist in the profile section.
HOST_SPECIFIC_KEY_IN_OVERRIDE : A host-specific configuration was found in the host-override section.
UNION_CASE_WITHOUT_UNION_TAG : A union-case property was provided, but the corresponding union tag property was not set.
The pattern the property is required to match. This field is optional and it is only relevant when the value of DetailedValidationError.type is one of PATTERN_MISMATCH or PROPERTY_NAME_MISMATCH.
The expected type of the property. This field is optional and it is only relevant when the value of DetailedValidationError.type is INVALID_TYPE.
The instance ID that was duplicated or is missing from the profile section. This field is optional and it is only relevant when the value of DetailedValidationError.type is one of DUPLICATE_INSTANCE_ID or MISSING_REQUIRED_PROFILE_INSTANCE.
The name of the property that holds the instance ID. This field is optional and it is only relevant when the value of DetailedValidationError.type is MISSING_INSTANCE_ID.
The maximum length allowed for a string or array property. This field is optional and it is only relevant when the value of DetailedValidationError.type is one of MAX_STRING_LENGTH or MAX_ARRAY_LENGTH.
The minimum length allowed for a string or array property. This field is optional and it is only relevant when the value of DetailedValidationError.type is one of MIN_STRING_LENGTH or MIN_ARRAY_LENGTH.
The maximum allowed value for a property. This field is optional and it is only relevant when the value of DetailedValidationError.type is MAX_VALUE.
The minimum allowed value for a property. This field is optional and it is only relevant when the value of DetailedValidationError.type is MIN_VALUE.
The DependencyError structure contains details of the validation error caused by dependency between different properties in the configuration.
For SCHEMA_NOT_FOUND errors, this will be the component portion of the unknown configuration. This field is optional and it is only relevant when the value of DetailedValidationError.type is SCHEMA_NOT_FOUND.
For SCHEMA_NOT_FOUND errors, this will be the group portion of the unknown configuration. This field is optional and it is only relevant when the value of DetailedValidationError.type is SCHEMA_NOT_FOUND.
For SCHEMA_NOT_FOUND errors, this will be the key portion of the unknown configuration. This field is optional and it is only relevant when the value of DetailedValidationError.type is SCHEMA_NOT_FOUND.
The JSON-pointer to the configuration key in the profile section where the instance/key needs to be added. This field is optional and it is only relevant when the value of DetailedValidationError.type is one of MISSING_REQUIRED_PROFILE_INSTANCE or MISSING_REQUIRED_PROFILE_KEY.
The name of the required property that is missing from the profile section for this instance/key. This field is optional and it is only relevant when the value of DetailedValidationError.type is one of MISSING_REQUIRED_PROFILE_INSTANCE or MISSING_REQUIRED_PROFILE_KEY.