WorkspaceContainerProps Interface @beta
Properties describing a WorkspaceContainer for methods like getContainerAsync.
Extends
- Optional<CloudSqlite.ContainerAccessProps, "accessToken">
Properties
| Name | Type | Description | |
|---|---|---|---|
| description Readonly | string | undefined | A user-friendly description of the container's contents. | |
| loadingHelp Readonly | string | undefined | A message to display to the user if problems occur while loading the container. | |
| syncOnConnect Readonly | boolean | undefined | Whether to synchronize the container via CloudSqlite.CloudContainer.checkForChanges whenever it is connected to a CloudCache. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| accessToken Inherited | string | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | SAS token that grants access to the container. |
| alias Readonly Inherited | string | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | an alias for the container. |
| baseUri Readonly Inherited | string | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | The base URI for the container. |
| containerId Readonly Inherited | string | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | The name of the container. |
| isPublic Readonly Inherited | boolean | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | true if the container is public (doesn't require authorization) |
| lockExpireSeconds Readonly Inherited | number | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | Duration for holding write lock, in seconds. |
| logId Readonly Inherited | string | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | string attached to log messages from CloudSQLite. |
| secure Readonly Inherited | boolean | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | if true, container is attached in "secure" mode (blocks are encrypted). |
| storageType Readonly Inherited | "azure" | "google" | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | The type of storage provider. |
| tokenRefreshSeconds Readonly Inherited | number | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | number of seconds between auto-refresh of access token. |
| writeable Readonly Inherited | boolean | undefined | Optional<CloudSqlite.ContainerAccessProps, "accessToken"> | if true, container is allowed to request the write lock. |
Defined in
Last Updated: 09 May, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.