Documentation
¶
Index ¶
- Variables
- type BlueprintSummary
- func (*BlueprintSummary) Descriptor() ([]byte, []int)deprecated
- func (x *BlueprintSummary) GetDescription() string
- func (x *BlueprintSummary) GetIsTemplate() bool
- func (x *BlueprintSummary) GetName() string
- func (*BlueprintSummary) ProtoMessage()
- func (x *BlueprintSummary) ProtoReflect() protoreflect.Message
- func (x *BlueprintSummary) Reset()
- func (x *BlueprintSummary) String() string
- type CompleteUserWebFlow
- func (*CompleteUserWebFlow) Descriptor() ([]byte, []int)deprecated
- func (x *CompleteUserWebFlow) GetCode() string
- func (x *CompleteUserWebFlow) GetState() string
- func (*CompleteUserWebFlow) ProtoMessage()
- func (x *CompleteUserWebFlow) ProtoReflect() protoreflect.Message
- func (x *CompleteUserWebFlow) Reset()
- func (x *CompleteUserWebFlow) String() string
- type OnboardUserDeviceFlow
- func (*OnboardUserDeviceFlow) Descriptor() ([]byte, []int)deprecated
- func (x *OnboardUserDeviceFlow) GetExpiresIn() int32
- func (x *OnboardUserDeviceFlow) GetProvider() string
- func (x *OnboardUserDeviceFlow) GetUserCode() string
- func (x *OnboardUserDeviceFlow) GetUsername() string
- func (x *OnboardUserDeviceFlow) GetVerificationUrl() string
- func (*OnboardUserDeviceFlow) ProtoMessage()
- func (x *OnboardUserDeviceFlow) ProtoReflect() protoreflect.Message
- func (x *OnboardUserDeviceFlow) Reset()
- func (x *OnboardUserDeviceFlow) String() string
- type OnboardUserWebFlow
- func (*OnboardUserWebFlow) Descriptor() ([]byte, []int)deprecated
- func (x *OnboardUserWebFlow) GetAuthUrl() string
- func (x *OnboardUserWebFlow) GetExpiresIn() int32
- func (x *OnboardUserWebFlow) GetProvider() string
- func (x *OnboardUserWebFlow) GetState() string
- func (*OnboardUserWebFlow) ProtoMessage()
- func (x *OnboardUserWebFlow) ProtoReflect() protoreflect.Message
- func (x *OnboardUserWebFlow) Reset()
- func (x *OnboardUserWebFlow) String() string
- type User
- func (*User) Descriptor() ([]byte, []int)deprecated
- func (x *User) GetBlueprints() []string
- func (x *User) GetEmail() string
- func (x *User) GetExpiresAt() *timestamppb.Timestamp
- func (x *User) GetFullname() string
- func (x *User) GetGid() uint32
- func (x *User) GetIsValid() bool
- func (x *User) GetLocked() bool
- func (x *User) GetOrganization() string
- func (x *User) GetPassword() string
- func (x *User) GetRoles() []string
- func (x *User) GetShell() string
- func (x *User) GetSource() string
- func (x *User) GetSudo() bool
- func (x *User) GetUid() uint32
- func (x *User) GetUsername() string
- func (*User) ProtoMessage()
- func (x *User) ProtoReflect() protoreflect.Message
- func (x *User) Reset()
- func (x *User) String() string
- type UserCredential
- func (*UserCredential) Descriptor() ([]byte, []int)deprecated
- func (x *UserCredential) GetCreatedAt() *timestamppb.Timestamp
- func (x *UserCredential) GetCredentialSource() string
- func (x *UserCredential) GetExpiresAt() *timestamppb.Timestamp
- func (x *UserCredential) GetId() uint32
- func (x *UserCredential) GetIsActive() bool
- func (x *UserCredential) GetSecret() string
- func (x *UserCredential) GetServiceName() string
- func (x *UserCredential) GetServiceScope() string
- func (x *UserCredential) GetSubject() string
- func (x *UserCredential) GetUpdatedAt() *timestamppb.Timestamp
- func (x *UserCredential) GetUsername() string
- func (*UserCredential) ProtoMessage()
- func (x *UserCredential) ProtoReflect() protoreflect.Message
- func (x *UserCredential) Reset()
- func (x *UserCredential) String() string
- type UserOnboardCapability
- func (*UserOnboardCapability) Descriptor() ([]byte, []int)deprecated
- func (x *UserOnboardCapability) GetCanOnboard() bool
- func (x *UserOnboardCapability) GetProvider() string
- func (x *UserOnboardCapability) GetUsername() string
- func (*UserOnboardCapability) ProtoMessage()
- func (x *UserOnboardCapability) ProtoReflect() protoreflect.Message
- func (x *UserOnboardCapability) Reset()
- func (x *UserOnboardCapability) String() string
- type WorkspaceDetails
- func (*WorkspaceDetails) Descriptor() ([]byte, []int)deprecated
- func (x *WorkspaceDetails) GetAppVersion() string
- func (x *WorkspaceDetails) GetBlueprint() string
- func (x *WorkspaceDetails) GetCpu() string
- func (x *WorkspaceDetails) GetHostname() string
- func (x *WorkspaceDetails) GetJobId() string
- func (x *WorkspaceDetails) GetMemory() string
- func (x *WorkspaceDetails) GetName() string
- func (x *WorkspaceDetails) GetNamespace() string
- func (x *WorkspaceDetails) GetOrganization() string
- func (x *WorkspaceDetails) GetPodIp() string
- func (x *WorkspaceDetails) GetPort() int32
- func (x *WorkspaceDetails) GetRepoName() string
- func (x *WorkspaceDetails) GetRepoOwner() string
- func (x *WorkspaceDetails) GetRepoRef() string
- func (x *WorkspaceDetails) GetServerName() string
- func (x *WorkspaceDetails) GetTlsEnabled() bool
- func (x *WorkspaceDetails) GetUsername() string
- func (x *WorkspaceDetails) GetWorkspaceStatus() *WorkspaceStatus
- func (*WorkspaceDetails) ProtoMessage()
- func (x *WorkspaceDetails) ProtoReflect() protoreflect.Message
- func (x *WorkspaceDetails) Reset()
- func (x *WorkspaceDetails) String() string
- type WorkspaceStatus
- func (*WorkspaceStatus) Descriptor() ([]byte, []int)deprecated
- func (x *WorkspaceStatus) GetCreated() *timestamppb.Timestamp
- func (x *WorkspaceStatus) GetLastFailMessage() string
- func (x *WorkspaceStatus) GetMessage() string
- func (x *WorkspaceStatus) GetRestarts() int32
- func (x *WorkspaceStatus) GetStatus() string
- func (*WorkspaceStatus) ProtoMessage()
- func (x *WorkspaceStatus) ProtoReflect() protoreflect.Message
- func (x *WorkspaceStatus) Reset()
- func (x *WorkspaceStatus) String() string
Constants ¶
This section is empty.
Variables ¶
var File_common_v1_common_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type BlueprintSummary ¶
type BlueprintSummary struct {
// name is the unique identifier of the blueprint.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// description is a short human-readable summary of what the blueprint provides.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// is_template indicates whether this blueprint is a base template that other
// blueprints may derive from.
IsTemplate bool `protobuf:"varint,3,opt,name=is_template,json=isTemplate,proto3" json:"is_template,omitempty"`
// contains filtered or unexported fields
}
BlueprintSummary is a lightweight representation of a blueprint used in listing responses.
func (*BlueprintSummary) Descriptor
deprecated
func (*BlueprintSummary) Descriptor() ([]byte, []int)
Deprecated: Use BlueprintSummary.ProtoReflect.Descriptor instead.
func (*BlueprintSummary) GetDescription ¶
func (x *BlueprintSummary) GetDescription() string
func (*BlueprintSummary) GetIsTemplate ¶
func (x *BlueprintSummary) GetIsTemplate() bool
func (*BlueprintSummary) GetName ¶
func (x *BlueprintSummary) GetName() string
func (*BlueprintSummary) ProtoMessage ¶
func (*BlueprintSummary) ProtoMessage()
func (*BlueprintSummary) ProtoReflect ¶
func (x *BlueprintSummary) ProtoReflect() protoreflect.Message
func (*BlueprintSummary) Reset ¶
func (x *BlueprintSummary) Reset()
func (*BlueprintSummary) String ¶
func (x *BlueprintSummary) String() string
type CompleteUserWebFlow ¶
type CompleteUserWebFlow struct {
// code is the authorization code returned by the provider.
Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
// state is the CSRF token that must match the value from OnboardUserWebFlow.
State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
// contains filtered or unexported fields
}
CompleteUserWebFlow carries the callback parameters returned by the provider after the user completes the web authorization flow.
func (*CompleteUserWebFlow) Descriptor
deprecated
func (*CompleteUserWebFlow) Descriptor() ([]byte, []int)
Deprecated: Use CompleteUserWebFlow.ProtoReflect.Descriptor instead.
func (*CompleteUserWebFlow) GetCode ¶
func (x *CompleteUserWebFlow) GetCode() string
func (*CompleteUserWebFlow) GetState ¶
func (x *CompleteUserWebFlow) GetState() string
func (*CompleteUserWebFlow) ProtoMessage ¶
func (*CompleteUserWebFlow) ProtoMessage()
func (*CompleteUserWebFlow) ProtoReflect ¶
func (x *CompleteUserWebFlow) ProtoReflect() protoreflect.Message
func (*CompleteUserWebFlow) Reset ¶
func (x *CompleteUserWebFlow) Reset()
func (*CompleteUserWebFlow) String ¶
func (x *CompleteUserWebFlow) String() string
type OnboardUserDeviceFlow ¶
type OnboardUserDeviceFlow struct {
// provider identifies the OAuth/OIDC provider initiating the flow (e.g. "github").
Provider string `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
// username is the k8Shell user being onboarded.
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
// user_code is the short code the user enters on the verification page.
UserCode string `protobuf:"bytes,3,opt,name=user_code,json=userCode,proto3" json:"user_code,omitempty"`
// verification_url is the URL the user visits to authorise the device.
VerificationUrl string `protobuf:"bytes,4,opt,name=verification_url,json=verificationUrl,proto3" json:"verification_url,omitempty"`
// expires_in is the number of seconds until the user_code expires.
ExpiresIn int32 `protobuf:"varint,5,opt,name=expires_in,json=expiresIn,proto3" json:"expires_in,omitempty"`
// contains filtered or unexported fields
}
OnboardUserDeviceFlow carries the data needed to complete a Device Authorization Grant (RFC 8628) onboarding flow.
func (*OnboardUserDeviceFlow) Descriptor
deprecated
func (*OnboardUserDeviceFlow) Descriptor() ([]byte, []int)
Deprecated: Use OnboardUserDeviceFlow.ProtoReflect.Descriptor instead.
func (*OnboardUserDeviceFlow) GetExpiresIn ¶
func (x *OnboardUserDeviceFlow) GetExpiresIn() int32
func (*OnboardUserDeviceFlow) GetProvider ¶
func (x *OnboardUserDeviceFlow) GetProvider() string
func (*OnboardUserDeviceFlow) GetUserCode ¶
func (x *OnboardUserDeviceFlow) GetUserCode() string
func (*OnboardUserDeviceFlow) GetUsername ¶
func (x *OnboardUserDeviceFlow) GetUsername() string
func (*OnboardUserDeviceFlow) GetVerificationUrl ¶
func (x *OnboardUserDeviceFlow) GetVerificationUrl() string
func (*OnboardUserDeviceFlow) ProtoMessage ¶
func (*OnboardUserDeviceFlow) ProtoMessage()
func (*OnboardUserDeviceFlow) ProtoReflect ¶
func (x *OnboardUserDeviceFlow) ProtoReflect() protoreflect.Message
func (*OnboardUserDeviceFlow) Reset ¶
func (x *OnboardUserDeviceFlow) Reset()
func (*OnboardUserDeviceFlow) String ¶
func (x *OnboardUserDeviceFlow) String() string
type OnboardUserWebFlow ¶
type OnboardUserWebFlow struct {
// provider identifies the OAuth/OIDC provider (e.g. "github").
Provider string `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
// auth_url is the provider's authorization endpoint the user should be
// redirected to.
AuthUrl string `protobuf:"bytes,2,opt,name=auth_url,json=authUrl,proto3" json:"auth_url,omitempty"`
// state is the CSRF token that must be verified when the callback is received.
State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
// expires_in is the number of seconds until the flow expires.
ExpiresIn int32 `protobuf:"varint,4,opt,name=expires_in,json=expiresIn,proto3" json:"expires_in,omitempty"`
// contains filtered or unexported fields
}
OnboardUserWebFlow carries the data needed to initiate an Authorization Code (web redirect) onboarding flow.
func (*OnboardUserWebFlow) Descriptor
deprecated
func (*OnboardUserWebFlow) Descriptor() ([]byte, []int)
Deprecated: Use OnboardUserWebFlow.ProtoReflect.Descriptor instead.
func (*OnboardUserWebFlow) GetAuthUrl ¶
func (x *OnboardUserWebFlow) GetAuthUrl() string
func (*OnboardUserWebFlow) GetExpiresIn ¶
func (x *OnboardUserWebFlow) GetExpiresIn() int32
func (*OnboardUserWebFlow) GetProvider ¶
func (x *OnboardUserWebFlow) GetProvider() string
func (*OnboardUserWebFlow) GetState ¶
func (x *OnboardUserWebFlow) GetState() string
func (*OnboardUserWebFlow) ProtoMessage ¶
func (*OnboardUserWebFlow) ProtoMessage()
func (*OnboardUserWebFlow) ProtoReflect ¶
func (x *OnboardUserWebFlow) ProtoReflect() protoreflect.Message
func (*OnboardUserWebFlow) Reset ¶
func (x *OnboardUserWebFlow) Reset()
func (*OnboardUserWebFlow) String ¶
func (x *OnboardUserWebFlow) String() string
type User ¶
type User struct {
// username is the unique login name of the user.
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
// organization is the tenant the user belongs to.
Organization string `protobuf:"bytes,2,opt,name=organization,proto3" json:"organization,omitempty"`
// is_valid indicates whether the user's session or token is currently valid.
IsValid bool `protobuf:"varint,3,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"`
// expires_at is the time at which the user's session expires.
ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
// uid is the POSIX user ID assigned to the user.
Uid uint32 `protobuf:"varint,5,opt,name=uid,proto3" json:"uid,omitempty"`
// gid is the POSIX primary group ID assigned to the user.
Gid uint32 `protobuf:"varint,6,opt,name=gid,proto3" json:"gid,omitempty"`
// fullname is the display name of the user.
Fullname string `protobuf:"bytes,7,opt,name=fullname,proto3" json:"fullname,omitempty"`
// email is the user's email address.
Email string `protobuf:"bytes,9,opt,name=email,proto3" json:"email,omitempty"`
// password is the hashed password. Never populated in read responses.
Password string `protobuf:"bytes,10,opt,name=password,proto3" json:"password,omitempty"`
// locked indicates whether the account has been administratively locked.
Locked bool `protobuf:"varint,13,opt,name=locked,proto3" json:"locked,omitempty"`
// roles lists the RBAC roles assigned to this user.
Roles []string `protobuf:"bytes,17,rep,name=roles,proto3" json:"roles,omitempty"`
// blueprints lists the blueprints the user is permitted to use.
Blueprints []string `protobuf:"bytes,18,rep,name=blueprints,proto3" json:"blueprints,omitempty"`
// source identifies the identity provider that created this user (e.g. "github", "ldap").
Source string `protobuf:"bytes,19,opt,name=source,proto3" json:"source,omitempty"`
// shell is the user's preferred shell environment (e.g. "bash", "zsh").
Shell string `protobuf:"bytes,20,opt,name=shell,proto3" json:"shell,omitempty"`
// sudo indicates whether the user has permission to use sudo in their workspace.
Sudo bool `protobuf:"varint,21,opt,name=sudo,proto3" json:"sudo,omitempty"`
// contains filtered or unexported fields
}
User represents an authenticated k8Shell user account.
func (*User) Descriptor
deprecated
func (*User) GetBlueprints ¶
func (*User) GetExpiresAt ¶
func (x *User) GetExpiresAt() *timestamppb.Timestamp
func (*User) GetFullname ¶
func (*User) GetIsValid ¶
func (*User) GetOrganization ¶
func (*User) GetPassword ¶
func (*User) GetUsername ¶
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) ProtoReflect ¶
func (x *User) ProtoReflect() protoreflect.Message
type UserCredential ¶
type UserCredential struct {
// id is the internal database identifier for this credential.
Id uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
// username is the k8Shell user that owns this credential.
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
// service_name identifies the type of service (e.g. "registry", "git", "kubernetes").
ServiceName string `protobuf:"bytes,3,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// service_scope is the registry/host URL or Kubernetes namespace
ServiceScope string `protobuf:"bytes,4,opt,name=service_scope,json=serviceScope,proto3" json:"service_scope,omitempty"`
// credential_source identifies how the credential was provisioned (e.g. "oauth", "manual", "dynamic").
CredentialSource string `protobuf:"bytes,11,opt,name=credential_source,json=credentialSource,proto3" json:"credential_source,omitempty"`
// subject is the login name or service account name
Subject string `protobuf:"bytes,5,opt,name=subject,proto3" json:"subject,omitempty"`
// secret is the stored credential (OAuth token, API key, password)
Secret string `protobuf:"bytes,6,opt,name=secret,proto3" json:"secret,omitempty"`
// is_active indicates whether this credential is currently active.
IsActive bool `protobuf:"varint,7,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"`
// created_at is the time the credential was created.
CreatedAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
// updated_at is the time the credential was last updated.
UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
// expires_at is the time at which the secret expires, if known.
ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
// contains filtered or unexported fields
}
UserCredential stores a token or credential issued by an external service on behalf of a user (e.g. a GitHub OAuth token).
func (*UserCredential) Descriptor
deprecated
func (*UserCredential) Descriptor() ([]byte, []int)
Deprecated: Use UserCredential.ProtoReflect.Descriptor instead.
func (*UserCredential) GetCreatedAt ¶
func (x *UserCredential) GetCreatedAt() *timestamppb.Timestamp
func (*UserCredential) GetCredentialSource ¶
func (x *UserCredential) GetCredentialSource() string
func (*UserCredential) GetExpiresAt ¶
func (x *UserCredential) GetExpiresAt() *timestamppb.Timestamp
func (*UserCredential) GetId ¶
func (x *UserCredential) GetId() uint32
func (*UserCredential) GetIsActive ¶
func (x *UserCredential) GetIsActive() bool
func (*UserCredential) GetSecret ¶
func (x *UserCredential) GetSecret() string
func (*UserCredential) GetServiceName ¶
func (x *UserCredential) GetServiceName() string
func (*UserCredential) GetServiceScope ¶
func (x *UserCredential) GetServiceScope() string
func (*UserCredential) GetSubject ¶
func (x *UserCredential) GetSubject() string
func (*UserCredential) GetUpdatedAt ¶
func (x *UserCredential) GetUpdatedAt() *timestamppb.Timestamp
func (*UserCredential) GetUsername ¶
func (x *UserCredential) GetUsername() string
func (*UserCredential) ProtoMessage ¶
func (*UserCredential) ProtoMessage()
func (*UserCredential) ProtoReflect ¶
func (x *UserCredential) ProtoReflect() protoreflect.Message
func (*UserCredential) Reset ¶
func (x *UserCredential) Reset()
func (*UserCredential) String ¶
func (x *UserCredential) String() string
type UserOnboardCapability ¶
type UserOnboardCapability struct {
// provider is the OAuth/OIDC provider being queried.
Provider string `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider,omitempty"`
// username is the user being checked.
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
// can_onboard is true when the user is eligible to onboard via this provider.
CanOnboard bool `protobuf:"varint,3,opt,name=can_onboard,json=canOnboard,proto3" json:"can_onboard,omitempty"`
// contains filtered or unexported fields
}
UserOnboardCapability reports whether a user can be onboarded via a specific provider.
func (*UserOnboardCapability) Descriptor
deprecated
func (*UserOnboardCapability) Descriptor() ([]byte, []int)
Deprecated: Use UserOnboardCapability.ProtoReflect.Descriptor instead.
func (*UserOnboardCapability) GetCanOnboard ¶
func (x *UserOnboardCapability) GetCanOnboard() bool
func (*UserOnboardCapability) GetProvider ¶
func (x *UserOnboardCapability) GetProvider() string
func (*UserOnboardCapability) GetUsername ¶
func (x *UserOnboardCapability) GetUsername() string
func (*UserOnboardCapability) ProtoMessage ¶
func (*UserOnboardCapability) ProtoMessage()
func (*UserOnboardCapability) ProtoReflect ¶
func (x *UserOnboardCapability) ProtoReflect() protoreflect.Message
func (*UserOnboardCapability) Reset ¶
func (x *UserOnboardCapability) Reset()
func (*UserOnboardCapability) String ¶
func (x *UserOnboardCapability) String() string
type WorkspaceDetails ¶
type WorkspaceDetails struct {
// workspace_status holds the observed workspace status.
WorkspaceStatus *WorkspaceStatus `protobuf:"bytes,1,opt,name=workspace_status,json=workspaceStatus,proto3" json:"workspace_status,omitempty"`
// app_version is the version of the workspace application image in use.
AppVersion string `protobuf:"bytes,2,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
// name is the unique name of the workspace.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// username is the owner of this workspace.
Username string `protobuf:"bytes,4,opt,name=username,proto3" json:"username,omitempty"`
// organization is the tenant that owns this workspace.
Organization string `protobuf:"bytes,5,opt,name=organization,proto3" json:"organization,omitempty"`
// repo_owner is the VCS owner of the repository attached to this workspace.
RepoOwner string `protobuf:"bytes,6,opt,name=repo_owner,json=repoOwner,proto3" json:"repo_owner,omitempty"`
// repo_name is the name of the repository attached to this workspace.
RepoName string `protobuf:"bytes,7,opt,name=repo_name,json=repoName,proto3" json:"repo_name,omitempty"`
// repo_ref is the branch, tag, or commit SHA the workspace is based on.
RepoRef string `protobuf:"bytes,8,opt,name=repo_ref,json=repoRef,proto3" json:"repo_ref,omitempty"`
// blueprint is the name of the blueprint used to provision this workspace.
Blueprint string `protobuf:"bytes,9,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
// server_name is the k8Shell server node this workspace is scheduled on.
ServerName string `protobuf:"bytes,10,opt,name=server_name,json=serverName,proto3" json:"server_name,omitempty"`
// pod_ip is the cluster-internal IP address of the workspace pod.
PodIp string `protobuf:"bytes,11,opt,name=pod_ip,json=podIp,proto3" json:"pod_ip,omitempty"`
// port is the port on which the workspace IDE or application is listening.
Port int32 `protobuf:"varint,12,opt,name=port,proto3" json:"port,omitempty"`
// tls_enabled indicates whether TLS is enabled for the workspace endpoint.
TlsEnabled bool `protobuf:"varint,13,opt,name=tls_enabled,json=tlsEnabled,proto3" json:"tls_enabled,omitempty"`
// cpu is the CPU resource allocation in Kubernetes quantity format (e.g. "500m").
Cpu string `protobuf:"bytes,15,opt,name=cpu,proto3" json:"cpu,omitempty"`
// memory is the memory resource allocation in Kubernetes quantity format (e.g. "1Gi").
Memory string `protobuf:"bytes,16,opt,name=memory,proto3" json:"memory,omitempty"`
// hostname is the externally reachable hostname of the workspace.
Hostname string `protobuf:"bytes,17,opt,name=hostname,proto3" json:"hostname,omitempty"`
// job_id is the identifier of the provisioning job that created this workspace.
JobId string `protobuf:"bytes,18,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
// namespace is the Kubernetes namespace in which the workspace pod is running.
Namespace string `protobuf:"bytes,19,opt,name=namespace,proto3" json:"namespace,omitempty"`
// contains filtered or unexported fields
}
WorkspaceDetails describes a user workspace and its current runtime state.
func (*WorkspaceDetails) Descriptor
deprecated
func (*WorkspaceDetails) Descriptor() ([]byte, []int)
Deprecated: Use WorkspaceDetails.ProtoReflect.Descriptor instead.
func (*WorkspaceDetails) GetAppVersion ¶
func (x *WorkspaceDetails) GetAppVersion() string
func (*WorkspaceDetails) GetBlueprint ¶
func (x *WorkspaceDetails) GetBlueprint() string
func (*WorkspaceDetails) GetCpu ¶
func (x *WorkspaceDetails) GetCpu() string
func (*WorkspaceDetails) GetHostname ¶
func (x *WorkspaceDetails) GetHostname() string
func (*WorkspaceDetails) GetJobId ¶
func (x *WorkspaceDetails) GetJobId() string
func (*WorkspaceDetails) GetMemory ¶
func (x *WorkspaceDetails) GetMemory() string
func (*WorkspaceDetails) GetName ¶
func (x *WorkspaceDetails) GetName() string
func (*WorkspaceDetails) GetNamespace ¶
func (x *WorkspaceDetails) GetNamespace() string
func (*WorkspaceDetails) GetOrganization ¶
func (x *WorkspaceDetails) GetOrganization() string
func (*WorkspaceDetails) GetPodIp ¶
func (x *WorkspaceDetails) GetPodIp() string
func (*WorkspaceDetails) GetPort ¶
func (x *WorkspaceDetails) GetPort() int32
func (*WorkspaceDetails) GetRepoName ¶
func (x *WorkspaceDetails) GetRepoName() string
func (*WorkspaceDetails) GetRepoOwner ¶
func (x *WorkspaceDetails) GetRepoOwner() string
func (*WorkspaceDetails) GetRepoRef ¶
func (x *WorkspaceDetails) GetRepoRef() string
func (*WorkspaceDetails) GetServerName ¶
func (x *WorkspaceDetails) GetServerName() string
func (*WorkspaceDetails) GetTlsEnabled ¶
func (x *WorkspaceDetails) GetTlsEnabled() bool
func (*WorkspaceDetails) GetUsername ¶
func (x *WorkspaceDetails) GetUsername() string
func (*WorkspaceDetails) GetWorkspaceStatus ¶
func (x *WorkspaceDetails) GetWorkspaceStatus() *WorkspaceStatus
func (*WorkspaceDetails) ProtoMessage ¶
func (*WorkspaceDetails) ProtoMessage()
func (*WorkspaceDetails) ProtoReflect ¶
func (x *WorkspaceDetails) ProtoReflect() protoreflect.Message
func (*WorkspaceDetails) Reset ¶
func (x *WorkspaceDetails) Reset()
func (*WorkspaceDetails) String ¶
func (x *WorkspaceDetails) String() string
type WorkspaceStatus ¶
type WorkspaceStatus struct {
// created is the time the workspace was created.
Created *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=created,proto3" json:"created,omitempty"`
// status is the current workspace status (e.g. "Starting", "Running", "Failing").
Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
// message provides additional human-readable detail about the current status.
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
// restarts is the number of times the pod's primary container has restarted.
Restarts int32 `protobuf:"varint,4,opt,name=restarts,proto3" json:"restarts,omitempty"`
// last_fail_message is the termination message from the last container failure,
// if any.
LastFailMessage string `protobuf:"bytes,5,opt,name=last_fail_message,json=lastFailMessage,proto3" json:"last_fail_message,omitempty"`
// contains filtered or unexported fields
}
WorkspaceStatus represents the observed status of a workspace.
func (*WorkspaceStatus) Descriptor
deprecated
func (*WorkspaceStatus) Descriptor() ([]byte, []int)
Deprecated: Use WorkspaceStatus.ProtoReflect.Descriptor instead.
func (*WorkspaceStatus) GetCreated ¶
func (x *WorkspaceStatus) GetCreated() *timestamppb.Timestamp
func (*WorkspaceStatus) GetLastFailMessage ¶
func (x *WorkspaceStatus) GetLastFailMessage() string
func (*WorkspaceStatus) GetMessage ¶
func (x *WorkspaceStatus) GetMessage() string
func (*WorkspaceStatus) GetRestarts ¶
func (x *WorkspaceStatus) GetRestarts() int32
func (*WorkspaceStatus) GetStatus ¶
func (x *WorkspaceStatus) GetStatus() string
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