workspacev1

package
v0.38.0-rc7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 4, 2024 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Index

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 */
	// 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).
	ClusterNamespaceMeta map[string]*WorkspaceNamespaceMeta `` /* 212-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) GetClusterNamespaceMeta 

func (x *PatchWorkspace) GetClusterNamespaceMeta() map[string]*WorkspaceNamespaceMeta

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"`
	// Optional auto-created namespace bound to the workspace.
	AutoCreatedNamespace *string `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

Workspace is a named collection of projects.

func (*Workspace) Descriptor deprecated 

func (*Workspace) Descriptor() ([]byte, []int)

Deprecated: Use Workspace.ProtoReflect.Descriptor instead.

func (*Workspace) GetAgentUserGroup 

func (x *Workspace) GetAgentUserGroup() *userv1.AgentUserGroup

func (*Workspace) GetArchived 

func (x *Workspace) GetArchived() bool

func (*Workspace) GetAutoCreatedNamespace 

func (x *Workspace) GetAutoCreatedNamespace() string

func (*Workspace) GetCheckpointStorageConfig 

func (x *Workspace) GetCheckpointStorageConfig() *_struct.Struct

func (*Workspace) GetDefaultAuxPool 

func (x *Workspace) GetDefaultAuxPool() string

func (*Workspace) GetDefaultComputePool 

func (x *Workspace) GetDefaultComputePool() string

func (*Workspace) GetErrorMessage 

func (x *Workspace) GetErrorMessage() string

func (*Workspace) GetId 

func (x *Workspace) GetId() int32

func (*Workspace) GetImmutable 

func (x *Workspace) GetImmutable() bool

func (*Workspace) GetName 

func (x *Workspace) GetName() string

func (*Workspace) GetNumExperiments 

func (x *Workspace) GetNumExperiments() int32

func (*Workspace) GetNumProjects 

func (x *Workspace) GetNumProjects() int32

func (*Workspace) GetPinned 

func (x *Workspace) GetPinned() bool

func (*Workspace) GetPinnedAt 

func (x *Workspace) GetPinnedAt() *timestamp.Timestamp

func (*Workspace) GetState 

func (x *Workspace) GetState() WorkspaceState

func (*Workspace) GetUserId 

func (x *Workspace) GetUserId() int32

func (*Workspace) GetUsername 

func (x *Workspace) GetUsername() string

func (*Workspace) ProtoMessage 

func (*Workspace) ProtoMessage()

func (*Workspace) ProtoReflect 

func (x *Workspace) ProtoReflect() protoreflect.Message

func (*Workspace) Reset 

func (x *Workspace) Reset()

func (*Workspace) String 

func (x *Workspace) String() string

type WorkspaceNamespaceBinding 

type WorkspaceNamespaceBinding struct {

	// The id of the workspace.
	WorkspaceId int32 `protobuf:"varint,1,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`
	// The Kubernetes namespace.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// User cluster name.
	ClusterName string `protobuf:"bytes,3,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
	// Whether the namespace was auto-created for a workspace-namespace
	// binding.
	AutoCreateNamespace bool `protobuf:"varint,4,opt,name=auto_create_namespace,json=autoCreateNamespace,proto3" json:"auto_create_namespace,omitempty"`
	// contains filtered or unexported fields
}

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

func (*WorkspaceNamespaceBinding) Descriptor deprecated 

func (*WorkspaceNamespaceBinding) Descriptor() ([]byte, []int)

Deprecated: Use WorkspaceNamespaceBinding.ProtoReflect.Descriptor instead.

func (*WorkspaceNamespaceBinding) GetAutoCreateNamespace 

func (x *WorkspaceNamespaceBinding) GetAutoCreateNamespace() bool

func (*WorkspaceNamespaceBinding) GetClusterName 

func (x *WorkspaceNamespaceBinding) GetClusterName() string

func (*WorkspaceNamespaceBinding) GetNamespace 

func (x *WorkspaceNamespaceBinding) GetNamespace() string

func (*WorkspaceNamespaceBinding) GetWorkspaceId 

func (x *WorkspaceNamespaceBinding) GetWorkspaceId() int32

func (*WorkspaceNamespaceBinding) ProtoMessage 

func (*WorkspaceNamespaceBinding) ProtoMessage()

func (*WorkspaceNamespaceBinding) ProtoReflect 

func (x *WorkspaceNamespaceBinding) ProtoReflect() protoreflect.Message

func (*WorkspaceNamespaceBinding) Reset 

func (x *WorkspaceNamespaceBinding) Reset()

func (*WorkspaceNamespaceBinding) String 

func (x *WorkspaceNamespaceBinding) String() string

type WorkspaceNamespaceMeta 

type WorkspaceNamespaceMeta struct {

	// The optional namespace of the workspace-namespace binding.
	Namespace *string `protobuf:"bytes,1,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"`
	// Whether we want to auto-create a namespace for a workspace-namespace
	// binding.
	AutoCreateNamespace bool `protobuf:"varint,2,opt,name=auto_create_namespace,json=autoCreateNamespace,proto3" json:"auto_create_namespace,omitempty"`
	// Whether we want to auto-create a namespace for each cluster's
	// workspace-namespace binding.
	AutoCreateNamespaceAllClusters bool `` /* 158-byte string literal not displayed */
	// The cluster to which we apply the workspace-namespace binding or resource
	// quota.
	ClusterName string `protobuf:"bytes,4,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
	// The optional resource quota placed on the namespace (and consequentially,
	// the workspace).
	// TODO (CM-495): Remove this field and use GetKubernetesResourceQuotasRequest
	// instead.
	ResourceQuota *int32 `protobuf:"varint,5,opt,name=resource_quota,json=resourceQuota,proto3,oneof" json:"resource_quota,omitempty"`
	// contains filtered or unexported fields
}

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

func (*WorkspaceNamespaceMeta) Descriptor deprecated 

func (*WorkspaceNamespaceMeta) Descriptor() ([]byte, []int)

Deprecated: Use WorkspaceNamespaceMeta.ProtoReflect.Descriptor instead.

func (*WorkspaceNamespaceMeta) GetAutoCreateNamespace 

func (x *WorkspaceNamespaceMeta) GetAutoCreateNamespace() bool

func (*WorkspaceNamespaceMeta) GetAutoCreateNamespaceAllClusters 

func (x *WorkspaceNamespaceMeta) GetAutoCreateNamespaceAllClusters() bool

func (*WorkspaceNamespaceMeta) GetClusterName 

func (x *WorkspaceNamespaceMeta) GetClusterName() string

func (*WorkspaceNamespaceMeta) GetNamespace 

func (x *WorkspaceNamespaceMeta) GetNamespace() string

func (*WorkspaceNamespaceMeta) GetResourceQuota 

func (x *WorkspaceNamespaceMeta) GetResourceQuota() int32

func (*WorkspaceNamespaceMeta) ProtoMessage 

func (*WorkspaceNamespaceMeta) ProtoMessage()

func (*WorkspaceNamespaceMeta) ProtoReflect 

func (x *WorkspaceNamespaceMeta) ProtoReflect() protoreflect.Message

func (*WorkspaceNamespaceMeta) Reset 

func (x *WorkspaceNamespaceMeta) Reset()

func (*WorkspaceNamespaceMeta) String 

func (x *WorkspaceNamespaceMeta) String() string

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.