Skip to content

pd_cds_api.conditions

pd_cds_api.conditions

Query-parameter model for a run-conditions request.

pd_cds_api.conditions.RunConditions

Bases: BaseModel

One conditions query: a folder plus a time point or closed interval.

A t0 without t1 requests the value in effect at that point (wire form t=<t0>); supplying t1 requests the inclusive interval t0..t1 (wire form t0=..&t1=..). Time values are experiment timestamps (e.g. run numbers), not wall-clock times.

This model carries what to query; connection details live in :class:~pd_cds_api.state.ApiClientState.

data_type = Field(default=None, description='Restrict the payload to a single data type; ``None`` returns all data types.') class-attribute instance-attribute

folder = Field(description='Conditions folder path, e.g. ``pdunesp.run_conditionstest``.') class-attribute instance-attribute

t0 = Field(description='Beginning timestamp, or sole timestamp when ``t1`` is unset.') class-attribute instance-attribute

t1 = Field(default=None, description='End timestamp of a range query; omit for a point query.') class-attribute instance-attribute