Workspace Service

  • 2023/08/09
  • 3 分钟
  • 592 字
点击查看目录

Service to manage TSB workspaces.

Workspaces

The Workspaces service provides methods to manage the workspaces for a given tenant.

Workspaces are the main containers for the different configuration resources available in TSB, and provide infrastructure isolation constraints.

CreateWorkspace

rpc CreateWorkspace (tetrateio.api.tsb.v2.CreateWorkspaceRequest ) returns (tetrateio.api.tsb.v2.Workspace )

Requires CREATE

Create a new workspace. The workspace will own exclusively the namespaces configured in the namespaces selector for the workspace.

GetWorkspace

rpc GetWorkspace (tetrateio.api.tsb.v2.GetWorkspaceRequest ) returns (tetrateio.api.tsb.v2.Workspace )

Requires READ

Get the details of an existing workspace

UpdateWorkspace

rpc UpdateWorkspace (tetrateio.api.tsb.v2.Workspace ) returns (tetrateio.api.tsb.v2.Workspace )

Requires WRITE

Modify an existing workspace

ListWorkspaces

rpc ListWorkspaces (tetrateio.api.tsb.v2.ListWorkspacesRequest ) returns (tetrateio.api.tsb.v2.ListWorkspacesResponse )

List all existing workspaces for the given tenant.

DeleteWorkspace

rpc DeleteWorkspace (tetrateio.api.tsb.v2.DeleteWorkspaceRequest ) returns (google.protobuf.Empty )

Requires DELETE

Delete an existing workspace. Note that deleting resources in TSB is a recursive operation. Deleting a workspace will delete all groups and configuration objects that exist in it.

CreateSettings

rpc CreateSettings (tetrateio.api.tsb.v2.CreateWorkspaceSettingsRequest ) returns (tetrateio.api.tsb.v2.WorkspaceSetting )

Requires CreateWorkspaceSetting

Create default settings for a workspace. Default settings will apply to the services owned by the workspace, unless more specific settings are provided at the group level.

GetSettings

rpc GetSettings (tetrateio.api.tsb.v2.GetWorkspaceSettingsRequest ) returns (tetrateio.api.tsb.v2.WorkspaceSetting )

Requires ReadWorkspaceSetting

Get the details of a settings object for the given workspace.

UpdateSettings

rpc UpdateSettings (tetrateio.api.tsb.v2.WorkspaceSetting ) returns (tetrateio.api.tsb.v2.WorkspaceSetting )

Requires WriteWorkspaceSetting

Modify the given workspace settings.

ListSettings

rpc ListSettings (tetrateio.api.tsb.v2.ListWorkspaceSettingsRequest ) returns (tetrateio.api.tsb.v2.ListWorkspaceSettingsResponse )

List all settings available for the given workspace.

DeleteSettings

rpc DeleteSettings (tetrateio.api.tsb.v2.DeleteWorkspaceSettingsRequest ) returns (google.protobuf.Empty )

Requires DeleteWorkspaceSetting

Delete the given workspace settings.

CreateWorkspaceRequest

Request to create a Workspace.

Field Description Validation 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.

Field Description Validation 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.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace.

string = {
  min_len: 1
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

–

DeleteWorkspaceSettingsRequest

Request to delete a Workspace Settings.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace Settings.

string = {
  min_len: 1
}

GetWorkspaceRequest

Request to retrieve a Workspace.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace.

string = {
  min_len: 1
}

GetWorkspaceSettingsRequest

Request to retrieve a Workspace Settings.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace Settings.

string = {
  min_len: 1
}

ListWorkspaceSettingsRequest

Request to list Workspace Settings.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource to list Workspace Settings from.

string = {
  min_len: 1
}

ListWorkspaceSettingsResponse

The existing settings objects for the given workspace.

Field Description Validation Rule

settings

List of tetrateio.api.tsb.v2.WorkspaceSetting

–

ListWorkspacesRequest

Request to list Workspaces.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource to list Workspaces from.

string = {
  min_len: 1
}

ListWorkspacesResponse

The existing workspaces for the given tenant.

Field Description Validation Rule

workspaces

List of tetrateio.api.tsb.v2.Workspace

–
最后更新于 2024/05/16