wallaroo.workspace

class Workspace(wallaroo.object.Object):

Workspace provides a user and visibility context for access to models and pipelines.

Workspace(client: wallaroo.client.Client, data: Dict[str, Any])

Base constructor.

Each object requires:

  • a GraphQL client - in order to fill its missing members dynamically
  • an initial data blob - typically from unserialized JSON, contains at
  • least the data for required members (typically the object's primary key) and optionally other data members.
client
def to_json(self):
def id(self) -> int:
def name(*args, **kwargs):
def archived(*args, **kwargs):
def created_at(*args, **kwargs):
def created_by(*args, **kwargs):
def models(*args, **kwargs):

Returns a List of Models objects that have been created in this workspace.

def pipelines(*args, **kwargs):
def users(*args, **kwargs):
@staticmethod
def list_workspaces(client: wallaroo.client.Client) -> List[Workspace]:

List all workspaces on the platform which this user has permission see.

Parameters
  • client: The Client object
Returns

A list of all workspaces on the platform.

@staticmethod
def get_workspace( client: wallaroo.client.Client, name: str, create_if_not_exist: Optional[bool] = False) -> Optional[Workspace]:

Get a workspace by name. If the workspace does not exist, create it.

Parameters
  • name: The name of the workspace to get.
  • client: The Client object
  • create_if_not_exist: If set to True, create a new workspace if workspace by given name doesn't already exist. Set to False by default.
Returns

The workspace with the given name.

def add_user(self, user_email: str) -> Workspace:

Add a user to workspace as participant

def add_owner(self, user_email: str) -> Workspace:

Add a user to workspace as owner

def remove_user(self, user_email: str):
def list_connections(self) -> wallaroo.connection.ConnectionList:

Return a list of Connections available in this Workspace.

Returns

List of Connections in this Workspace.

def add_connection(self, name: str):

Adds an existing Connection with the given name to this Workspace.

def remove_connection(self, name: str):

Removes a Connection with the given name from this Workspace.

class Workspaces(typing.List[wallaroo.workspace.Workspace]):

Wraps a list of workspaces for display.