Skip to main content

aip_sdk.TestPlanRecord

aip_sdk.TestPlanRecord(id: str, workspace_id: str, name: str, version: int, plan: TestPlan, user_id: str, created_at: datetime | None, updated_at: datetime | None, applicable_quality_checks: list[str], required_columns: list[str], replayed: bool)

A version this call just published — what publish_test_plan and publish_test_plan_version return.

Carries what publishing can answer, and nothing a publish does not report. Reading a version back resolves it against the catalogue as it stands at that moment, which publishing does not do — get_test_plan returns a TestPlanDetail for that, and this type does not have those fields rather than carrying them unset.

Attributes

  • required_columns list[str]: Every column a dataset needs for the plan's metrics to score, as of this publish. Never stored: the platform derives it fresh from the metric catalogue on every read, so this same version can report a longer list once one of its metrics gains a required column. This value is therefore a snapshot of the moment you published; get_test_plan is the live read of the same version. An empty list means the plan genuinely needs no columns.
  • replayed bool: True when this is a prior publish's outcome, returned because this call's (internally generated) idempotency key matched an earlier one, rather than because this call stored anything new. In practice this only happens when this SDK itself retried a lost response — two ordinary publish_test_plan calls never share a key.

aip_sdk.TestPlanRecord.replayed​

aip_sdk.TestPlanRecord.replayed: bool

No docstring is defined in the source.

aip_sdk.TestPlanRecord.required_columns​

aip_sdk.TestPlanRecord.required_columns: list[str]

No docstring is defined in the source.

Inherited members​

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.applicable_quality_checks​

aip_sdk.TestPlanRecord.applicable_quality_checks: list[str]

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.created_at​

aip_sdk.TestPlanRecord.created_at: datetime | None

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.id​

aip_sdk.TestPlanRecord.id: str

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.name​

aip_sdk.TestPlanRecord.name: str

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.plan​

aip_sdk.TestPlanRecord.plan: TestPlan

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.updated_at​

aip_sdk.TestPlanRecord.updated_at: datetime | None

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.user_id​

aip_sdk.TestPlanRecord.user_id: str

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.version​

aip_sdk.TestPlanRecord.version: int

No docstring is defined in the source.

Inherited from libs/aip-sdk/src/aip_sdk/test_plan.py

aip_sdk.TestPlanRecord.workspace_id​

aip_sdk.TestPlanRecord.workspace_id: str

No docstring is defined in the source.