Systems & snapshots

Data types for systems, configurations, snapshots, tags, and upstream remotes.

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.

System

Represents a System object that aggregates configuration, versioning, and file content

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
name	str
description	str
archive_status	str
configurations	Optional[List[SystemConfiguration]]
baseline_tagged_snapshot_id	Optional[str]

Methods:

Name	Description
list_file_revisions_by_snapshot	Retrieve a paginated list of file revisions associated with a given snapshot.
list_file_revisions_by_snapshot_tag	Retrieve a paginated list of file revisions using a SnapshotTag.
get_json_file_contents_by_snapshot	Load contents of all JSON files for a given snapshot.
get_json_file_contents_by_snapshot_tag	Load contents of all JSON files using a snapshot tag reference.
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.
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.

SystemBaseline

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
system_id	str
tag_id	str
snapshot_id	str

SystemConfiguration

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
system_id	str
name	str
sha	str
archive_status	str

Snapshot

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
configuration_id	str
sha	str
created_by_id	str

SnapshotItem

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
snapshot_id	str
file_revision_id	str

SnapshotTag

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
tag	str
is_baseline	bool
archive_status	str
snapshot_id	str

NewSystem

Attributes:

Name	Type	Description
name	str
description	str

NewSystemConfiguration

Attributes:

Name	Type	Description
name	str
tracked_files	Optional[List[NewTrackedFile]]

NewSnapshot

Attributes:

Name	Type	Description
dry_run	Optional[bool]

NewSnapshotTag

Attributes:

Name	Type	Description
tag	str

UpdateSystem

Attributes:

Name	Type	Description
name	str
description	str

UpdateTag

Attributes:

Name	Type	Description
snapshot_id	str

DryRunSnapshot

Attributes:

Name	Type	Description
configuration_id	str
sha	str
created_by_id	str
created	datetime.datetime

ResponseCreateSnapshot

Attributes:

Name	Type	Description
anyof_schema_1_validator	Optional[Snapshot]
anyof_schema_2_validator	Optional[DryRunSnapshot]
anyof_schema_3_validator	Optional[NoOpResponse]
actual_instance	Optional[Union[DryRunSnapshot, NoOpResponse, Snapshot]]
any_of_schemas	Set[str]

Methods:

Name	Description
actual_instance_must_validate_anyof

UpstreamRemote

UpstreamRemote(id: ‘UUID’, created: ‘Annotated[datetime, AwareDatetime]’)

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
label	str
tenant_label	str
tenant_id	str
registry_url	str
is_archived	bool

UpstreamRemoteInfo

Attributes:

Name	Type	Description
id	str
label	str

UpstreamRemoteSync

Data class for creating a remote sync.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
upstream_remote_id	str
status	UpstreamRemoteSyncStatus
updated	datetime.datetime
message	Optional[str]

UpstreamRemoteSyncStatus

Enum for remote sync status.

Attributes:

Name	Type	Description
PENDING	—
IN_PROGRESS	—
COMPLETED	—
FAILED	—
CANCEL	—

CreateUpstreamRemoteSync

Attributes:

Name	Type	Description
upstream_remote_id	str

PageSystem

Attributes:

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

PageSystemConfiguration

Attributes:

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

PageSnapshot

Attributes:

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

PageSnapshotItem

A paginated response object for listing snapshot items.

PageSnapshotTag

Attributes:

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

PageUpstreamRemote

Attributes:

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