Parameter

No overview available.

Attributes

Attribute	Type	Description
name	PyBackedStr	The identifier of the parameter used for mapping and retrieval within the system.
mode	[ParameterMode](parametermode.md?sid=validators_arguments_v3_parametermode)	Defines the operational behavior and input/output characteristics of the parameter.
lookup_path_collection	[LookupPathCollection](../../../lookup/key/lookuppathcollection.md?sid=lookup_key_lookuppathcollection)	A collection of paths used to resolve the parameter's value from various data sources.
validator	Arc< CombinedValidator >	The validation logic used to ensure the parameter value meets all defined constraints and types.

---

Constructor

Signature

def Parameter(
    name: PyBackedStr,
    mode: [ParameterMode](parametermode.md?sid=validators_arguments_v3_parametermode),
    lookup_path_collection: [LookupPathCollection](../../../lookup/key/lookuppathcollection.md?sid=lookup_key_lookuppathcollection),
    validator: Arc< CombinedValidator >
)

Parameters

Name	Type	Description
name	PyBackedStr	The name of the parameter.
mode	[ParameterMode](parametermode.md?sid=validators_arguments_v3_parametermode)	The mode of the parameter (e.g., positional, keyword).
lookup_path_collection	[LookupPathCollection](../../../lookup/key/lookuppathcollection.md?sid=lookup_key_lookuppathcollection)	The collection of paths used to look up the parameter value.
validator	Arc< CombinedValidator >	The validator used to validate the parameter value.

---

Methods

---

name()

def name() - > PyBackedStr

Retrieves the unique identifier of the parameter used for mapping and reference within the schema.

Returns

Type	Description
PyBackedStr	The string representation of the parameter name.

---

mode()

def mode() - > [ParameterMode](parametermode.md?sid=validators_arguments_v3_parametermode)

Determines the operational mode of the parameter, defining how it should be processed or accessed.

Returns

Type	Description
[ParameterMode](parametermode.md?sid=validators_arguments_v3_parametermode)	The mode configuration governing the parameter's behavior.

---

lookup_path_collection()

def lookup_path_collection() - > [LookupPathCollection](../../../lookup/key/lookuppathcollection.md?sid=lookup_key_lookuppathcollection)

Provides the collection of paths used to locate the parameter's value within a data structure.

Returns

Type	Description
[LookupPathCollection](../../../lookup/key/lookuppathcollection.md?sid=lookup_key_lookuppathcollection)	A collection of lookup paths associated with this parameter.

---

validator()

def validator() - > Arc< CombinedValidator >

Accesses the validation logic used to ensure the parameter value meets defined constraints and types.

Returns

Type	Description
Arc< CombinedValidator >	An atomic reference counted pointer to the combined validator instance.

---