package determined.workspace.v1

Get desktop application:
View/edit binary Protocol Buffers messages

PatchWorkspace is a partial update to a workspace with all optional fields.

Used in: api.v1.PatchWorkspaceRequest

• optional google.protobuf.StringValue name = 1

  The new name for the workspace.

• optional user.v1.AgentUserGroup agent_user_group = 12

  Optional agent host uid and gid override.

• optional google.protobuf.Struct checkpoint_storage_config = 13

  Optional checkpoint storage config. Expects same format as experiment config's checkpoint storage.

• string default_compute_pool = 14

  Name of the default compute pool.

• optional string default_compute_resource_pool = 16

  Name of the default compute pool can be optional.

• string default_aux_pool = 15

  Name of the default aux pool.

• optional string default_aux_resource_pool = 17

  Name of the default aux pool can be optional.

• map<string, WorkspaceNamespaceMeta> cluster_namespace_meta = 18

  The map of clusters to workspace-namespace metadata (including the workspace-namespace binding and the resource quota placed on the namespace bound to the workspace for a given cluster).

Workspace is a named collection of projects.

Used in: api.v1.GetWorkspaceResponse, api.v1.GetWorkspacesResponse, api.v1.PatchWorkspaceResponse, api.v1.PostWorkspaceResponse

• int32 id = 1

  The unique id of the workspace.

• string name = 2

  The unique name of the workspace.

• bool archived = 3

  Whether this workspace is archived or not.

• string username = 4

  User who created this workspace.

• bool immutable = 5

  Whether this workspace is immutable (default uncategorized workspace).

• int32 num_projects = 6

  Number of projects associated with this workspace.

• bool pinned = 7

  Pin status of this workspace for the current user.

• int32 user_id = 8

  ID of the user who created this project.

• int32 num_experiments = 9

  Number of experiments associated with this workspace.

• WorkspaceState state = 10

  State of workspace during deletion.

• string error_message = 11

  Message stored from errors on async-deleting a workspace.

• optional user.v1.AgentUserGroup agent_user_group = 12

  Optional agent host uid and gid override.

• optional google.protobuf.Struct checkpoint_storage_config = 13

  Optional checkpoint storage config. Expects same format as experiment config's checkpoint storage.

• optional google.protobuf.Timestamp pinned_at = 14

  Optional date when workspace was pinned.

• string default_compute_pool = 15

  Name of the default compute pool.

• string default_aux_pool = 16

  Name of the default aux pool.

• optional string auto_created_namespace = 17

  Optional auto-created namespace bound to the workspace.

WorkspaceNamespace represents a workspace-namespace binding for a given workspace and cluster.

Used in: api.v1.ListWorkspaceNamespaceBindingsResponse, api.v1.PatchWorkspaceResponse, api.v1.PostWorkspaceResponse, api.v1.SetWorkspaceNamespaceBindingsResponse

• int32 workspace_id = 1

  The id of the workspace.

• string namespace = 2

  The Kubernetes namespace.

• string cluster_name = 3

  User cluster name.

• bool auto_create_namespace = 4

  Whether the namespace was auto-created for a workspace-namespace binding.

WorkspaceNamespaceMeta is the metadata associated with a workspace-namespace binding.

Used in: api.v1.PostWorkspaceRequest, api.v1.SetWorkspaceNamespaceBindingsRequest, PatchWorkspace

• optional string namespace = 1

  The optional namespace of the workspace-namespace binding.

• bool auto_create_namespace = 2

  Whether we want to auto-create a namespace for a workspace-namespace binding.

• bool auto_create_namespace_all_clusters = 3

  Whether we want to auto-create a namespace for each cluster's workspace-namespace binding.

• string cluster_name = 4

  The cluster to which we apply the workspace-namespace binding or resource quota.

• optional int32 resource_quota = 5

  The optional resource quota placed on the namespace (and consequentially, the workspace). TODO (CM-495): Remove this field and use GetKubernetesResourceQuotasRequest instead.

WorkspaceState is used to track progress during a deletion.

Used in: project.v1.Project, Workspace

• WORKSPACE_STATE_UNSPECIFIED = 0

  Object deletion is not in progress.

• WORKSPACE_STATE_DELETING = 1

  The object is being deleted.

• WORKSPACE_STATE_DELETE_FAILED = 2

  The object failed to delete.

• WORKSPACE_STATE_DELETED = 3

  The object finished deleting.