provenaclient.models

Submodules

Attributes

DEFAULT_AWAIT_SETTINGS

Classes

`SearchItem`
`LoadedSearchItem`
`UnauthorisedSearchItem`
`FailedSearchItem`
`RevertMetadata`
`LoadedSearchResponse`
`HealthCheckResponse`
`AsyncAwaitSettings`
`GraphProperty`
`CustomGraph`
`CustomLineageResponse`	A Custom Lineage Response Pydantic Model

Package Contents

class provenaclient.models.SearchItem[source]

Bases: pydantic.BaseModel

id: str

score: float

class provenaclient.models.LoadedSearchItem[source]

Bases: SearchItem

item: ProvenaInterfaces.RegistryModels.ItemDataset

class provenaclient.models.UnauthorisedSearchItem[source]: Bases: SearchItem

class provenaclient.models.FailedSearchItem[source]

Bases: SearchItem

error_info: str

class provenaclient.models.RevertMetadata[source]

Bases: pydantic.BaseModel

id: str

history_id: int

reason: str

class provenaclient.models.LoadedSearchResponse[source]

Bases: pydantic.BaseModel

items: List[LoadedSearchItem]

auth_errors: List[UnauthorisedSearchItem]

misc_errors: List[FailedSearchItem]

class provenaclient.models.HealthCheckResponse[source]

Bases: pydantic.BaseModel

message: str

class provenaclient.models.AsyncAwaitSettings[source]

Bases: pydantic.BaseModel

job_polling_interval: int = 2

job_async_queue_delay_polling_timeout = 20

job_async_pending_polling_timeout = 120

job_async_in_progress_polling_timeout = 180

provenaclient.models.DEFAULT_AWAIT_SETTINGS

class provenaclient.models.GraphProperty[source]

Bases: pydantic.BaseModel

type: str

source: str

target: str

class provenaclient.models.CustomGraph[source]

Bases: pydantic.BaseModel

directed: bool

multigraph: bool

graph: Dict[str, Any]

nodes: List[ProvenaInterfaces.RegistryAPI.Node]

links: List[GraphProperty]

class provenaclient.models.CustomLineageResponse[source]

Bases: ProvenaInterfaces.ProvenanceAPI.LineageResponse

A Custom Lineage Response Pydantic Model that inherits from its parent (LineageResponse).

This model overrides the “graph” field within the Lineage Response, and converts it from an untyped dictionary into a pydantic object/ typed datatype.

The custom validator function is called, and has custom parsing logic to parse the nodes as well.

graph: CustomGraph | None