workspace

Documentation

Index

• type AccessURL
• type Client
  • func NewClient(iamClient *iam.Client, config *ai.Config) (*Client, error)
• type LogArtefact
• type Service
  • func (s *Service) CreateWorkspace(model Workspace) (*Workspace, *ai.Response, error)
  • func (s *Service) DeleteWorkspace(ws Workspace) (*ai.Response, error)
  • func (s *Service) GetWorkspaceAccessURL(ws Workspace) (*AccessURL, *ai.Response, error)
  • func (s *Service) GetWorkspaceByID(id string) (*Workspace, *ai.Response, error)
  • func (s *Service) GetWorkspaceLogs(ws Workspace) (*LogArtefact, *ai.Response, error)
  • func (s *Service) GetWorkspaces(opt *ai.GetOptions, options ...ai.OptionFunc) ([]Workspace, *ai.Response, error)
  • func (s *Service) StartWorkspace(ws Workspace) (*ai.Response, error)
  • func (s *Service) StopWorkspace(ws Workspace) (*ai.Response, error)
• type Workspace

Types

type AccessURL

type AccessURL struct {
	URL string `json:"url"`
}

type Client

type Client struct {
	*ai.Client
	Workspace *Service
}

A Client manages communication with HSDP AI-Workspace API

func NewClient

func NewClient(iamClient *iam.Client, config *ai.Config) (*Client, error)

NewClient returns a new HSDP AI-Workspace API client. A configured IAM client must be provided as the underlying API requires an IAM token

type LogArtefact

type LogArtefact struct {
	StartupLog []string `json:"startupLog"`
}

type Service

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

func (*Service) CreateWorkspace

func (s *Service) CreateWorkspace(model Workspace) (*Workspace, *ai.Response, error)

func (*Service) DeleteWorkspace

func (s *Service) DeleteWorkspace(ws Workspace) (*ai.Response, error)

func (*Service) GetWorkspaceAccessURL

func (s *Service) GetWorkspaceAccessURL(ws Workspace) (*AccessURL, *ai.Response, error)

func (*Service) GetWorkspaceByID

func (s *Service) GetWorkspaceByID(id string) (*Workspace, *ai.Response, error)

func (*Service) GetWorkspaceLogs

func (s *Service) GetWorkspaceLogs(ws Workspace) (*LogArtefact, *ai.Response, error)

func (*Service) GetWorkspaces

func (s *Service) GetWorkspaces(opt *ai.GetOptions, options ...ai.OptionFunc) ([]Workspace, *ai.Response, error)

func (*Service) StartWorkspace

func (s *Service) StartWorkspace(ws Workspace) (*ai.Response, error)

func (*Service) StopWorkspace

func (s *Service) StopWorkspace(ws Workspace) (*ai.Response, error)

type Workspace

type Workspace struct {
	ID                      string                    `json:"id,omitempty"`
	ResourceType            string                    `json:"resourceType"`
	Name                    string                    `json:"name" validate:"required"`
	Description             string                    `json:"description,omitempty"`
	ComputeTarget           ai.ReferenceComputeTarget `json:"computeTarget" validate:"required"`
	SourceCode              ai.SourceCode             `json:"sourceCode"`
	Labels                  []string                  `json:"labels,omitempty"`
	Type                    string                    `json:"type,omitempty"`
	AdditionalConfiguration string                    `json:"additionalConfiguration,omitempty"`
	Created                 string                    `json:"created,omitempty"`
	CreatedBy               string                    `json:"createdBy,omitempty"`
	LastUpdated             string                    `json:"lastUpdated,omitempty"`
}