Skip to main content

decentriq_platform.archv2.pipeline

Variables​

PipelineConflict : The body of a pipeline 409 (ConflictError.body), discriminated by error.

Functions​

cadence_schedule​

def cadence_schedule(
    kind: PipelineScheduleKind,
) ‑> decentriq_platform.archv2.pipeline.CadenceSchedule

A cadence-only schedule; the platform chooses the time of day.

custom_schedule​

def custom_schedule(
    recurrence: Recurrence,
    time: str,
    timezone: str,
    starts_on: Optional[str] = None,
) ‑> decentriq_platform.archv2.pipeline.CustomSchedule

E.g. custom_schedule(every_n_weeks(2, [Weekday.MONDAY]), "09:00", "Europe/Zurich").

every_n_days​

def every_n_days(
    interval: int,
) ‑> decentriq_platform.archv2.pipeline.DayRecurrence

every_n_weeks​

def every_n_weeks(
    interval: int,
    weekdays: List[Weekday],
) ‑> decentriq_platform.archv2.pipeline.WeekRecurrence

manual_schedule​

def manual_schedule(
) ‑> decentriq_platform.archv2.pipeline.CadenceSchedule

A pipeline that only runs when triggered.

pipeline_step​

def pipeline_step(
    key: str,
    dcr_id: str,
    action: JSONType,
    depends_on: Optional[List[str]] = None,
) ‑> decentriq_platform.archv2.pipeline.PipelineStep

Build a step from the action's JSON dict (the same shape create_job takes; a pydantic action is passed as action.model_dump(mode="json")).

Classes​

AlreadyTerminalConflict​

