Common types

Shared data types used across the SDK: archiving, pagination, filtering, and validation.

info

All data types support standard serialization methods (to_json, from_json, to_dict, from_dict, to_str) which are omitted from the tables below.

Archive

Attributes:

Name	Type	Description
reason	str

ArchiveStatus

Enum for archive status.

Attributes:

Name	Type	Description
ARCHIVED	—
ACTIVE	—
ALL	—

ArchiveStatusName

Attributes:

Name	Type	Description
ARCHIVED	—
ACTIVE	—

ResourceArchiveStatus

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	ArchiveStatusName
reason	Optional[str]
created_by_id	Optional[str]
resource_id	str

Restore

Attributes:

Name	Type	Description
reason	str

Pageable

A generic paginated response model for handling lists of items.

Attributes:

Name	Type	Description
items	List[T]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

Methods:

Name	Description
iter_pages	Iterate over all pages using the configured list method.
iter_items	Iterate over all items across all pages.

FilterBy

Enum for filtering entities based on different criteria.

Attributes:

Name	Type	Description
MINUS_CREATED_BY_ID	—
CREATED_BY_ID	—

PatchOp

Attributes:

Name	Type	Description
SET	—
DELETE	—

Readable

Abstract base class for objects that expose readable file-like content.

Methods:

Name	Description
read_bytes	Read the contents as raw bytes.
read_text	Read the contents as decoded text.
copy_to	Copy the contents to a local file.
read_json	Parse the contents as JSON.
cleanup_cache	Clean up cached files if they exist.
get_cache_stats	Get filesystem cache statistics.

Shareable

Helper class that provides a standard way to create an ABC using

Methods:

Name	Description
create_access	Create a new access relationship for a subject by ID.
create_access_by_email	Create a new access relationship for a subject by email.
update_access	Update an existing access relationship for a subject.
remove_access	Remove an existing access relationship.
list_access	List all access relationships for this resource.

Archivable

Abstract mixin class for archivable and restorable resources.

Methods:

Name	Description
archive	Archive the current item using the client’s archive method for this resource type.
restore	Restore the current item using the client’s restore method for this resource type.

ClientHaving

Mixin for models that require access to a ClientApi instance.

ResourceType

Enum for resource types.

Attributes:

Name	Type	Description
MODEL	—
ARTIFACT	—
COMMENT	—
JOB	—

UsabilityStatusName

Attributes:

Name	Type	Description
SUPPORTED	—
DEPRECATED	—

UsabilityStatusParams

Attributes:

Name	Type	Description
SUPPORTED	—
DEPRECATED	—
ALL	—

TemporaryURL

Data transfer object for holding signed temporary urls and their expiry date times.

Attributes:

Name	Type	Description
url	str
expires	Optional[datetime.datetime]

HTTPValidationError

Attributes:

Name	Type	Description
detail	Optional[List[ValidationError]]

ValidationError

Attributes:

Name	Type	Description
loc	List[ValidationErrorLocInner]
msg	str
type	str

ValidationErrorLocInner

Attributes:

Name	Type	Description
anyof_schema_1_validator	Optional[str]
anyof_schema_2_validator	Optional[int]
actual_instance	Optional[Union[int, str]]
any_of_schemas	Set[str]

Methods:

Name	Description
actual_instance_must_validate_anyof

UserModelInputs

Attributes:

Name	Type	Description
SINGLE	—
MULTIPLE	—