datamodelv1

package
v0.1.6 Latest Latest
Warning

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

Go to latest
Published: Oct 27, 2026 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	WorkspacePhase_name = map[int32]string{
		0: "WORKSPACE_PHASE_UNSPECIFIED",
		1: "WORKSPACE_PHASE_ACTIVE",
		2: "WORKSPACE_PHASE_TERMINATING",
	}
	WorkspacePhase_value = map[string]int32{
		"WORKSPACE_PHASE_UNSPECIFIED": 0,
		"WORKSPACE_PHASE_ACTIVE":      1,
		"WORKSPACE_PHASE_TERMINATING": 2,
	}
)

Enum value maps for WorkspacePhase.

View Source
var File_datamodel_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AllWorkspaces

type AllWorkspaces struct {
	// contains filtered or unexported fields
}

Marker for the all-workspaces selector variant.

func (*AllWorkspaces) Descriptor deprecated

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

Deprecated: Use AllWorkspaces.ProtoReflect.Descriptor instead.

func (*AllWorkspaces) ProtoMessage

func (*AllWorkspaces) ProtoMessage()

func (*AllWorkspaces) ProtoReflect

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

func (*AllWorkspaces) Reset

func (x *AllWorkspaces) Reset()

func (*AllWorkspaces) String

func (x *AllWorkspaces) String() string

type CredentialHandle

type CredentialHandle struct {

	// Internal storage owner or credential driver that owns this handle.
	Driver string `protobuf:"bytes,1,opt,name=driver,proto3" json:"driver,omitempty"`
	// Owner-owned opaque handle string.
	Handle string `protobuf:"bytes,2,opt,name=handle,proto3" json:"handle,omitempty"`
	// Owner-owned non-secret metadata.
	Metadata map[string]string `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Opaque handle for a provider credential stored by gateway credential storage. Handles are created by OpenShell and must not be authored by users.

func (*CredentialHandle) Descriptor deprecated

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

Deprecated: Use CredentialHandle.ProtoReflect.Descriptor instead.

func (*CredentialHandle) GetDriver

func (x *CredentialHandle) GetDriver() string

func (*CredentialHandle) GetHandle

func (x *CredentialHandle) GetHandle() string

func (*CredentialHandle) GetMetadata

func (x *CredentialHandle) GetMetadata() map[string]string

func (*CredentialHandle) ProtoMessage

func (*CredentialHandle) ProtoMessage()

func (*CredentialHandle) ProtoReflect

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

func (*CredentialHandle) Reset

func (x *CredentialHandle) Reset()

func (*CredentialHandle) String

func (x *CredentialHandle) String() string

type ObjectMeta

type ObjectMeta struct {

	// Stable object ID generated by the gateway.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Human-readable object name (unique per object type).
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Time when the object was created.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,103,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"`
	// Key-value labels for filtering and organization.
	// Labels must follow Kubernetes conventions: alphanumeric + `-._/`, max 63 chars per segment.
	Labels map[string]string `` /* 139-byte string literal not displayed */
	// Optimistic concurrency control version.
	// Incremented by the gateway on each update. Clients can use this for compare-and-swap operations.
	ResourceVersion uint64 `protobuf:"varint,5,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty"`
	// Opaque key-value metadata that is not used for selectors.
	// Annotation keys use the same qualified-key shape as labels, but values may be longer.
	Annotations map[string]string `` /* 149-byte string literal not displayed */
	// Workspace that owns this resource. Empty is normalized to "default" by the
	// gateway. Immutable after creation.
	Workspace string `protobuf:"bytes,7,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// Time when graceful deletion was initiated. Absence means the object is
	// not being deleted. Once set, this field is
	// immutable — the only path forward is completing deletion.
	DeletionTime *timestamppb.Timestamp `protobuf:"bytes,108,opt,name=deletion_time,json=deletionTime,proto3" json:"deletion_time,omitempty"`
	// contains filtered or unexported fields
}

Kubernetes-style metadata shared by all top-level OpenShell domain objects.

This structure provides consistent metadata (identity, labels, annotations, timestamps, resource versioning) across Sandbox, Provider, SshSession, and other resources.

func (*ObjectMeta) Descriptor deprecated

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

Deprecated: Use ObjectMeta.ProtoReflect.Descriptor instead.

func (*ObjectMeta) GetAnnotations

func (x *ObjectMeta) GetAnnotations() map[string]string

func (*ObjectMeta) GetCreatedTime

func (x *ObjectMeta) GetCreatedTime() *timestamppb.Timestamp

func (*ObjectMeta) GetDeletionTime

func (x *ObjectMeta) GetDeletionTime() *timestamppb.Timestamp

func (*ObjectMeta) GetId

func (x *ObjectMeta) GetId() string

func (*ObjectMeta) GetLabels

func (x *ObjectMeta) GetLabels() map[string]string

func (*ObjectMeta) GetName

func (x *ObjectMeta) GetName() string

func (*ObjectMeta) GetResourceVersion

func (x *ObjectMeta) GetResourceVersion() uint64

func (*ObjectMeta) GetWorkspace

func (x *ObjectMeta) GetWorkspace() string

func (*ObjectMeta) ProtoMessage

func (*ObjectMeta) ProtoMessage()

func (*ObjectMeta) ProtoReflect

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

func (*ObjectMeta) Reset

func (x *ObjectMeta) Reset()

func (*ObjectMeta) String

func (x *ObjectMeta) String() string

type Provider

type Provider struct {

	// Kubernetes-style metadata (id, name, labels, timestamps, resource version).
	Metadata *ObjectMeta `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// ID of the provider profile this provider was created from, matched
	// exactly (for example: "claude-code", "github").
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Secret values used for authentication.
	Credentials map[string]string `` /* 149-byte string literal not displayed */
	// Non-secret provider configuration.
	Config map[string]string `` /* 139-byte string literal not displayed */
	// Expiration times for credential values, keyed by credential/env var name.
	// A missing key means the credential does not expire.
	CredentialExpirationTimes map[string]*timestamppb.Timestamp `` /* 214-byte string literal not displayed */
	// Workspace where this provider's type profile is stored.
	// Empty string = platform/global scope. Must be empty or match
	// metadata.workspace; cross-workspace references are rejected.
	ProfileWorkspace string `protobuf:"bytes,6,opt,name=profile_workspace,json=profileWorkspace,proto3" json:"profile_workspace,omitempty"`
	// Opaque handles for secret values stored through gateway credential storage.
	// This map is internal gateway state and is not accepted as user-authored input.
	CredentialHandles map[string]*CredentialHandle `` /* 186-byte string literal not displayed */
	// contains filtered or unexported fields
}

