io.fabric8.generator.annotation

Annotation Type ValidationRule

@Repeatable(value=ValidationRules.class)
 @Target(value={ANNOTATION_TYPE,FIELD,METHOD,TYPE})
 @Retention(value=RUNTIME)
public @interface ValidationRule

A Kubernetes validation rule.

See Also:

Kubernetes Docs - CRD Validation

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The validation rule.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	fieldPath The field path of the validation rule.
String	message The static message of the validation rule.
String	messageExpression The messageExpression of the validation rule.
boolean	optionalOldSelf The optionalOldSelf field is a boolean field that alters the behavior of Transition Rules described below.
String	reason The machine-readable validation failure reason.

Element Detail

value

public abstract String value

The validation rule.

Returns:

the validation rule Kubernetes Docs - CRD Validation - rule

message

public abstract String message

The static message of the validation rule.

If you want to set a static message, you can supply message rather than messageExpression(). The value of message is used as an opaque error string if validation fails

Returns:

the message

See Also:

Kubernetes Docs - CRD Validation - message

Default:

""

messageExpression

public abstract String messageExpression

The messageExpression of the validation rule.

Similar to the message() field, which defines the string reported for a validation rule failure, messageExpression allows you to use a CEL expression to construct the message string.

Returns:

the messageExpression

See Also:

Kubernetes Docs - CRD Validation - messageExpression

Default:

""

reason

public abstract String reason

The machine-readable validation failure reason.

The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set or for unknown reasons, it defaults to "FieldValueInvalid".

Returns:

the reason

See Also:

Kubernetes Docs - CRD Validation - reason

Default:

""

fieldPath

public abstract String fieldPath

The field path of the validation rule.

Specifies the field to be returned when the validation fails.

Returns:

the fieldPath

See Also:

Kubernetes Docs - CRD Validation - fieldPath

Default:

""

optionalOldSelf

public abstract boolean optionalOldSelf

The optionalOldSelf field is a boolean field that alters the behavior of Transition Rules described below. Normally, a transition rule will not evaluate if oldSelf cannot be determined: during object creation or when a new value is introduced in an update. If optionalOldSelf is set to true, then transition rules will always be evaluated and the type of oldSelf will be changed to a CEL Optional type. The feature CRDValidationRatcheting must be enabled in order to make use of this field.

Returns:

optionalOldSelf

See Also:

Kubernetes Docs - CRD Validation - optionalOldSelf

Default:

false