Documentation ¶
Index ¶
- Variables
- type PatchWorkspace
- func (*PatchWorkspace) Descriptor() ([]byte, []int)deprecated
- func (x *PatchWorkspace) GetAgentUserGroup() *userv1.AgentUserGroup
- func (x *PatchWorkspace) GetCheckpointStorageConfig() *_struct.Struct
- func (x *PatchWorkspace) GetDefaultAuxPool() stringdeprecated
- func (x *PatchWorkspace) GetDefaultAuxResourcePool() string
- func (x *PatchWorkspace) GetDefaultComputePool() stringdeprecated
- func (x *PatchWorkspace) GetDefaultComputeResourcePool() string
- func (x *PatchWorkspace) GetName() *wrappers.StringValue
- func (*PatchWorkspace) ProtoMessage()
- func (x *PatchWorkspace) ProtoReflect() protoreflect.Message
- func (x *PatchWorkspace) Reset()
- func (x *PatchWorkspace) String() string
- type Workspace
- func (*Workspace) Descriptor() ([]byte, []int)deprecated
- func (x *Workspace) GetAgentUserGroup() *userv1.AgentUserGroup
- func (x *Workspace) GetArchived() bool
- func (x *Workspace) GetCheckpointStorageConfig() *_struct.Struct
- func (x *Workspace) GetDefaultAuxPool() string
- func (x *Workspace) GetDefaultComputePool() string
- func (x *Workspace) GetErrorMessage() string
- func (x *Workspace) GetId() int32
- func (x *Workspace) GetImmutable() bool
- func (x *Workspace) GetName() string
- func (x *Workspace) GetNumExperiments() int32
- func (x *Workspace) GetNumProjects() int32
- func (x *Workspace) GetPinned() bool
- func (x *Workspace) GetPinnedAt() *timestamp.Timestamp
- func (x *Workspace) GetState() WorkspaceState
- func (x *Workspace) GetUserId() int32
- func (x *Workspace) GetUsername() string
- func (*Workspace) ProtoMessage()
- func (x *Workspace) ProtoReflect() protoreflect.Message
- func (x *Workspace) Reset()
- func (x *Workspace) String() string
- type WorkspaceState
- func (WorkspaceState) Descriptor() protoreflect.EnumDescriptor
- func (x WorkspaceState) Enum() *WorkspaceState
- func (WorkspaceState) EnumDescriptor() ([]byte, []int)deprecated
- func (x WorkspaceState) Number() protoreflect.EnumNumber
- func (x WorkspaceState) String() string
- func (WorkspaceState) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
View Source
var ( WorkspaceState_name = map[int32]string{ 0: "WORKSPACE_STATE_UNSPECIFIED", 1: "WORKSPACE_STATE_DELETING", 2: "WORKSPACE_STATE_DELETE_FAILED", 3: "WORKSPACE_STATE_DELETED", } WorkspaceState_value = map[string]int32{ "WORKSPACE_STATE_UNSPECIFIED": 0, "WORKSPACE_STATE_DELETING": 1, "WORKSPACE_STATE_DELETE_FAILED": 2, "WORKSPACE_STATE_DELETED": 3, } )
Enum value maps for WorkspaceState.
View Source
var File_determined_workspace_v1_workspace_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type PatchWorkspace ¶
type PatchWorkspace struct { // The new name for the workspace. Name *wrappers.StringValue `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional agent host uid and gid override. AgentUserGroup *userv1.AgentUserGroup `protobuf:"bytes,12,opt,name=agent_user_group,json=agentUserGroup,proto3,oneof" json:"agent_user_group,omitempty"` // Optional checkpoint storage config. // Expects same format as experiment config's checkpoint storage. CheckpointStorageConfig *_struct.Struct `` /* 139-byte string literal not displayed */ // Name of the default compute pool. // // Deprecated: Do not use. DefaultComputePool string `protobuf:"bytes,14,opt,name=default_compute_pool,json=defaultComputePool,proto3" json:"default_compute_pool,omitempty"` // Name of the default compute pool can be optional. DefaultComputeResourcePool *string `` /* 150-byte string literal not displayed */ // Name of the default aux pool. // // Deprecated: Do not use. DefaultAuxPool string `protobuf:"bytes,15,opt,name=default_aux_pool,json=defaultAuxPool,proto3" json:"default_aux_pool,omitempty"` // Name of the default aux pool can be optional. DefaultAuxResourcePool *string `` /* 138-byte string literal not displayed */ // contains filtered or unexported fields }
PatchWorkspace is a partial update to a workspace with all optional fields.
func (*PatchWorkspace) Descriptor
deprecated
func (*PatchWorkspace) Descriptor() ([]byte, []int)
Deprecated: Use PatchWorkspace.ProtoReflect.Descriptor instead.
func (*PatchWorkspace) GetAgentUserGroup ¶
func (x *PatchWorkspace) GetAgentUserGroup() *userv1.AgentUserGroup
func (*PatchWorkspace) GetCheckpointStorageConfig ¶
func (x *PatchWorkspace) GetCheckpointStorageConfig() *_struct.Struct
func (*PatchWorkspace) GetDefaultAuxPool
deprecated
func (x *PatchWorkspace) GetDefaultAuxPool() string
Deprecated: Do not use.
func (*PatchWorkspace) GetDefaultAuxResourcePool ¶
func (x *PatchWorkspace) GetDefaultAuxResourcePool() string
func (*PatchWorkspace) GetDefaultComputePool
deprecated
func (x *PatchWorkspace) GetDefaultComputePool() string
Deprecated: Do not use.
func (*PatchWorkspace) GetDefaultComputeResourcePool ¶
func (x *PatchWorkspace) GetDefaultComputeResourcePool() string
func (*PatchWorkspace) GetName ¶
func (x *PatchWorkspace) GetName() *wrappers.StringValue
func (*PatchWorkspace) ProtoMessage ¶
func (*PatchWorkspace) ProtoMessage()
func (*PatchWorkspace) ProtoReflect ¶
func (x *PatchWorkspace) ProtoReflect() protoreflect.Message
func (*PatchWorkspace) Reset ¶
func (x *PatchWorkspace) Reset()
func (*PatchWorkspace) String ¶
func (x *PatchWorkspace) String() string
type Workspace ¶
type Workspace struct { // The unique id of the workspace. Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"` // The unique name of the workspace. Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // Whether this workspace is archived or not. Archived bool `protobuf:"varint,3,opt,name=archived,proto3" json:"archived,omitempty"` // User who created this workspace. Username string `protobuf:"bytes,4,opt,name=username,proto3" json:"username,omitempty"` // Whether this workspace is immutable (default uncategorized workspace). Immutable bool `protobuf:"varint,5,opt,name=immutable,proto3" json:"immutable,omitempty"` // Number of projects associated with this workspace. NumProjects int32 `protobuf:"varint,6,opt,name=num_projects,json=numProjects,proto3" json:"num_projects,omitempty"` // Pin status of this workspace for the current user. Pinned bool `protobuf:"varint,7,opt,name=pinned,proto3" json:"pinned,omitempty"` // ID of the user who created this project. UserId int32 `protobuf:"varint,8,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` // Number of experiments associated with this workspace. NumExperiments int32 `protobuf:"varint,9,opt,name=num_experiments,json=numExperiments,proto3" json:"num_experiments,omitempty"` // State of workspace during deletion. State WorkspaceState `protobuf:"varint,10,opt,name=state,proto3,enum=determined.workspace.v1.WorkspaceState" json:"state,omitempty"` // Message stored from errors on async-deleting a workspace. ErrorMessage string `protobuf:"bytes,11,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"` // Optional agent host uid and gid override. AgentUserGroup *userv1.AgentUserGroup `protobuf:"bytes,12,opt,name=agent_user_group,json=agentUserGroup,proto3,oneof" json:"agent_user_group,omitempty"` // Optional checkpoint storage config. // Expects same format as experiment config's checkpoint storage. CheckpointStorageConfig *_struct.Struct `` /* 139-byte string literal not displayed */ // Optional date when workspace was pinned. PinnedAt *timestamp.Timestamp `protobuf:"bytes,14,opt,name=pinned_at,json=pinnedAt,proto3,oneof" json:"pinned_at,omitempty"` // Name of the default compute pool. DefaultComputePool string `protobuf:"bytes,15,opt,name=default_compute_pool,json=defaultComputePool,proto3" json:"default_compute_pool,omitempty"` // Name of the default aux pool. DefaultAuxPool string `protobuf:"bytes,16,opt,name=default_aux_pool,json=defaultAuxPool,proto3" json:"default_aux_pool,omitempty"` // contains filtered or unexported fields }
Workspace is a named collection of projects.
func (*Workspace) Descriptor
deprecated
func (*Workspace) GetAgentUserGroup ¶
func (x *Workspace) GetAgentUserGroup() *userv1.AgentUserGroup
func (*Workspace) GetArchived ¶
func (*Workspace) GetCheckpointStorageConfig ¶
func (*Workspace) GetDefaultAuxPool ¶
func (*Workspace) GetDefaultComputePool ¶
func (*Workspace) GetErrorMessage ¶
func (*Workspace) GetImmutable ¶
func (*Workspace) GetNumExperiments ¶
func (*Workspace) GetNumProjects ¶
func (*Workspace) GetPinnedAt ¶
func (*Workspace) GetState ¶
func (x *Workspace) GetState() WorkspaceState
func (*Workspace) GetUsername ¶
func (*Workspace) ProtoMessage ¶
func (*Workspace) ProtoMessage()
func (*Workspace) ProtoReflect ¶
func (x *Workspace) ProtoReflect() protoreflect.Message
type WorkspaceState ¶
type WorkspaceState int32
WorkspaceState is used to track progress during a deletion.
const ( // Object deletion is not in progress. WorkspaceState_WORKSPACE_STATE_UNSPECIFIED WorkspaceState = 0 // The object is being deleted. WorkspaceState_WORKSPACE_STATE_DELETING WorkspaceState = 1 // The object failed to delete. WorkspaceState_WORKSPACE_STATE_DELETE_FAILED WorkspaceState = 2 // The object finished deleting. WorkspaceState_WORKSPACE_STATE_DELETED WorkspaceState = 3 )
func (WorkspaceState) Descriptor ¶
func (WorkspaceState) Descriptor() protoreflect.EnumDescriptor
func (WorkspaceState) Enum ¶
func (x WorkspaceState) Enum() *WorkspaceState
func (WorkspaceState) EnumDescriptor
deprecated
func (WorkspaceState) EnumDescriptor() ([]byte, []int)
Deprecated: Use WorkspaceState.Descriptor instead.
func (WorkspaceState) Number ¶
func (x WorkspaceState) Number() protoreflect.EnumNumber
func (WorkspaceState) String ¶
func (x WorkspaceState) String() string
func (WorkspaceState) Type ¶
func (WorkspaceState) Type() protoreflect.EnumType
Click to show internal directories.
Click to hide internal directories.