singlestoredb.management.workspace.WorkspaceGroup

class singlestoredb.management.workspace.WorkspaceGroup(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: datetime | str | None, allow_all_traffic: bool | None)

SingleStoreDB workspace group definition.

This object is not instantiated directly. It is used in the results of API calls on the WorkspaceManager. Workspace groups are created using WorkspaceManager.create_workspace_group(), or existing workspace groups are accessed by either WorkspaceManager.workspace_groups or by calling WorkspaceManager.get_workspace_group().

__init__(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: datetime | str | None, allow_all_traffic: bool | None)

Methods

__init__(name, id, created_at, region, ...)

create_workspace(name[, size, auto_suspend, ...])

Create a new workspace.

from_dict(obj, manager)

Construct a WorkspaceGroup from a dictionary of values.

refresh()

Update the object to the current state.

terminate([force, wait_on_terminated, ...])

Terminate the workspace group.

update([name, firewall_ranges, ...])

Update the workspace group definition.

Attributes

organization

stage

Stage manager.

stages

Stage manager.

workspaces

Return a list of available workspaces.

name

Name of the workspace group

id

Unique ID of the workspace group

created_at

Timestamp of when the workspace group was created

region

Region of the workspace group (see Region)

firewall_ranges

List of allowed incoming IP addresses / ranges

terminated_at

Timestamp of when the workspace group was terminated

allow_all_traffic

Should all traffic be allowed?