provisionerv1

package
v0.30.13 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ProvisionerService_GetWorkspaces_FullMethodName            = "/provisioner.v1.ProvisionerService/GetWorkspaces"
	ProvisionerService_FindWorkspace_FullMethodName            = "/provisioner.v1.ProvisionerService/FindWorkspace"
	ProvisionerService_GetWorkspacesByUserStr_FullMethodName   = "/provisioner.v1.ProvisionerService/GetWorkspacesByUserStr"
	ProvisionerService_GetUserBlueprints_FullMethodName        = "/provisioner.v1.ProvisionerService/GetUserBlueprints"
	ProvisionerService_ProvisionWorkspaceStream_FullMethodName = "/provisioner.v1.ProvisionerService/ProvisionWorkspaceStream"
	ProvisionerService_DeleteWorkspace_FullMethodName          = "/provisioner.v1.ProvisionerService/DeleteWorkspace"
	ProvisionerService_StopWorkspace_FullMethodName            = "/provisioner.v1.ProvisionerService/StopWorkspace"
	ProvisionerService_EjectWorkspace_FullMethodName           = "/provisioner.v1.ProvisionerService/EjectWorkspace"
)

Variables

View Source
var File_provisioner_v1_provisioner_proto protoreflect.FileDescriptor
View Source
var ProvisionerService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "provisioner.v1.ProvisionerService",
	HandlerType: (*ProvisionerServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetWorkspaces",
			Handler:    _ProvisionerService_GetWorkspaces_Handler,
		},
		{
			MethodName: "FindWorkspace",
			Handler:    _ProvisionerService_FindWorkspace_Handler,
		},
		{
			MethodName: "GetWorkspacesByUserStr",
			Handler:    _ProvisionerService_GetWorkspacesByUserStr_Handler,
		},
		{
			MethodName: "GetUserBlueprints",
			Handler:    _ProvisionerService_GetUserBlueprints_Handler,
		},
		{
			MethodName: "DeleteWorkspace",
			Handler:    _ProvisionerService_DeleteWorkspace_Handler,
		},
		{
			MethodName: "StopWorkspace",
			Handler:    _ProvisionerService_StopWorkspace_Handler,
		},
		{
			MethodName: "EjectWorkspace",
			Handler:    _ProvisionerService_EjectWorkspace_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ProvisionWorkspaceStream",
			Handler:       _ProvisionerService_ProvisionWorkspaceStream_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "provisioner/v1/provisioner.proto",
}

ProvisionerService_ServiceDesc is the grpc.ServiceDesc for ProvisionerService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterProvisionerServiceServer

func RegisterProvisionerServiceServer(s grpc.ServiceRegistrar, srv ProvisionerServiceServer)

Types

type DeleteWorkspaceRequest

type DeleteWorkspaceRequest struct {

	// workspace is the name of the workspace to delete.
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// delay_seconds defers deletion by the given number of seconds, allowing
	// in-flight operations to complete gracefully. Use 0 for immediate deletion.
	DelaySeconds uint32 `protobuf:"varint,2,opt,name=delay_seconds,json=delaySeconds,proto3" json:"delay_seconds,omitempty"`
	// contains filtered or unexported fields
}

DeleteWorkspaceRequest identifies the workspace to delete.

func (*DeleteWorkspaceRequest) Descriptor deprecated

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

Deprecated: Use DeleteWorkspaceRequest.ProtoReflect.Descriptor instead.

func (*DeleteWorkspaceRequest) GetDelaySeconds

func (x *DeleteWorkspaceRequest) GetDelaySeconds() uint32

func (*DeleteWorkspaceRequest) GetWorkspace

func (x *DeleteWorkspaceRequest) GetWorkspace() string

func (*DeleteWorkspaceRequest) ProtoMessage

func (*DeleteWorkspaceRequest) ProtoMessage()

func (*DeleteWorkspaceRequest) ProtoReflect

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

func (*DeleteWorkspaceRequest) Reset

func (x *DeleteWorkspaceRequest) Reset()

func (*DeleteWorkspaceRequest) String

func (x *DeleteWorkspaceRequest) String() string

type DeleteWorkspaceResponse

