Parameters

albert.resources.parameters

ParameterCategory

Bases: str, Enum

The category of a parameter

Attributes:

Name	Type	Description
NORMAL
SPECIAL

NORMAL

NORMAL = 'Normal'

SPECIAL

SPECIAL = 'Special'

Parameter

Bases: BaseResource

A parameter in Albert.

Attributes:

Name	Type	Description
name	str	The name of the parameter. Names must be unique.
id	str | None	The Albert ID of the parameter. Set when the parameter is retrieved from Albert.
category	ParameterCategory	The category of the parameter. Allowed values are Normal and Special. Read-only.
rank	int	The rank of the returned parameter. Read-only.

name

name: str

id

id: str | None = Field(alias='albertId', default=None)

metadata

metadata: dict[str, MetadataItem] | None = Field(
    alias="Metadata", default=None
)

category

category: ParameterCategory | None = Field(
    default=None, exclude=True, frozen=True
)

rank

rank: int | None = Field(
    default=None, exclude=True, frozen=True
)

required

required: bool | None = Field(default=None, exclude=True)