Skip to content

TestRecommendation

Source code in docs_src/capo_resiliencehub/types/test_recommendation.py
class TestRecommendation(TypedDict, closed=True):
    recommendation_id: NotRequired["capo_resiliencehub.types.uuid.Uuid"]
    """<p>Identifier for the test recommendation.</p>"""
    reference_id: "capo_resiliencehub.types.spec_reference_id.SpecReferenceId"
    """<p>Reference identifier for the test recommendation.</p>"""
    app_component_id: NotRequired[
        "capo_resiliencehub.types.entity_name255.EntityName255"
    ]
    """<p>Indicates the identifier of the AppComponent.</p>"""
    app_component_name: NotRequired["capo_resiliencehub.types.entity_id.EntityId"]
    """<p>Name of the Application Component.</p>"""
    name: NotRequired["capo_resiliencehub.types.document_name.DocumentName"]
    """<p>Name of the test recommendation.</p>"""
    intent: NotRequired["capo_resiliencehub.types.entity_description.EntityDescription"]
    """<p>Intent of the test recommendation.</p>"""
    risk: NotRequired["capo_resiliencehub.types.test_risk.TestRisk"]
    """<p>Level of risk for this test recommendation.</p>"""
    type: NotRequired["capo_resiliencehub.types.test_type.TestType"]
    """<p>Type of test recommendation.</p>"""
    description: NotRequired["capo_resiliencehub.types.string500.String500"]
    """<p>Description for the test recommendation.</p>"""
    items: NotRequired[
        "capo_resiliencehub.types.recommendation_item_list.RecommendationItemList"
    ]
    """<p>The test recommendation items.</p>"""
    prerequisite: NotRequired["capo_resiliencehub.types.string500.String500"]
    """<p>Prerequisite of the test recommendation.</p>"""
    depends_on_alarms: NotRequired[
        "capo_resiliencehub.types.alarm_reference_id_list.AlarmReferenceIdList"
    ]
    """<p> A list of recommended alarms that are used in the test and must be exported before or with the test. </p>"""
    recommendation_status: NotRequired[
        "capo_resiliencehub.types.recommendation_status.RecommendationStatus"
    ]
    """<p>Status of the recommended test.</p>"""

app_component_id instance-attribute

app_component_id: NotRequired[EntityName255]

Indicates the identifier of the AppComponent.

app_component_name instance-attribute

app_component_name: NotRequired[EntityId]

Name of the Application Component.

depends_on_alarms instance-attribute

depends_on_alarms: NotRequired[AlarmReferenceIdList]

A list of recommended alarms that are used in the test and must be exported before or with the test.

description instance-attribute

description: NotRequired[String500]

Description for the test recommendation.

intent instance-attribute

intent: NotRequired[EntityDescription]

Intent of the test recommendation.

items instance-attribute

items: NotRequired[RecommendationItemList]

The test recommendation items.

name instance-attribute

name: NotRequired[DocumentName]

Name of the test recommendation.

prerequisite instance-attribute

prerequisite: NotRequired[String500]

Prerequisite of the test recommendation.

recommendation_id instance-attribute

recommendation_id: NotRequired[Uuid]

Identifier for the test recommendation.

recommendation_status instance-attribute

recommendation_status: NotRequired[RecommendationStatus]

Status of the recommended test.

reference_id instance-attribute

reference_id: SpecReferenceId

Reference identifier for the test recommendation.

risk instance-attribute

risk: NotRequired[TestRisk]

Level of risk for this test recommendation.

type instance-attribute

type: NotRequired[TestType]

Type of test recommendation.