singlestoredb.management.workspace.WorkspaceGroup

class singlestoredb.management.workspace.WorkspaceGroup(name: str, id: str, created_at: Union[str, datetime.datetime], region: singlestoredb.management.region.Region, firewall_ranges: List[str], terminated_at: Optional[Union[datetime.datetime, str]])

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().

See also

WorkspaceManager.create_workspace_group(), WorkspaceManager.get_workspace_group(), WorkspaceManager.workspace_groups

__init__(name: str, id: str, created_at: Union[str, datetime.datetime], region: singlestoredb.management.region.Region, firewall_ranges: List[str], terminated_at: Optional[Union[datetime.datetime, str]])

Methods

__init__(name, id, created_at, region, ...)
create_workspace(name[, size, ...])	Create a new workspace.
from_dict(obj, manager)	Construct a WorkspaceGroup from a dictionary of values.
refresh()	Update teh object to the current state.
terminate([force, wait_on_terminated, ...])	Terminate the workspace group.
update([name, admin_password, firewall_ranges])	Update the cluster definition.

Attributes

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 cluster (see Region)
firewall_ranges	List of allowed incoming IP addresses / ranges
terminated_at	Timestamp of when the workspace group was terminated