type DeleteWorkspaceResponse struct {

	// message provides a human-readable description of the result.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

DeleteWorkspaceResponse reports the outcome of the delete operation.

func (*DeleteWorkspaceResponse) Descriptor deprecated

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

Deprecated: Use DeleteWorkspaceResponse.ProtoReflect.Descriptor instead.

func (*DeleteWorkspaceResponse) GetMessage

func (x *DeleteWorkspaceResponse) GetMessage() string

func (*DeleteWorkspaceResponse) ProtoMessage

func (*DeleteWorkspaceResponse) ProtoMessage()

func (*DeleteWorkspaceResponse) ProtoReflect

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

func (*DeleteWorkspaceResponse) Reset

func (x *DeleteWorkspaceResponse) Reset()

func (*DeleteWorkspaceResponse) String

func (x *DeleteWorkspaceResponse) String() string

type EjectWorkspaceRequest

type EjectWorkspaceRequest struct {

	// userstr identifies the workspace to eject.
	Userstr string `protobuf:"bytes,1,opt,name=userstr,proto3" json:"userstr,omitempty"`
	// namespace is the Kubernetes namespace that contains the target workload.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// workload_kind is the Kubernetes resource kind of the target workload (e.g. Deployment, StatefulSet, DaemonSet).
	WorkloadKind string `protobuf:"bytes,3,opt,name=workload_kind,json=workloadKind,proto3" json:"workload_kind,omitempty"`
	// workload_name is the name of the target workload to eject from.
	WorkloadName string `protobuf:"bytes,4,opt,name=workload_name,json=workloadName,proto3" json:"workload_name,omitempty"`
	// timeout_seconds is how long to wait for the rolling update to settle.
	// Defaults to 60 if unset or 0.
	TimeoutSeconds int32 `protobuf:"varint,5,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"`
	// contains filtered or unexported fields
}

EjectWorkspaceRequest identifies the workload from which to eject a workspace.

func (*EjectWorkspaceRequest) Descriptor deprecated

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

Deprecated: Use EjectWorkspaceRequest.ProtoReflect.Descriptor instead.

func (*EjectWorkspaceRequest) GetNamespace

func (x *EjectWorkspaceRequest) GetNamespace() string

func (*EjectWorkspaceRequest) GetTimeoutSeconds

func (x *EjectWorkspaceRequest) GetTimeoutSeconds() int32

func (*EjectWorkspaceRequest) GetUserstr

func (x *EjectWorkspaceRequest) GetUserstr() string

func (*EjectWorkspaceRequest) GetWorkloadKind

func (x *EjectWorkspaceRequest) GetWorkloadKind() string

func (*EjectWorkspaceRequest) GetWorkloadName

func (x *EjectWorkspaceRequest) GetWorkloadName() string

func (*EjectWorkspaceRequest) ProtoMessage

func (*EjectWorkspaceRequest) ProtoMessage()

func (*EjectWorkspaceRequest) ProtoReflect

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

func (*EjectWorkspaceRequest) Reset

func (x *EjectWorkspaceRequest) Reset()

func (*EjectWorkspaceRequest) String

func (x *EjectWorkspaceRequest) String() string

type EjectWorkspaceResponse

type EjectWorkspaceResponse struct {

	// workspace is the canonical workspace name that was ejected.
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// contains filtered or unexported fields
}

EjectWorkspaceResponse reports the outcome of the eject operation.

func (*EjectWorkspaceResponse) Descriptor deprecated

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

Deprecated: Use EjectWorkspaceResponse.ProtoReflect.Descriptor instead.

func (*EjectWorkspaceResponse) GetWorkspace

func (x *EjectWorkspaceResponse) GetWorkspace() string

func (*EjectWorkspaceResponse) ProtoMessage

func (*EjectWorkspaceResponse) ProtoMessage()

func (*EjectWorkspaceResponse) ProtoReflect

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

func (*EjectWorkspaceResponse) Reset

func (x *EjectWorkspaceResponse) Reset()

func (*EjectWorkspaceResponse) String

func (x *EjectWorkspaceResponse) String() string

type FindWorkspaceRequest

type FindWorkspaceRequest struct {

	// workspace is the unique name of the workspace.
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// contains filtered or unexported fields
}

FindWorkspaceRequest identifies a single workspace to look up.

func (*FindWorkspaceRequest) Descriptor deprecated

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

Deprecated: Use FindWorkspaceRequest.ProtoReflect.Descriptor instead.

func (*FindWorkspaceRequest) GetWorkspace

func (x *FindWorkspaceRequest) GetWorkspace() string

func (*FindWorkspaceRequest) ProtoMessage

func (*FindWorkspaceRequest) ProtoMessage()

func (*FindWorkspaceRequest) ProtoReflect

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

func (*FindWorkspaceRequest) Reset

func (x *FindWorkspaceRequest) Reset()

func (*FindWorkspaceRequest) String

func (x *FindWorkspaceRequest) String() string

type GetUserBlueprintsRequest

type GetUserBlueprintsRequest struct {

	// username is the user whose available blueprints are requested.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// contains filtered or unexported fields
}

GetUserBlueprintsRequest identifies the user whose blueprints to fetch.

func (*GetUserBlueprintsRequest) Descriptor deprecated

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

Deprecated: Use GetUserBlueprintsRequest.ProtoReflect.Descriptor instead.

func (*GetUserBlueprintsRequest) GetUsername

func (x *GetUserBlueprintsRequest) GetUsername() string

func (*GetUserBlueprintsRequest) ProtoMessage

func (*GetUserBlueprintsRequest) ProtoMessage()

func (*GetUserBlueprintsRequest) ProtoReflect

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

func (*GetUserBlueprintsRequest) Reset

func (x *GetUserBlueprintsRequest) Reset()

func (*GetUserBlueprintsRequest) String

func (x *GetUserBlueprintsRequest) String() string

type GetUserBlueprintsResponse

type GetUserBlueprintsResponse struct {

	// blueprints is the list of blueprints the user may provision.
	Blueprints []*v1.BlueprintSummary `protobuf:"bytes,1,rep,name=blueprints,proto3" json:"blueprints,omitempty"`
	// contains filtered or unexported fields
}

GetUserBlueprintsResponse contains the blueprints available to the user.

func (*GetUserBlueprintsResponse) Descriptor deprecated

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

Deprecated: Use GetUserBlueprintsResponse.ProtoReflect.Descriptor instead.

func (*GetUserBlueprintsResponse) GetBlueprints

func (x *GetUserBlueprintsResponse) GetBlueprints() []*v1.BlueprintSummary

func (*GetUserBlueprintsResponse) ProtoMessage

func (*GetUserBlueprintsResponse) ProtoMessage()

func (*GetUserBlueprintsResponse) ProtoReflect

func (*GetUserBlueprintsResponse) Reset

func (x *GetUserBlueprintsResponse) Reset()

func (*GetUserBlueprintsResponse) String

func (x *GetUserBlueprintsResponse) String() string

type GetWorkspacesByUserStrRequest

type GetWorkspacesByUserStrRequest struct {

	// userstr is the serialised user context string to filter workspaces by.
	Userstr string `protobuf:"bytes,1,opt,name=userstr,proto3" json:"userstr,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWorkspacesByUserStrRequest) Descriptor deprecated

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

Deprecated: Use GetWorkspacesByUserStrRequest.ProtoReflect.Descriptor instead.

func (*GetWorkspacesByUserStrRequest) GetUserstr

func (x *GetWorkspacesByUserStrRequest) GetUserstr() string

func (*GetWorkspacesByUserStrRequest) ProtoMessage

func (*GetWorkspacesByUserStrRequest) ProtoMessage()

func (*GetWorkspacesByUserStrRequest) ProtoReflect

func (*GetWorkspacesByUserStrRequest) Reset

func (x *GetWorkspacesByUserStrRequest) Reset()

func (*GetWorkspacesByUserStrRequest) String

type GetWorkspacesRequest

type GetWorkspacesRequest struct {

	// workspace filters by workspace name (partial match allowed).
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// username filters by the owning user.
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// organization filters by the owning organization.
	Organization string `protobuf:"bytes,3,opt,name=organization,proto3" json:"organization,omitempty"`
	// blueprint filters by the blueprint used to create the workspace.
	Blueprint string `protobuf:"bytes,4,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// repo_name filters by the source repository name.
	RepoName string `protobuf:"bytes,5,opt,name=repo_name,json=repoName,proto3" json:"repo_name,omitempty"`
	// repo_owner filters by the source repository owner.
	RepoOwner string `protobuf:"bytes,6,opt,name=repo_owner,json=repoOwner,proto3" json:"repo_owner,omitempty"`
	// repo_ref filters by the source repository ref (branch, tag, or commit).
	RepoRef string `protobuf:"bytes,7,opt,name=repo_ref,json=repoRef,proto3" json:"repo_ref,omitempty"`
	// contains filtered or unexported fields
}

GetWorkspacesRequest filters the list of workspaces to return. All fields are optional; omitting a field disables that filter.

func (*GetWorkspacesRequest) Descriptor deprecated

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

Deprecated: Use GetWorkspacesRequest.ProtoReflect.Descriptor instead.

func (*GetWorkspacesRequest) GetBlueprint

func (x *GetWorkspacesRequest) GetBlueprint() string

func (*GetWorkspacesRequest) GetOrganization

func (x *GetWorkspacesRequest) GetOrganization() string

func (*GetWorkspacesRequest) GetRepoName

func (x *GetWorkspacesRequest) GetRepoName() string

func (*GetWorkspacesRequest) GetRepoOwner

func (x *GetWorkspacesRequest) GetRepoOwner() string

func (*GetWorkspacesRequest) GetRepoRef

func (x *GetWorkspacesRequest) GetRepoRef() string

func (*GetWorkspacesRequest) GetUsername

func (x *GetWorkspacesRequest) GetUsername() string

func (*GetWorkspacesRequest) GetWorkspace

func (x *GetWorkspacesRequest) GetWorkspace() string

func (*GetWorkspacesRequest) ProtoMessage

func (*GetWorkspacesRequest) ProtoMessage()

func (*GetWorkspacesRequest) ProtoReflect

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

func (*GetWorkspacesRequest) Reset

func (x *GetWorkspacesRequest) Reset()

func (*GetWorkspacesRequest) String

func (x *GetWorkspacesRequest) String() string

type GetWorkspacesResponse

type GetWorkspacesResponse struct {

	// workspaces holds the details of each matched workspace.
	Workspaces []*v1.WorkspaceDetails `protobuf:"bytes,1,rep,name=workspaces,proto3" json:"workspaces,omitempty"`
	// contains filtered or unexported fields
}

GetWorkspacesResponse contains the list of matching workspaces.

func (*GetWorkspacesResponse) Descriptor deprecated

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

Deprecated: Use GetWorkspacesResponse.ProtoReflect.Descriptor instead.

func (*GetWorkspacesResponse) GetWorkspaces

func (x *GetWorkspacesResponse) GetWorkspaces() []*v1.WorkspaceDetails

func (*GetWorkspacesResponse) ProtoMessage

func (*GetWorkspacesResponse) ProtoMessage()

func (*GetWorkspacesResponse) ProtoReflect

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

func (*GetWorkspacesResponse) Reset

func (x *GetWorkspacesResponse) Reset()

func (*GetWorkspacesResponse) String

func (x *GetWorkspacesResponse) String() string

type HandshakeResponse

type HandshakeResponse struct {

	// workspace is the name assigned to the workspace being provisioned.
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// jobid is the unique identifier for this provisioning job.
	Jobid string `protobuf:"bytes,2,opt,name=jobid,proto3" json:"jobid,omitempty"`
	// error is non-empty when the server rejects the request before streaming begins.
	Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

HandshakeResponse is the first message returned in a provisioning stream, confirming the job has been accepted.

func (*HandshakeResponse) Descriptor deprecated

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

Deprecated: Use HandshakeResponse.ProtoReflect.Descriptor instead.

func (*HandshakeResponse) GetError

func (x *HandshakeResponse) GetError() string

func (*HandshakeResponse) GetJobid

func (x *HandshakeResponse) GetJobid() string

func (*HandshakeResponse) GetWorkspace

func (x *HandshakeResponse) GetWorkspace() string

func (*HandshakeResponse) ProtoMessage

func (*HandshakeResponse) ProtoMessage()

func (*HandshakeResponse) ProtoReflect

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

func (*HandshakeResponse) Reset

func (x *HandshakeResponse) Reset()

func (*HandshakeResponse) String

func (x *HandshakeResponse) String() string

type ProvisionEvent

type ProvisionEvent struct {

	// type is the event category (e.g. "pod", "deployment", "job").
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// timestamp is the RFC 3339 time at which the event occurred.
	Timestamp string `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// object_name is the Kubernetes object name associated with this event.
	ObjectName string `protobuf:"bytes,3,opt,name=object_name,json=objectName,proto3" json:"object_name,omitempty"`
	// status is the observed status of the object (e.g. "Running", "Failed").
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// message provides additional human-readable detail about the event.
	Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

ProvisionEvent represents a single lifecycle event emitted during workspace provisionings.

func (*ProvisionEvent) Descriptor deprecated

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

Deprecated: Use ProvisionEvent.ProtoReflect.Descriptor instead.

func (*ProvisionEvent) GetMessage

func (x *ProvisionEvent) GetMessage() string

func (*ProvisionEvent) GetObjectName

func (x *ProvisionEvent) GetObjectName() string

func (*ProvisionEvent) GetStatus

func (x *ProvisionEvent) GetStatus() string

func (*ProvisionEvent) GetTimestamp

func (x *ProvisionEvent) GetTimestamp() string

func (*ProvisionEvent) GetType

func (x *ProvisionEvent) GetType() string

func (*ProvisionEvent) ProtoMessage

func (*ProvisionEvent) ProtoMessage()

func (*ProvisionEvent) ProtoReflect

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

func (*ProvisionEvent) Reset

func (x *ProvisionEvent) Reset()

func (*ProvisionEvent) String

func (x *ProvisionEvent) String() string

type ProvisionWorkspaceRequest

type ProvisionWorkspaceRequest struct {

	// userstr is the serialised user context string used to configure the workspace.
	Userstr string `protobuf:"bytes,1,opt,name=userstr,proto3" json:"userstr,omitempty"`
	// timeout is the maximum number of seconds to wait for provisioning to complete.
	Timeout int32 `protobuf:"varint,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// send_progress controls whether progress in percents are streamed.
	SendProgress bool `protobuf:"varint,3,opt,name=send_progress,json=sendProgress,proto3" json:"send_progress,omitempty"`
	// send_events controls whether Kubernetes object events are included in the stream.
	SendEvents bool `protobuf:"varint,4,opt,name=send_events,json=sendEvents,proto3" json:"send_events,omitempty"`
	// contains filtered or unexported fields
}

ProvisionWorkspaceRequest initiates provisioning of a new workspace.

func (*ProvisionWorkspaceRequest) Descriptor deprecated

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

Deprecated: Use ProvisionWorkspaceRequest.ProtoReflect.Descriptor instead.

func (*ProvisionWorkspaceRequest) GetSendEvents

func (x *ProvisionWorkspaceRequest) GetSendEvents() bool

func (*ProvisionWorkspaceRequest) GetSendProgress

func (x *ProvisionWorkspaceRequest) GetSendProgress() bool

func (*ProvisionWorkspaceRequest) GetTimeout

func (x *ProvisionWorkspaceRequest) GetTimeout() int32

func (*ProvisionWorkspaceRequest) GetUserstr

func (x *ProvisionWorkspaceRequest) GetUserstr() string

func (*ProvisionWorkspaceRequest) ProtoMessage

func (*ProvisionWorkspaceRequest) ProtoMessage()

func (*ProvisionWorkspaceRequest) ProtoReflect

func (*ProvisionWorkspaceRequest) Reset

func (x *ProvisionWorkspaceRequest) Reset()

func (*ProvisionWorkspaceRequest) String

func (x *ProvisionWorkspaceRequest) String() string

type ProvisionWorkspaceResponse

type ProvisionWorkspaceResponse struct {

	// Types that are valid to be assigned to Data:
	//
	//	*ProvisionWorkspaceResponse_Handshake
	//	*ProvisionWorkspaceResponse_Event
	Data isProvisionWorkspaceResponse_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

ProvisionWorkspaceResponse is a single message in the provisioning stream. It carries either the initial handshake or a subsequent provisioning event.

func (*ProvisionWorkspaceResponse) Descriptor deprecated

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

Deprecated: Use ProvisionWorkspaceResponse.ProtoReflect.Descriptor instead.

func (*ProvisionWorkspaceResponse) GetData

func (x *ProvisionWorkspaceResponse) GetData() isProvisionWorkspaceResponse_Data

func (*ProvisionWorkspaceResponse) GetEvent

func (*ProvisionWorkspaceResponse) GetHandshake

func (x *ProvisionWorkspaceResponse) GetHandshake() *HandshakeResponse

func (*ProvisionWorkspaceResponse) ProtoMessage

func (*ProvisionWorkspaceResponse) ProtoMessage()

func (*ProvisionWorkspaceResponse) ProtoReflect

func (*ProvisionWorkspaceResponse) Reset

func (x *ProvisionWorkspaceResponse) Reset()

func (*ProvisionWorkspaceResponse) String

func (x *ProvisionWorkspaceResponse) String() string

type ProvisionWorkspaceResponse_Event

type ProvisionWorkspaceResponse_Event struct {
	// event is a subsequent message carrying a provisioning lifecycle event.
	Event *ProvisionEvent `protobuf:"bytes,2,opt,name=event,proto3,oneof"`
}

type ProvisionWorkspaceResponse_Handshake

type ProvisionWorkspaceResponse_Handshake struct {
	// handshake is the first message in the stream, confirming the workspace
	// name and job ID assigned to this provisioning run.
	Handshake *HandshakeResponse `protobuf:"bytes,1,opt,name=handshake,proto3,oneof"`
}

type ProvisionerServiceClient

type ProvisionerServiceClient interface {
	// GetWorkspaces returns all workspaces matching the given filter criteria.
	GetWorkspaces(ctx context.Context, in *GetWorkspacesRequest, opts ...grpc.CallOption) (*GetWorkspacesResponse, error)
	// FindWorkspace returns the details of a single workspace by name.
	FindWorkspace(ctx context.Context, in *FindWorkspaceRequest, opts ...grpc.CallOption) (*v1.WorkspaceDetails, error)
	// GetWorkspacesByUserStr returns workspaces for the given userstr
	GetWorkspacesByUserStr(ctx context.Context, in *GetWorkspacesByUserStrRequest, opts ...grpc.CallOption) (*GetWorkspacesResponse, error)
	// GetUserBlueprints returns the list of blueprints available to a user.
	GetUserBlueprints(ctx context.Context, in *GetUserBlueprintsRequest, opts ...grpc.CallOption) (*GetUserBlueprintsResponse, error)
	// ProvisionWorkspaceStream provisions a new workspace and streams progress
	// events back to the caller until the workspace is ready or an error occurs.
	ProvisionWorkspaceStream(ctx context.Context, in *ProvisionWorkspaceRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ProvisionWorkspaceResponse], error)
	// DeleteWorkspace deprovisions and permanently removes a workspace.
	DeleteWorkspace(ctx context.Context, in *DeleteWorkspaceRequest, opts ...grpc.CallOption) (*DeleteWorkspaceResponse, error)
	// StopWorkspace suspends a running workspace without removing its state.
	StopWorkspace(ctx context.Context, in *StopWorkspaceRequest, opts ...grpc.CallOption) (*StopWorkspaceResponse, error)
	// EjectWorkspace removes a previously injected workspace from a workload
	// and deletes all supporting resources (ConfigMaps, PVCs, NetworkPolicies).
	EjectWorkspace(ctx context.Context, in *EjectWorkspaceRequest, opts ...grpc.CallOption) (*EjectWorkspaceResponse, error)
}

ProvisionerServiceClient is the client API for ProvisionerService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

ProvisionerService manages the full lifecycle of user workspaces. Clients interact with this service to provision new workspaces query workspace state, and tear down workspaces.

type ProvisionerServiceServer

type ProvisionerServiceServer interface {
	// GetWorkspaces returns all workspaces matching the given filter criteria.
	GetWorkspaces(context.Context, *GetWorkspacesRequest) (*GetWorkspacesResponse, error)
	// FindWorkspace returns the details of a single workspace by name.
	FindWorkspace(context.Context, *FindWorkspaceRequest) (*v1.WorkspaceDetails, error)
	// GetWorkspacesByUserStr returns workspaces for the given userstr
	GetWorkspacesByUserStr(context.Context, *GetWorkspacesByUserStrRequest) (*GetWorkspacesResponse, error)
	// GetUserBlueprints returns the list of blueprints available to a user.
	GetUserBlueprints(context.Context, *GetUserBlueprintsRequest) (*GetUserBlueprintsResponse, error)
	// ProvisionWorkspaceStream provisions a new workspace and streams progress
	// events back to the caller until the workspace is ready or an error occurs.
	ProvisionWorkspaceStream(*ProvisionWorkspaceRequest, grpc.ServerStreamingServer[ProvisionWorkspaceResponse]) error
	// DeleteWorkspace deprovisions and permanently removes a workspace.
	DeleteWorkspace(context.Context, *DeleteWorkspaceRequest) (*DeleteWorkspaceResponse, error)
	// StopWorkspace suspends a running workspace without removing its state.
	StopWorkspace(context.Context, *StopWorkspaceRequest) (*StopWorkspaceResponse, error)
	// EjectWorkspace removes a previously injected workspace from a workload
	// and deletes all supporting resources (ConfigMaps, PVCs, NetworkPolicies).
	EjectWorkspace(context.Context, *EjectWorkspaceRequest) (*EjectWorkspaceResponse, error)
	// contains filtered or unexported methods
}

ProvisionerServiceServer is the server API for ProvisionerService service. All implementations must embed UnimplementedProvisionerServiceServer for forward compatibility.

ProvisionerService manages the full lifecycle of user workspaces. Clients interact with this service to provision new workspaces query workspace state, and tear down workspaces.

type ProvisionerService_ProvisionWorkspaceStreamClient

type ProvisionerService_ProvisionWorkspaceStreamClient = grpc.ServerStreamingClient[ProvisionWorkspaceResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ProvisionerService_ProvisionWorkspaceStreamServer

type ProvisionerService_ProvisionWorkspaceStreamServer = grpc.ServerStreamingServer[ProvisionWorkspaceResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type StopWorkspaceRequest

type StopWorkspaceRequest struct {

	// workspace is the name of the workspace to stop.
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// delay_seconds defers the stop by the given number of seconds. Use 0 for
	// an immediate stop.
	DelaySeconds uint32 `protobuf:"varint,2,opt,name=delay_seconds,json=delaySeconds,proto3" json:"delay_seconds,omitempty"`
	// contains filtered or unexported fields
}

StopWorkspaceRequest identifies the workspace to stop.

func (*StopWorkspaceRequest) Descriptor deprecated

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

Deprecated: Use StopWorkspaceRequest.ProtoReflect.Descriptor instead.

func (*StopWorkspaceRequest) GetDelaySeconds

func (x *StopWorkspaceRequest) GetDelaySeconds() uint32

func (*StopWorkspaceRequest) GetWorkspace

func (x *StopWorkspaceRequest) GetWorkspace() string

func (*StopWorkspaceRequest) ProtoMessage

func (*StopWorkspaceRequest) ProtoMessage()

func (*StopWorkspaceRequest) ProtoReflect

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

func (*StopWorkspaceRequest) Reset

func (x *StopWorkspaceRequest) Reset()

func (*StopWorkspaceRequest) String

func (x *StopWorkspaceRequest) String() string

type StopWorkspaceResponse

type StopWorkspaceResponse struct {

	// message provides a human-readable description of the result.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

StopWorkspaceResponse reports the outcome of the stop operation.

func (*StopWorkspaceResponse) Descriptor deprecated

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

Deprecated: Use StopWorkspaceResponse.ProtoReflect.Descriptor instead.

func (*StopWorkspaceResponse) GetMessage

func (x *StopWorkspaceResponse) GetMessage() string

func (*StopWorkspaceResponse) ProtoMessage

func (*StopWorkspaceResponse) ProtoMessage()

func (*StopWorkspaceResponse) ProtoReflect

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

func (*StopWorkspaceResponse) Reset

func (x *StopWorkspaceResponse) Reset()

func (*StopWorkspaceResponse) String

func (x *StopWorkspaceResponse) String() string

type UnimplementedProvisionerServiceServer

type UnimplementedProvisionerServiceServer struct{}

UnimplementedProvisionerServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedProvisionerServiceServer) DeleteWorkspace

func (UnimplementedProvisionerServiceServer) EjectWorkspace

func (UnimplementedProvisionerServiceServer) FindWorkspace

func (UnimplementedProvisionerServiceServer) GetUserBlueprints

func (UnimplementedProvisionerServiceServer) GetWorkspaces

func (UnimplementedProvisionerServiceServer) GetWorkspacesByUserStr

func (UnimplementedProvisionerServiceServer) StopWorkspace

type UnsafeProvisionerServiceServer

type UnsafeProvisionerServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeProvisionerServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProvisionerServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL