Skip to content

Validation

Source code in docs_src/capo_connect/types/validation.py
class Validation(TypedDict, closed=True):
    min_length: "capo_connect.types.length_boundary.LengthBoundary"
    """<p>The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.</p>"""
    max_length: "capo_connect.types.length_boundary.LengthBoundary"
    """<p>The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.</p>"""
    min_values: "capo_connect.types.value_boundary.ValueBoundary"
    """<p>The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.</p>"""
    max_values: "capo_connect.types.value_boundary.ValueBoundary"
    """<p>The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.</p>"""
    ignore_case: "capo_connect.types.boolean.Boolean"
    """<p>Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.</p>"""
    minimum: "capo_connect.types.positive_and_negative_double.PositiveAndNegativeDouble"
    """<p>The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.</p>"""
    maximum: "capo_connect.types.positive_and_negative_double.PositiveAndNegativeDouble"
    """<p>The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.</p>"""
    exclusive_minimum: (
        "capo_connect.types.positive_and_negative_double.PositiveAndNegativeDouble"
    )
    """<p>The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.</p>"""
    exclusive_maximum: (
        "capo_connect.types.positive_and_negative_double.PositiveAndNegativeDouble"
    )
    """<p>The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.</p>"""
    multiple_of: "capo_connect.types.positive_double.PositiveDouble"
    """<p>Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.</p>"""
    enum: NotRequired["capo_connect.types.validation_enum.ValidationEnum"]
    """<p>Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.</p>"""

enum instance-attribute

enum: NotRequired[ValidationEnum]

Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.

exclusive_maximum instance-attribute

exclusive_maximum: PositiveAndNegativeDouble

The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.

exclusive_minimum instance-attribute

exclusive_minimum: PositiveAndNegativeDouble

The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.

ignore_case instance-attribute

ignore_case: Boolean

Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.

max_length instance-attribute

max_length: LengthBoundary

The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.

max_values instance-attribute

max_values: ValueBoundary

The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.

maximum instance-attribute

The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.

min_length instance-attribute

min_length: LengthBoundary

The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.

min_values instance-attribute

min_values: ValueBoundary

The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.

minimum instance-attribute

The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.

multiple_of instance-attribute

multiple_of: PositiveDouble

Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.