Skip to main content
Version: 0.9.x

Workspace Service

Workspaces

CreateWorkspace

Requires CreateWorkspace

GetWorkspace

Requires ReadWorkspace

UpdateWorkspace

Requires WriteWorkspace

ListWorkspaces

DeleteWorkspace

Requires DeleteWorkspace

CreateSettings

Requires CreateSettings

GetSettings

Requires ReadSettings

UpdateSettings

Requires WriteSettings

ListSettings

DeleteSettings

Requires DeleteSettings

CreateWorkspaceRequest

Request to create a Workspace.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Workspace will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

workspace

tetrateio.api.tsb.v2.Workspace
REQUIRED
Details of the Workspace to be created.

message = {
  required: true
}

CreateWorkspaceSettingsRequest

Request to create a Workspace Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Workspace Settings will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

settings

tetrateio.api.tsb.v2.WorkspaceSetting
REQUIRED
Details of the Workspace Settings to be created.

message = {
  required: true
}

DeleteWorkspaceRequest

Request to delete a Workspace.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace.

string = {
  min_len: 1
}

DeleteWorkspaceSettingsRequest

Request to delete a Workspace Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace Settings.

string = {
  min_len: 1
}

GetWorkspaceRequest

Request to retrieve a Workspace.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace.

string = {
  min_len: 1
}

GetWorkspaceSettingsRequest

Request to retrieve a Workspace Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace Settings.

string = {
  min_len: 1
}

ListWorkspaceSettingsRequest

Request to list Workspace Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Workspace Settings from.

string = {
  min_len: 1
}

ListWorkspaceSettingsResponse

FieldDescriptionValidation Rule

settings

List of tetrateio.api.tsb.v2.WorkspaceSetting

ListWorkspacesRequest

Request to list Workspaces.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Workspaces from.

string = {
  min_len: 1
}

ListWorkspacesResponse

FieldDescriptionValidation Rule

workspaces

List of tetrateio.api.tsb.v2.Workspace