Type alias Tenant

Tenant: TenantBase & {
activityStatus: "ACTIVE" | "INACTIVE" | "OFFLOADED" | "OFFLOADING" | "ONLOADING";
}

The expected type returned by all tenant methods.

Type declaration

activityStatus: "ACTIVE" | "INACTIVE" | "OFFLOADED" | "OFFLOADING" | "ONLOADING"
There are two statuses that are immutable: OFFLOADED and `ONLOADING, which are set by the server:
- ONLOADING, which means the tenant is transitioning from the OFFLOADED status to ACTIVE/INACTIVE.
- OFFLOADING, which means the tenant is transitioning from ACTIVE/INACTIVE to the OFFLOADED status. The other three statuses are mutable within the .create and .update, methods:
- ACTIVE, which means loaded fully into memory and ready for use.
- INACTIVE, which means not loaded into memory with files stored on disk.
- OFFLOADED, which means not loaded into memory with files stored on the cloud.