Skip to main content

decentriq_platform.archv2.client

Classes​

Action​

Action(
    *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

AdminRetriggerTrigger​

AdminRetriggerTrigger(
    *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

ClientV2​

ClientV2(
    api: decentriq_platform.api.Api,
)

check_data_labs_compatibility​

def check_data_labs_compatibility(
    self,
    data_room_id: str,
    data_lab_ids: List[str],
) ‑> decentriq_platform.archv2.client.DataLabCompatibilityResponse

create_data_lab​

def create_data_lab(
    self,
    create_data_lab: Union[Dict[str, ForwardRef('JSONType')], List[ForwardRef('JSONType')], str, int, float, bool, ForwardRef(None)],
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.DataLabV2

create_data_room​

def create_data_room(
    self,
    create_data_room: Union[Dict[str, ForwardRef('JSONType')], List[ForwardRef('JSONType')], str, int, float, bool, ForwardRef(None)],
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.DataRoom

create_import_connector​

def create_import_connector(
    self,
    create_import_connector: Union[Dict[str, ForwardRef('JSONType')], List[ForwardRef('JSONType')], str, int, float, bool, ForwardRef(None)],
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.DataRoom

Create an import-connector DCR through the dedicated endpoint (which tags it with the ImportConnector purpose, so it appears in get_import_connectors). Returns the created connector as a draft DCR: it has no materialization yet, so it is a plain DCR until the configuration wizard finalizes it — fetch the full connector via get_import_connector once it is ready.

create_job​

def create_job(
    self,
    data_room_id: str,
    data_room_compute_action: Union[Dict[str, ForwardRef('JSONType')], List[ForwardRef('JSONType')], str, int, float, bool, ForwardRef(None)],
    freshness_token: Optional[str] = None,
    mode: Optional[Literal['always', 'if_stale']] = None,
) ‑> decentriq_platform.archv2.client.CreatedJob

Fire a compute action.

mode="if_stale" reuses the action's newest completed run when it belongs to the job the current state derives (that state's materialization is the current one) instead of running again; the returned run_status is COMPLETED iff a run was reused.

delete_data_lab​

def delete_data_lab(
    self,
    data_lab_id: str,
) ‑> None

delete_import_connector​

def delete_import_connector(
    self,
    import_connector_id: str,
) ‑> None

Delete an import-connector DCR. Only the owner or a super admin may delete it.

download_job_raw_errors​

def download_job_raw_errors(
    self,
    job_id: str,
) ‑> decentriq_platform.archv2.client.RawErrorsView

get_data_lab​

def get_data_lab(
    self,
    data_lab_id: str,
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.DataLabV2

get_data_labs​

def get_data_labs(
    self,
    user_id: str,
    verification_key: bytes,
) ‑> List[decentriq_platform.archv2.client.DataLabV2]

get_data_room​

def get_data_room(
    self,
    data_room_id: str,
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.DataRoom

get_data_room_action_info​

def get_data_room_action_info(
    self,
    data_room_id: str,
    data_room_compute_action: Union[Dict[str, ForwardRef('JSONType')], List[ForwardRef('JSONType')], str, int, float, bool, ForwardRef(None)],
) ‑> decentriq_platform.archv2.client.Action

get_data_room_actions​

def get_data_room_actions(
    self,
    data_room_id: str,
) ‑> decentriq_platform.archv2.client.DataRoomActionsView

get_data_room_audit_log​

def get_data_room_audit_log(
    self,
    data_room_id: str,
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.DataRoomAuditLog

get_data_room_policies​

def get_data_room_policies(
    self,
    data_room_id: str,
    policy_ids: List[str],
) ‑> Dict[str, Union[decentriq_platform.archv2.client.PolicyNotFound, decentriq_platform.archv2.client.PolicyNotProvisioned, decentriq_platform.archv2.client.PolicyMetadata]]

get_import_connector​

def get_import_connector(
    self,
    import_connector_id: str,
    verification_key: bytes,
) ‑> decentriq_platform.archv2.client.ImportConnector

Fetch a finalized import-connector DCR together with its single materialization. The DCR's signed content is verified; the materialization body is returned as received (verify via its signed content). 404s for a draft connector — fetch that via get_data_room.

get_import_connector_runs​

def get_import_connector_runs(
    self,
    import_connector_id: str,
    limit: Optional[int] = None,
    next_cursor: Optional[str] = None,
    prev_cursor: Optional[str] = None,
) ‑> decentriq_platform.archv2.client.ImportConnectorRunsPage

List one page of the connector's Import runs, newest first, cursor-paginated — validation runs are not part of the import history. Each run carries its materialization outcome inline; on success that includes the produced dataset as snapshotted at settlement (its manifestHash resolves to the dataset and, via Client.get_dataset_encryption_key_secret_id, to its key).

get_import_connectors​

def get_import_connectors(
    self,
    user_id: str,
    verification_key: bytes,
) ‑> List[decentriq_platform.archv2.client.DataRoom]

List the user's import connectors. Only finalized (ready) connectors are returned — connectors still in configuration are addressed by id via get_import_connector.

get_job​

def get_job(
    self,
    job_id: str,
) ‑> decentriq_platform.archv2.client.Job

get_job_freshness​

def get_job_freshness(
    self,
    job_id: str,
) ‑> bool

get_job_results_as_decentriq_user​

def get_job_results_as_decentriq_user(
    self,
    job_id: str,
) ‑> bytes

Fetch the result zip via GET /jobs/:job_id/results.

Requires a Decentriq SuperAdmin (or SuperAdminReadOnly) token and an MDCR created with share_aggregated_results=True. The enclave enforces check_api_platform_user_permission_for_result.

get_job_status​

def get_job_status(
    self,
    job_id: str,
) ‑> decentriq_platform.archv2.client.JobStatusView

get_job_tasks​

def get_job_tasks(
    self,
    job_id: str,
) ‑> decentriq_platform.archv2.client.JobTasksView

get_materialization​

def get_materialization(
    self,
    materialization_id: str,
) ‑> decentriq_platform.archv2.client.MaterializationView

Fetch a materialization and its execution history. Owner-scoped: visible to the creator, their org, or an admin.

get_run_status​

def get_run_status(
    self,
    run_id: str,
) ‑> decentriq_platform.archv2.client.RunView

list_data_room_runs​

def list_data_room_runs(
    self,
    data_room_id: str,
    action: Union[Dict[str, ForwardRef('JSONType')], List[ForwardRef('JSONType')], str, int, float, bool, ForwardRef(None)] = None,
    limit: Optional[int] = None,
    next_cursor: Optional[str] = None,
    prev_cursor: Optional[str] = None,
) ‑> decentriq_platform.archv2.client.RunsPage

List one page of the runs fired against the data room, newest first, cursor-paginated. action optionally narrows the listing to one compute action, given as action JSON.

list_materializations​

def list_materializations(
    self,
    user_id: str,
    limit: Optional[int] = None,
    next_cursor: Optional[str] = None,
    prev_cursor: Optional[str] = None,
) ‑> decentriq_platform.archv2.client.MaterializationsPage

List one page of the materializations created by the user, newest first, cursor-paginated. Owner-scoped like get_materialization: visible to the user, their org, or an admin. Execution history is omitted from list items — fetch it via get_materialization.

revoke_materialization​

def revoke_materialization(
    self,
    materialization_id: str,
) ‑> None

Revoke a materialization (tombstone it). Only the creator or a super admin may revoke; the enclave stops honoring it on the next run.

stop_data_room​

def stop_data_room(
    self,
    data_room_id: str,
) ‑> None

CreatedJob​

CreatedJob(
    *args,
    **kwargs,
)

A Job plus the run created (or joined) by firing it. run_status is COMPLETED iff an if_stale firing reused an existing run.

Ancestors (in MRO)

  • builtins.dict

DataLabCompatibilityResponse​

DataLabCompatibilityResponse(
    *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

DataLabV2​

DataLabV2(
    *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

DataRoom​

DataRoom(
    *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

DataRoomActionSummary​

DataRoomActionSummary(
    *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

DataRoomActionsView​

DataRoomActionsView(
    *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

DataRoomAuditLog​

DataRoomAuditLog(
    *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

DataRoomAuditLogUnverified​

DataRoomAuditLogUnverified(
    *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

ImportConnector​

ImportConnector(
    *args,
    **kwargs,
)

A finalized import-connector DCR together with the single materialization whose source is that DCR (GET /import-connectors/:id). Only finalized (ready) connectors are served here; a draft connector is a plain DCR fetched via get_data_room.

Ancestors (in MRO)

  • builtins.dict

ImportConnectorRunView​

ImportConnectorRunView(
    *args,
    **kwargs,
)

One run of an import connector's Import action (GET /import-connectors/:id/runs). completedAt is absent while the run is still in flight, materialization while the run's compute is still in flight.

Ancestors (in MRO)

  • builtins.dict

ImportConnectorRunsPage​

ImportConnectorRunsPage(
    *args,
    **kwargs,
)

One page of an import connector's runs plus pagination cursors. metadata is absent on an unpaginated response.

Ancestors (in MRO)

  • builtins.dict

Job​

Job(
    *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

JobStatus​

JobStatus(
    *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

JobStatusView​

JobStatusView(
    *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

JobTasksView​

JobTasksView(
    *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

MaterializationExecution​

MaterializationExecution(
    *args,
    **kwargs,
)

One execution of a materialization on a run. The dataset it produced is provenance-linked on the dataset side, not here. completedAt is absent while the execution is in flight; failureReason only on failure.

Ancestors (in MRO)

  • builtins.dict

MaterializationStatus​

MaterializationStatus(
    *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

MaterializationSummaryView​

MaterializationSummaryView(
    *args,
    **kwargs,
)

A materialization list item (GET /users/:user_id/materializations). Omits the execution history — fetch it per materialization via get_materialization.

Ancestors (in MRO)

  • builtins.dict

MaterializationView​

MaterializationView(
    *args,
    **kwargs,
)

A materialization + its full execution history (GET /materializations/:id). Owner-scoped: the per-materialization detail does not live on the run.

The signed Materialization entity is returned encoded in signedContent so the caller can verify the enclave signature and decode its fields (source, createdBy, …) themselves — mirroring the job/dataroom endpoints. Only executions (the run-side ledger, not part of the entry) is a separate field.

Ancestors (in MRO)

  • builtins.dict

MaterializationsPage​

MaterializationsPage(
    *args,
    **kwargs,
)

One page of a user's materializations plus pagination cursors. metadata is absent on an unpaginated response.

Ancestors (in MRO)

  • builtins.dict

MaterializedDataset​

MaterializedDataset(
    *args,
    **kwargs,
)

The produced dataset as snapshotted at materialization settlement — kept even after the dataset itself is deleted (then flagged deleted).

Ancestors (in MRO)

  • builtins.dict

PaginatedDataLabsResponse​

PaginatedDataLabsResponse(
    *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

PolicyMetadata​

PolicyMetadata(
    *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

PolicyNotFound​

PolicyNotFound(
    *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

PolicyNotProvisioned​

PolicyNotProvisioned(
    *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

PolicyStatus​

PolicyStatus(
    *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

RawError​

RawError(
    *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

RawErrorsView​

RawErrorsView(
    *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

RunMaterialization​

RunMaterialization(
    *args,
    **kwargs,
)

A run's materialization outcome. The produced dataset exists only on SUCCESS (and is absent for executions settled before the snapshot existed); reason only on FAILED.

Ancestors (in MRO)

  • builtins.dict

RunStatus​

RunStatus(
    *args,
    **kwds,
)

View-only status of a run (the per-firing execution unit), distinct from the compute-level JobStatus. MATERIALIZATION_FAILED means compute succeeded but at least one materialization permanently failed.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum

RunTriggerKind​

RunTriggerKind(
    *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

RunView​

RunView(
    *args,
    **kwargs,
)

The compute lifecycle of a run. completedAt is absent while the run is still in flight.

Ancestors (in MRO)

  • builtins.dict

RunsPage​

RunsPage(
    *args,
    **kwargs,
)

One page of runs plus pagination cursors. metadata is absent on an unpaginated response.

Ancestors (in MRO)

  • builtins.dict

SignedContent​

SignedContent(
    *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

TaskView​

TaskView(
    *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

UserTrigger​

UserTrigger(
    *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