provenaclient.models.general

Created Date: Monday June 17th 2024 +1000 Author: Peter Baker —– Last Modified: Monday June 17th 2024 4:45:39 pm +1000 Modified By: Peter Baker —– Description: General interfaces defined to help with typing the client library/configuring —– HISTORY: Date By Comments ———- — ———————————————————

Attributes

DEFAULT_AWAIT_SETTINGS

Classes

`HealthCheckResponse`
`AsyncAwaitSettings`
`GraphProperty`
`CustomGraph`
`CustomLineageResponse`	A Custom Lineage Response Pydantic Model

Module Contents

class provenaclient.models.general.HealthCheckResponse[source]

Bases: pydantic.BaseModel

message: str

class provenaclient.models.general.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.general.DEFAULT_AWAIT_SETTINGS

class provenaclient.models.general.GraphProperty[source]

Bases: pydantic.BaseModel

type: str

source: str

target: str

class provenaclient.models.general.CustomGraph[source]

Bases: pydantic.BaseModel

directed: bool

multigraph: bool

graph: Dict[str, Any]

nodes: List[ProvenaInterfaces.RegistryAPI.Node]

links: List[GraphProperty]

class provenaclient.models.general.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