Skip to main content

decentriq_platform.archv2

Sub-modules​

  • decentriq_platform.archv2.client
  • decentriq_platform.archv2.release_policy_builder
  • decentriq_platform.archv2.secret
  • decentriq_platform.archv2.session

Classes​

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_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_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)],
) ‑> decentriq_platform.archv2.client.Job

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_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_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

stop_data_room​

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

JobStatus​

JobStatus(
    value,
    names=None,
    *,
    module=None,
    qualname=None,
    type=None,
    start=1,
)

An enumeration.

Ancestors (in MRO)

  • builtins.str
  • enum.Enum

Secret​

Secret(
    secret: bytes,
    state: decentriq_dcr_compiler._schemas.secret_store_entry_state.SecretStoreEntryState,
)

Secret(secret: bytes, state: decentriq_dcr_compiler._schemas.secret_store_entry_state.SecretStoreEntryState)

SessionV2​

SessionV2(
    client: Client,
    connection: Connection,
)

Class for managing the communication with an enclave.

Session instances should not be instantiated directly but rather be created using a Client object using decentriq_platform.Client.create_session_v2.

create_policy​

def create_policy(
    self,
    policy: ReleasePolicy,
) ‑> str

Create a release policy and return the policy ID.

create_secret​

def create_secret(
    self,
    secret: Secret,
) ‑> str

Store a secret in the user's own enclave-protected secret store

get_dataset_secret_id​

def get_dataset_secret_id(
    self,
    manifest_hash: str,
) ‑> str

get_secret​

def get_secret(
    self,
    secret_id: str,
) ‑> Tuple[decentriq_platform.archv2.secret.Secret, int]

remove_secret​

def remove_secret(
    self,
    secret_id: str,
    expected_cas_index: int,
) ‑> bool

send_authenticated_request​

def send_authenticated_request(
    self,
    authenticated_request: AuthenticatedRequest,
) ‑> gcg_pb2.AuthenticatedResponse

send_data_room_state_action_request​

def send_data_room_state_action_request(
    self,
    data_room_id: str,
    action: JSONType,
) ‑> Union[Dict[str, JSONType], List[JSONType], str, int, float, bool, ForwardRef(None)]

Send a DCR action request.

send_export_result_as_dataset_request​

def send_export_result_as_dataset_request(
    self,
    job_id: str,
    task_result_hash: str,
    zip_path: Optional[str],
) ‑> Tuple[str, str, str]

Export a result as a dataset.

send_get_verification_key_request​

def send_get_verification_key_request(
    self,
) ‑> bytes

Retrieve the verification key for a DCR.

send_retrieve_result_encryption_key_request​

def send_retrieve_result_encryption_key_request(
    self,
    job_id: str,
    task_result_hash: str,
) ‑> Tuple[str, bytes]

Retrieve the manifest hash and encryption key for a result.

send_secret_store_request​

def send_secret_store_request(
    self,
    request: SecretStoreRequest,
) ‑> secret_store_pb2.SecretStoreResponse

update_secret_acl​

def update_secret_acl(
    self,
    secret_id: str,
    new_acl: v0.SecretStoreEntryAcl,
    expected_cas_index: int,
) ‑> bool

Update a secret ACL