AlreadyTerminalConflict(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

CadenceSchedule​

CadenceSchedule(
    *args,
    **kwargs,
)

MANUAL never fires on its own. DAILY/WEEKLY/MONTHLY: the platform picks the time (PipelineView.nextFireAt shows it, and it may move).

Ancestors (in MRO)

  • builtins.dict

ConcurrentUpdateConflict​

ConcurrentUpdateConflict(
    *args,
    **kwargs,
)

The pipeline kept changing concurrently with the update; nothing was written.

Ancestors (in MRO)

  • builtins.dict

CreatePipeline​

CreatePipeline(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

CustomSchedule​

CustomSchedule(
    *args,
    **kwargs,
)

A fully user-specified recurrence in local time, as submitted: time is HH:MM (or HH:MM:SS on a whole minute; returned as HH:MM:SS) in the IANA timezone, converted per occurrence. startsOn (a local date between 2000-01-01 and 2100-12-31) anchors the interval; omitted on an update it keeps the stored anchor, on a create it defaults to today in timezone.

Ancestors (in MRO)

  • builtins.dict

CustomScheduleView​

CustomScheduleView(
    *args,
    **kwargs,
)

A custom schedule as stored; startsOn is always present.

Ancestors (in MRO)

  • builtins.dict

DayRecurrence​

DayRecurrence(
    *args,
    **kwargs,
)

Every interval days (1..=365), counted from the schedule's startsOn.

Ancestors (in MRO)

  • builtins.dict

ManualPipelineTrigger​

ManualPipelineTrigger(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

PaginationMetadata​

PaginationMetadata(
    *args,
    **kwargs,
)

Cursors for the neighboring pages; a null nextCursor means the last page.

Ancestors (in MRO)

  • builtins.dict

PipelineIssue​

PipelineIssue(
    *args,
    **kwargs,
)

A definition problem detected at read time: creation/update validated the step, but its data room has been deleted (DCR_NOT_FOUND) or stopped (DCR_STOPPED) since.

Ancestors (in MRO)

  • builtins.dict

PipelineRef​

PipelineRef(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

PipelineRunHeaderView​

PipelineRunHeaderView(
    *args,
    **kwargs,
)

A run without its steps — the lastRun and lastSuccessfulRun embeds on a pipeline.

Ancestors (in MRO)

  • builtins.dict

PipelineRunStatus​

PipelineRunStatus(
    *args,
    **kwds,
)

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum

PipelineRunTriggerKind​

PipelineRunTriggerKind(
    *args,
    **kwds,
)

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum

PipelineRunView​

PipelineRunView(
    *args,
    **kwargs,
)

A run with its steps, from the definition as of firing.

Ancestors (in MRO)

  • builtins.dict

PipelineRunsPage​

PipelineRunsPage(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

PipelineScheduleKind​

PipelineScheduleKind(
    *args,
    **kwds,
)

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum

PipelineStep​

PipelineStep(
    *args,
    **kwargs,
)

One step of a pipeline as submitted: a DCR compute action plus the keys of the steps that must succeed before it fires. key is client-chosen, unique within the pipeline, 1 to 64 characters of A-Z a-z 0-9 _ -. action is the kind-tagged action JSON (the same shape create_job sends, as an object). A pipeline has 1 to 50 steps.

Ancestors (in MRO)

  • builtins.dict

PipelineStepFailure​

PipelineStepFailure(
    *args,
    **kwargs,
)

Why a step did not succeed; pick the message from kind. dependencyKey is present only on DEPENDENCY_NOT_SUCCEEDED; detail (the underlying error, for debugging rather than display) only on OWNER_FORBIDDEN, INVALID_STEP and FIRING_FAILED. On RUN_CANCELLED a step that had fired keeps its runId, and that job run carries on by itself.

Ancestors (in MRO)

  • builtins.dict

PipelineStepView​

PipelineStepView(
    *args,
    **kwargs,
)

A step as stored. dcr is None when the data room no longer exists (also reported as a DCR_NOT_FOUND issue).

Ancestors (in MRO)

  • builtins.dict

PipelineUsage​

PipelineUsage(
    *args,
    **kwargs,
)

The live pipelines with a step on a data room: how many in total, and the caller's own by name. Deleting or stopping the data room breaks their steps on it; the pipelines keep running the rest.

Ancestors (in MRO)

  • builtins.dict

PipelineView​

PipelineView(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

PipelinesPage​

PipelinesPage(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

RunInFlightConflict​

RunInFlightConflict(
    *args,
    **kwargs,
)

Schedule/steps writes, deletes and new runs wait for this run.

Ancestors (in MRO)

  • builtins.dict

SchedulePipelineTrigger​

SchedulePipelineTrigger(
    *args,
    **kwargs,
)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors (in MRO)

  • builtins.dict

StepDcr​

StepDcr(
    *args,
    **kwargs,
)

What a step's data room is, without a data room fetch.

Ancestors (in MRO)

  • builtins.dict

StepRunStatus​

StepRunStatus(
    *args,
    **kwds,
)

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum

StepRunView​

StepRunView(
    *args,
    **kwargs,
)

A step's execution within a run. runId/jobId are set once fired and address the underlying compute (get_job_run, get_job_tasks, ...); a step cancelled after it fired keeps them, as its job run carries on.

Ancestors (in MRO)

  • builtins.dict

UpdatePipeline​

UpdatePipeline(
    *args,
    **kwargs,
)

Partial update: absent fields keep their stored value. schedule and steps replace the stored value whole; scheduleEnabled turns the schedule on or off.

Ancestors (in MRO)

  • builtins.dict

UserRef​

UserRef(
    *args,
    **kwargs,
)

A user, with the email resolved; a deleted user has an anonymized email.

Ancestors (in MRO)

  • builtins.dict

WeekRecurrence​

WeekRecurrence(
    *args,
    **kwargs,
)

Every interval weeks (1..=52), counted from the Monday of the week of startsOn, on each listed weekday (at least one; stored sorted Monday first, without repeats).

Ancestors (in MRO)

  • builtins.dict

Weekday​

Weekday(
    *args,
    **kwds,
)

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum