Skip to content

ExperimentDefinitionSummary

Source code in docs_src/capo_appconfig/types/experiment_definition_summary.py
class ExperimentDefinitionSummary(TypedDict, closed=True):
    application_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The application ID.</p>"""
    id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The experiment definition ID.</p>"""
    name: NotRequired["capo_appconfig.types.name.Name"]
    """<p>The name of the experiment definition.</p>"""
    hypothesis: NotRequired["capo_appconfig.types.description.Description"]
    """<p>The hypothesis that the experiment is designed to validate.</p>"""
    status: NotRequired[
        "capo_appconfig.types.experiment_definition_status.ExperimentDefinitionStatus"
    ]
    """<p>The current status of the experiment definition.</p>"""
    configuration_profile_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The configuration profile ID associated with the experiment.</p>"""
    environment_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The environment ID where the experiment runs.</p>"""
    flag_key: NotRequired["capo_appconfig.types.flag_key.FlagKey"]
    """<p>The key of the feature flag used by the experiment.</p>"""
    created_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment definition was created, in ISO 8601 format.</p>"""
    updated_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>"""

application_id instance-attribute

application_id: NotRequired[Id]

The application ID.

configuration_profile_id instance-attribute

configuration_profile_id: NotRequired[Id]

The configuration profile ID associated with the experiment.

created_at instance-attribute

created_at: NotRequired[Iso8601DateTime]

The date and time the experiment definition was created, in ISO 8601 format.

environment_id instance-attribute

environment_id: NotRequired[Id]

The environment ID where the experiment runs.

flag_key instance-attribute

flag_key: NotRequired[FlagKey]

The key of the feature flag used by the experiment.

hypothesis instance-attribute

hypothesis: NotRequired[Description]

The hypothesis that the experiment is designed to validate.

id instance-attribute

id: NotRequired[Id]

The experiment definition ID.

name instance-attribute

name: NotRequired[Name]

The name of the experiment definition.

status instance-attribute

status: NotRequired[ExperimentDefinitionStatus]

The current status of the experiment definition.

updated_at instance-attribute

updated_at: NotRequired[Iso8601DateTime]

The date and time the experiment definition was last updated, in ISO 8601 format.