Provider model stored by OpenShell.

func (*Provider) Descriptor deprecated

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

Deprecated: Use Provider.ProtoReflect.Descriptor instead.

func (*Provider) GetConfig

func (x *Provider) GetConfig() map[string]string

func (*Provider) GetCredentialExpirationTimes

func (x *Provider) GetCredentialExpirationTimes() map[string]*timestamppb.Timestamp

func (*Provider) GetCredentialHandles

func (x *Provider) GetCredentialHandles() map[string]*CredentialHandle

func (*Provider) GetCredentials

func (x *Provider) GetCredentials() map[string]string

func (*Provider) GetMetadata

func (x *Provider) GetMetadata() *ObjectMeta

func (*Provider) GetProfileWorkspace

func (x *Provider) GetProfileWorkspace() string

func (*Provider) GetType

func (x *Provider) GetType() string

func (*Provider) ProtoMessage

func (*Provider) ProtoMessage()

func (*Provider) ProtoReflect

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

func (*Provider) Reset

func (x *Provider) Reset()

func (*Provider) String

func (x *Provider) String() string

type Workspace

type Workspace struct {

	// Kubernetes-style metadata (id, name, labels, timestamps, resource version).
	// The workspace field in this ObjectMeta is unused (a workspace does not
	// belong to another workspace).
	Metadata *ObjectMeta `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Current lifecycle status.
	Status *WorkspaceStatus `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Workspace resource. A hard isolation boundary for sandboxes, providers, and other workspace-scoped resources.

func (*Workspace) Descriptor deprecated

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

Deprecated: Use Workspace.ProtoReflect.Descriptor instead.

func (*Workspace) GetMetadata

func (x *Workspace) GetMetadata() *ObjectMeta

func (*Workspace) GetStatus

func (x *Workspace) GetStatus() *WorkspaceStatus

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 WorkspacePhase

type WorkspacePhase int32

Phase of a workspace's lifecycle.

const (
	WorkspacePhase_WORKSPACE_PHASE_UNSPECIFIED WorkspacePhase = 0
	WorkspacePhase_WORKSPACE_PHASE_ACTIVE      WorkspacePhase = 1
	WorkspacePhase_WORKSPACE_PHASE_TERMINATING WorkspacePhase = 2
)

func (WorkspacePhase) Descriptor

func (WorkspacePhase) Enum

func (x WorkspacePhase) Enum() *WorkspacePhase

func (WorkspacePhase) EnumDescriptor deprecated

func (WorkspacePhase) EnumDescriptor() ([]byte, []int)

Deprecated: Use WorkspacePhase.Descriptor instead.

func (WorkspacePhase) Number

func (WorkspacePhase) String

func (x WorkspacePhase) String() string

func (WorkspacePhase) Type

type WorkspaceSelector

type WorkspaceSelector struct {

	// Types that are valid to be assigned to Selection:
	//
	//	*WorkspaceSelector_Workspace
	//	*WorkspaceSelector_AllWorkspaces
	Selection isWorkspaceSelector_Selection `protobuf_oneof:"selection"`
	// contains filtered or unexported fields
}

Selects the workspace scope for a public API request.

Requests that operate on one workspace require a non-empty `workspace`. Cross-workspace list requests additionally accept `all_workspaces`. The containing request documents which selections it supports; an omitted selector is invalid for workspace-scoped operations.

func (*WorkspaceSelector) Descriptor deprecated

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

Deprecated: Use WorkspaceSelector.ProtoReflect.Descriptor instead.

func (*WorkspaceSelector) GetAllWorkspaces

func (x *WorkspaceSelector) GetAllWorkspaces() *AllWorkspaces

func (*WorkspaceSelector) GetSelection

func (x *WorkspaceSelector) GetSelection() isWorkspaceSelector_Selection

func (*WorkspaceSelector) GetWorkspace

func (x *WorkspaceSelector) GetWorkspace() string

func (*WorkspaceSelector) ProtoMessage

func (*WorkspaceSelector) ProtoMessage()

func (*WorkspaceSelector) ProtoReflect

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

func (*WorkspaceSelector) Reset

func (x *WorkspaceSelector) Reset()

func (*WorkspaceSelector) String

func (x *WorkspaceSelector) String() string

type WorkspaceSelector_AllWorkspaces

type WorkspaceSelector_AllWorkspaces struct {
	// All workspaces the caller is authorized to access. Only supported by
	// requests that explicitly document cross-workspace behavior.
	AllWorkspaces *AllWorkspaces `protobuf:"bytes,2,opt,name=all_workspaces,json=allWorkspaces,proto3,oneof"`
}

type WorkspaceSelector_Workspace

type WorkspaceSelector_Workspace struct {
	// One explicitly named workspace. Use `default` to select the gateway's
	// default workspace; an empty name is invalid.
	Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3,oneof"`
}

type WorkspaceStatus

type WorkspaceStatus struct {
	Phase WorkspacePhase `protobuf:"varint,1,opt,name=phase,proto3,enum=openshell.datamodel.v1.WorkspacePhase" json:"phase,omitempty"`
	// contains filtered or unexported fields
}

Status of a workspace.

func (*WorkspaceStatus) Descriptor deprecated

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

Deprecated: Use WorkspaceStatus.ProtoReflect.Descriptor instead.

func (*WorkspaceStatus) GetPhase

func (x *WorkspaceStatus) GetPhase() WorkspacePhase

func (*WorkspaceStatus) ProtoMessage

func (*WorkspaceStatus) ProtoMessage()

func (*WorkspaceStatus) ProtoReflect

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

func (*WorkspaceStatus) Reset

func (x *WorkspaceStatus) Reset()

func (*WorkspaceStatus) String

func (x *WorkspaceStatus) String() string

Jump to

Keyboard shortcuts

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