v1

package
v0.88.5 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2024 License: Apache-2.0 Imports: 22 Imported by: 3

Documentation

Overview

Package notebook/v1 contains the API of Jupyter Notebook services.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (

	// EventTypeNotebookCreated is the type of event fired after a Notebook has been created.
	// SubjectID contains the ID of the Notebook.
	EventTypeNotebookCreated = "notebook.notebook.created"
	// EventTypeNotebookUpdated is the type of event fired after a Notebook has been updated.
	// SubjectID contains the ID of the Notebook.
	EventTypeNotebookUpdated = "notebook.notebook.updated"
	// EventTypeNotebookDeleted is the type of event fired after a Notebook has been deleted.
	// SubjectID contains the ID of the Notebook.
	EventTypeNotebookDeleted = "notebook.notebook.deleted"
)
View Source 
const (

	// PermissionGetNotebook is required to get a notebook.
	PermissionGetNotebook = "notebook.notebook.get"
	// PermissionCreateNotebook is required to create a notebook.
	PermissionCreateNotebook = "notebook.notebook.create"
	// PermissionDeleteNotebook is required to delete a notebook.
	PermissionDeleteNotebook = "notebook.notebook.delete"
	// PermissionUpdateNotebook is required to pause a notebook.
	PermissionUpdateNotebook = "notebook.notebook.update"
	// PermissionListNotebooks is required to list notebooks.
	PermissionListNotebooks = "notebook.notebook.list"
	// PermissionPauseNotebook is required to pause a notebook.
	PermissionPauseNotebook = "notebook.notebook.pause"
	// PermissionResumeNotebook is required to resume a notebook.
	PermissionResumeNotebook = "notebook.notebook.resume"
	// PermissionExecuteNotebook is required to execute a notebook.
	PermissionExecuteNotebook = "notebook.notebook.execute"
)
View Source 
const (

	// Notebook is initialising.
	NotebookPhaseInitialising = "Initialising"

	// Notebook is running.
	NotebookPhaseRunning = "Running"

	// Notebook is moving to a hibernated state.
	NotebookPhaseHibernating = "Hibernating"

	// Notebook has moved to a hibernated state.
	NotebookPhaseHibernated = "Hibernated"

	// Notebook is in an errored state. Additional information can be obtained from `message` field.
	NotebookPhaseError = "Error"

	// Notebook has been marked for deletion and will clean-up all related resources.
	NotebookPhaseDeleting = "Deleting"
)
View Source 
const (

	// QuotaKindNotebooksPerDeployment limits the number of notebooks in a single (non-free) deployment.
	// This kind of quota must be requested on a project level.
	QuotaKindNotebooksPerDeployment = "notebook.total-notebook-per-deployment"

	// QuotaKindNotebooksPerFreeDeployment limits the number of notebooks in a single free deployment.
	// This kind of quota must be requested on a project level.
	QuotaKindNotebooksPerFreeDeployment = "notebook.total-notebook-per-free-deployment"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "notebook/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 0
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 4
)
View Source 
const (
	// KindNotebook is a constants for the kind of Notebook resources.
	KindNotebook = "Notebook"
)
View Source 
const (

	// PermissionListNotebookModels is required to list notebook models.
	PermissionListNotebookModels = "notebook.model.list"
)
View Source 
const (

	// UsageItemResourceKindNotebook is the kind used inside the UsageItem.Resource to refer to a notebook.
	UsageItemResourceKindNotebook = "Notebook"
)

Variables

View Source 
var (
	ErrInvalidLengthNotebook        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowNotebook          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupNotebook = fmt.Errorf("proto: unexpected end of group")
)

Functions

func ForEachNotebook 

func ForEachNotebook(ctx context.Context, listFunc func(ctx context.Context, req *ListNotebooksRequest) (*NotebookList, error),
	req ListNotebooksRequest, cb NotebookCallback) error

ForEachNotebook iterates over all notebooks for a specific deployment, invoking the given callback for each of them.

func NotebookURL 

func NotebookURL(deploymentURL, notebookID string) string

NotebookURL creates a resource URL for the Notebook with given ID in given context.

func RegisterNotebookServiceHandler 

func RegisterNotebookServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterNotebookServiceHandler registers the http handlers for service NotebookService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterNotebookServiceHandlerClient 

func RegisterNotebookServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client NotebookServiceClient) error

RegisterNotebookServiceHandlerClient registers the http handlers for service NotebookService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "NotebookServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "NotebookServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "NotebookServiceClient" to call the correct interceptors.

func RegisterNotebookServiceHandlerFromEndpoint 

func RegisterNotebookServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterNotebookServiceHandlerFromEndpoint is same as RegisterNotebookServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterNotebookServiceHandlerServer 

func RegisterNotebookServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server NotebookServiceServer) error

RegisterNotebookServiceHandlerServer registers the http handlers for service NotebookService to "mux". UnaryRPC :call NotebookServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterNotebookServiceServer 

func RegisterNotebookServiceServer(s *grpc.Server, srv NotebookServiceServer)

Types

type ListNotebookModelsRequest 

type ListNotebookModelsRequest struct {
	// ID of the deployment that the notebook belongs to.
	DeploymentId         string   `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Requet for listing notebook models.

func (*ListNotebookModelsRequest) Descriptor 

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

func (*ListNotebookModelsRequest) GetDeploymentId 

func (m *ListNotebookModelsRequest) GetDeploymentId() string

func (*ListNotebookModelsRequest) Marshal 

func (m *ListNotebookModelsRequest) Marshal() (dAtA []byte, err error)

func (*ListNotebookModelsRequest) MarshalTo 

func (m *ListNotebookModelsRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListNotebookModelsRequest) MarshalToSizedBuffer 

func (m *ListNotebookModelsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListNotebookModelsRequest) ProtoMessage 

func (*ListNotebookModelsRequest) ProtoMessage()

func (*ListNotebookModelsRequest) Reset 

func (m *ListNotebookModelsRequest) Reset()

func (*ListNotebookModelsRequest) Size 

func (m *ListNotebookModelsRequest) Size() (n int)

func (*ListNotebookModelsRequest) String 

func (m *ListNotebookModelsRequest) String() string

func (*ListNotebookModelsRequest) Unmarshal 

func (m *ListNotebookModelsRequest) Unmarshal(dAtA []byte) error

func (*ListNotebookModelsRequest) XXX_DiscardUnknown 

func (m *ListNotebookModelsRequest) XXX_DiscardUnknown()

func (*ListNotebookModelsRequest) XXX_Marshal 

func (m *ListNotebookModelsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListNotebookModelsRequest) XXX_Merge 

func (m *ListNotebookModelsRequest) XXX_Merge(src proto.Message)

func (*ListNotebookModelsRequest) XXX_Size 

func (m *ListNotebookModelsRequest) XXX_Size() int

func (*ListNotebookModelsRequest) XXX_Unmarshal 

func (m *ListNotebookModelsRequest) XXX_Unmarshal(b []byte) error

type ListNotebooksRequest 

type ListNotebooksRequest struct {
	// List notebooks for this deployment ID.
	// This is a required field.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Optional common list options, the context_id is ignored
	Options              *v1.ListOptions `protobuf:"bytes,10,opt,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Request for listing notebooks.

func (*ListNotebooksRequest) Descriptor 

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

func (*ListNotebooksRequest) GetDeploymentId 

func (m *ListNotebooksRequest) GetDeploymentId() string

func (*ListNotebooksRequest) GetOptions 

func (m *ListNotebooksRequest) GetOptions() *v1.ListOptions

func (*ListNotebooksRequest) Marshal 

func (m *ListNotebooksRequest) Marshal() (dAtA []byte, err error)

func (*ListNotebooksRequest) MarshalTo 

func (m *ListNotebooksRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListNotebooksRequest) MarshalToSizedBuffer 

func (m *ListNotebooksRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListNotebooksRequest) ProtoMessage 

func (*ListNotebooksRequest) ProtoMessage()

func (*ListNotebooksRequest) Reset 

func (m *ListNotebooksRequest) Reset()

func (*ListNotebooksRequest) Size 

func (m *ListNotebooksRequest) Size() (n int)

func (*ListNotebooksRequest) String 

func (m *ListNotebooksRequest) String() string

func (*ListNotebooksRequest) Unmarshal 

func (m *ListNotebooksRequest) Unmarshal(dAtA []byte) error

func (*ListNotebooksRequest) XXX_DiscardUnknown 

func (m *ListNotebooksRequest) XXX_DiscardUnknown()

func (*ListNotebooksRequest) XXX_Marshal 

func (m *ListNotebooksRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListNotebooksRequest) XXX_Merge 

func (m *ListNotebooksRequest) XXX_Merge(src proto.Message)

func (*ListNotebooksRequest) XXX_Size 

func (m *ListNotebooksRequest) XXX_Size() int

func (*ListNotebooksRequest) XXX_Unmarshal 

func (m *ListNotebooksRequest) XXX_Unmarshal(b []byte) error

type ModelSpec 

type ModelSpec struct {
	// Type of model being used.
	// This should refer to the `id` of a `NotebookModel` object.
	// This is a required field.
	NotebookModelId string `protobuf:"bytes,1,opt,name=notebook_model_id,json=notebookModelId,proto3" json:"notebook_model_id,omitempty"`
	// Disk size allocated to the notebook instance (in GiB).
	// This is a required field.
	DiskSize             int32    `protobuf:"varint,2,opt,name=disk_size,json=diskSize,proto3" json:"disk_size,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Model specification for the notebook.

func (*ModelSpec) Descriptor 

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

func (*ModelSpec) GetDiskSize 

func (m *ModelSpec) GetDiskSize() int32

func (*ModelSpec) GetNotebookModelId 

func (m *ModelSpec) GetNotebookModelId() string

func (*ModelSpec) Marshal 

func (m *ModelSpec) Marshal() (dAtA []byte, err error)

func (*ModelSpec) MarshalTo 

func (m *ModelSpec) MarshalTo(dAtA []byte) (int, error)

func (*ModelSpec) MarshalToSizedBuffer 

func (m *ModelSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ModelSpec) ProtoMessage 

func (*ModelSpec) ProtoMessage()

func (*ModelSpec) Reset 

func (m *ModelSpec) Reset()

func (*ModelSpec) Size 

func (m *ModelSpec) Size() (n int)

func (*ModelSpec) String 

func (m *ModelSpec) String() string

func (*ModelSpec) Unmarshal 

func (m *ModelSpec) Unmarshal(dAtA []byte) error

func (*ModelSpec) XXX_DiscardUnknown 

func (m *ModelSpec) XXX_DiscardUnknown()

func (*ModelSpec) XXX_Marshal 

func (m *ModelSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ModelSpec) XXX_Merge 

func (m *ModelSpec) XXX_Merge(src proto.Message)

func (*ModelSpec) XXX_Size 

func (m *ModelSpec) XXX_Size() int

func (*ModelSpec) XXX_Unmarshal 

func (m *ModelSpec) XXX_Unmarshal(b []byte) error

type Notebook 

type Notebook struct {
	// ID of the Notebook.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the Deployment this notebook belongs to.
	// After creation, this value cannot be changed.
	// This is a required field.
	DeploymentId string `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// URL of the Notebook.
	// This is a read-only value.
	Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	// Name of the notebook.
	// This is a required field.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the notebook.
	// This is an optional field.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// Indicates that this notebook is paused.
	// Use the notebook.PauseNotebook method to pause, and notebook.ResumeNotebook to resume (unpause).
	// This is a read-only value.
	IsPaused bool `protobuf:"varint,6,opt,name=is_paused,json=isPaused,proto3" json:"is_paused,omitempty"`
	// The last paused timestamp of the notebook.
	// This is the timestamp that is_paused is transitioned from unset to set.
	// This is a read-only value.
	LastPausedAt *types.Timestamp `protobuf:"bytes,7,opt,name=last_paused_at,json=lastPausedAt,proto3" json:"last_paused_at,omitempty"`
	// The last resumed timestamp of the notebook.
	// This is the timestamp that is_paused is transitioned from set to unset.
	// This is a read-only value.
	LastResumedAt *types.Timestamp `protobuf:"bytes,8,opt,name=last_resumed_at,json=lastResumedAt,proto3" json:"last_resumed_at,omitempty"`
	// Identifier of the user that created this notebook.
	// This is a read-only value.
	CreatedById string `protobuf:"bytes,9,opt,name=created_by_id,json=createdById,proto3" json:"created_by_id,omitempty"`
	// Time at which this notebook was created.
	// This is a read-only value.
	CreatedAt *types.Timestamp `protobuf:"bytes,10,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Model specification for the notebook.
	Model *ModelSpec `protobuf:"bytes,11,opt,name=model,proto3" json:"model,omitempty"`
	// Set when this notebook is deleted.
	// This is a read-only value.
	IsDeleted bool `protobuf:"varint,12,opt,name=is_deleted,json=isDeleted,proto3" json:"is_deleted,omitempty"`
	// The deletion timestamp of the deployment
	// This is a read-only value.
	DeletedAt *types.Timestamp `protobuf:"bytes,13,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// If set, the Notebook is created for use along with ArangoML.
	// This field will be set to `true` if ML services are enabled at the time of creating the notebook.
	// This is a read-only value.
	MlEnabled bool `protobuf:"varint,14,opt,name=ml_enabled,json=mlEnabled,proto3" json:"ml_enabled,omitempty"`
	// Status of the notebook.
	// This is a read-only value.
	Status               *Status  `protobuf:"bytes,100,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Contains the specification and status of a given notebook instance.

func (*Notebook) Descriptor 

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

func (*Notebook) GetCreatedAt 

func (m *Notebook) GetCreatedAt() *types.Timestamp

func (*Notebook) GetCreatedById 

func (m *Notebook) GetCreatedById() string

func (*Notebook) GetDeletedAt 

func (m *Notebook) GetDeletedAt() *types.Timestamp

func (*Notebook) GetDeploymentId 

func (m *Notebook) GetDeploymentId() string

func (*Notebook) GetDescription 

func (m *Notebook) GetDescription() string

func (*Notebook) GetId 

func (m *Notebook) GetId() string

func (*Notebook) GetIsDeleted 

func (m *Notebook) GetIsDeleted() bool

func (*Notebook) GetIsPaused 

func (m *Notebook) GetIsPaused() bool

func (*Notebook) GetLastPausedAt 

func (m *Notebook) GetLastPausedAt() *types.Timestamp

func (*Notebook) GetLastResumedAt 

func (m *Notebook) GetLastResumedAt() *types.Timestamp

func (*Notebook) GetMlEnabled added in v0.79.13 

func (m *Notebook) GetMlEnabled() bool

func (*Notebook) GetModel 

func (m *Notebook) GetModel() *ModelSpec

func (*Notebook) GetName 

func (m *Notebook) GetName() string

func (*Notebook) GetStatus 

func (m *Notebook) GetStatus() *Status

func (*Notebook) GetUrl 

func (m *Notebook) GetUrl() string

func (*Notebook) Marshal 

func (m *Notebook) Marshal() (dAtA []byte, err error)

func (*Notebook) MarshalTo 

func (m *Notebook) MarshalTo(dAtA []byte) (int, error)

func (*Notebook) MarshalToSizedBuffer 

func (m *Notebook) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Notebook) ProtoMessage 

func (*Notebook) ProtoMessage()

func (*Notebook) Reset 

func (m *Notebook) Reset()

func (*Notebook) Size 

func (m *Notebook) Size() (n int)

func (*Notebook) String 

func (m *Notebook) String() string

func (*Notebook) Unmarshal 

func (m *Notebook) Unmarshal(dAtA []byte) error

func (*Notebook) XXX_DiscardUnknown 

func (m *Notebook) XXX_DiscardUnknown()

func (*Notebook) XXX_Marshal 

func (m *Notebook) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Notebook) XXX_Merge 

func (m *Notebook) XXX_Merge(src proto.Message)

func (*Notebook) XXX_Size 

func (m *Notebook) XXX_Size() int

func (*Notebook) XXX_Unmarshal 

func (m *Notebook) XXX_Unmarshal(b []byte) error

type NotebookCallback 

type NotebookCallback func(context.Context, *Notebook) error

NotebookCallback is a callback for individual notebooks.

type NotebookList 

type NotebookList struct {
	Items []*Notebook `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// Budget for notebooks
	Budget               *v1.Budget `protobuf:"bytes,2,opt,name=budget,proto3" json:"budget,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

List of Notebooks.

func (*NotebookList) Descriptor 

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

func (*NotebookList) GetBudget 

func (m *NotebookList) GetBudget() *v1.Budget

func (*NotebookList) GetItems 

func (m *NotebookList) GetItems() []*Notebook

func (*NotebookList) Marshal 

func (m *NotebookList) Marshal() (dAtA []byte, err error)

func (*NotebookList) MarshalTo 

func (m *NotebookList) MarshalTo(dAtA []byte) (int, error)

func (*NotebookList) MarshalToSizedBuffer 

func (m *NotebookList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NotebookList) ProtoMessage 

func (*NotebookList) ProtoMessage()

func (*NotebookList) Reset 

func (m *NotebookList) Reset()

func (*NotebookList) Size 

func (m *NotebookList) Size() (n int)

func (*NotebookList) String 

func (m *NotebookList) String() string

func (*NotebookList) Unmarshal 

func (m *NotebookList) Unmarshal(dAtA []byte) error

func (*NotebookList) XXX_DiscardUnknown 

func (m *NotebookList) XXX_DiscardUnknown()

func (*NotebookList) XXX_Marshal 

func (m *NotebookList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NotebookList) XXX_Merge 

func (m *NotebookList) XXX_Merge(src proto.Message)

func (*NotebookList) XXX_Size 

func (m *NotebookList) XXX_Size() int

func (*NotebookList) XXX_Unmarshal 

func (m *NotebookList) XXX_Unmarshal(b []byte) error

type NotebookModel 

type NotebookModel struct {
	// System identifier of the model.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Human readable name of the model.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// CPU units allocated to the notebook.
	// 1 CPU unit equals 1 physical / virtual CPU.
	Cpu float32 `protobuf:"fixed32,3,opt,name=cpu,proto3" json:"cpu,omitempty"`
	// Memory allocated to the notebook in 'GiB'.
	Memory int32 `protobuf:"varint,4,opt,name=memory,proto3" json:"memory,omitempty"`
	// Maximum amount of disk space (in GiB) available to the notebook.
	MaxDiskSize int32 `protobuf:"varint,5,opt,name=max_disk_size,json=maxDiskSize,proto3" json:"max_disk_size,omitempty"`
	// Minimum amount of disk space (in GiB) available to the notebook.
	MinDiskSize int32 `protobuf:"varint,6,opt,name=min_disk_size,json=minDiskSize,proto3" json:"min_disk_size,omitempty"`
	// GPU units allocated to the notebook.
	// 1 GPU unit equals 1 physical / virtual GPU.
	Gpu                  float32  `protobuf:"fixed32,7,opt,name=gpu,proto3" json:"gpu,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Specifies the resource configuration for a notebook.

func (*NotebookModel) Descriptor 

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

func (*NotebookModel) GetCpu 

func (m *NotebookModel) GetCpu() float32

func (*NotebookModel) GetGpu added in v0.79.17 

func (m *NotebookModel) GetGpu() float32

func (*NotebookModel) GetId 

func (m *NotebookModel) GetId() string

func (*NotebookModel) GetMaxDiskSize 

func (m *NotebookModel) GetMaxDiskSize() int32

func (*NotebookModel) GetMemory 

func (m *NotebookModel) GetMemory() int32

func (*NotebookModel) GetMinDiskSize 

func (m *NotebookModel) GetMinDiskSize() int32

func (*NotebookModel) GetName 

func (m *NotebookModel) GetName() string

func (*NotebookModel) Marshal 

func (m *NotebookModel) Marshal() (dAtA []byte, err error)

func (*NotebookModel) MarshalTo 

func (m *NotebookModel) MarshalTo(dAtA []byte) (int, error)

func (*NotebookModel) MarshalToSizedBuffer 

func (m *NotebookModel) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NotebookModel) ProtoMessage 

func (*NotebookModel) ProtoMessage()

func (*NotebookModel) Reset 

func (m *NotebookModel) Reset()

func (*NotebookModel) Size 

func (m *NotebookModel) Size() (n int)

func (*NotebookModel) String 

func (m *NotebookModel) String() string

func (*NotebookModel) Unmarshal 

func (m *NotebookModel) Unmarshal(dAtA []byte) error

func (*NotebookModel) XXX_DiscardUnknown 

func (m *NotebookModel) XXX_DiscardUnknown()

func (*NotebookModel) XXX_Marshal 

func (m *NotebookModel) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NotebookModel) XXX_Merge 

func (m *NotebookModel) XXX_Merge(src proto.Message)

func (*NotebookModel) XXX_Size 

func (m *NotebookModel) XXX_Size() int

func (*NotebookModel) XXX_Unmarshal 

func (m *NotebookModel) XXX_Unmarshal(b []byte) error

type NotebookModelList 

type NotebookModelList struct {
	Items                []*NotebookModel `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

List of notebook models.

func (*NotebookModelList) Descriptor 

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

func (*NotebookModelList) GetItems 

func (m *NotebookModelList) GetItems() []*NotebookModel

func (*NotebookModelList) Marshal 

func (m *NotebookModelList) Marshal() (dAtA []byte, err error)

func (*NotebookModelList) MarshalTo 

func (m *NotebookModelList) MarshalTo(dAtA []byte) (int, error)

func (*NotebookModelList) MarshalToSizedBuffer 

func (m *NotebookModelList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NotebookModelList) ProtoMessage 

func (*NotebookModelList) ProtoMessage()

func (*NotebookModelList) Reset 

func (m *NotebookModelList) Reset()

func (*NotebookModelList) Size 

func (m *NotebookModelList) Size() (n int)

func (*NotebookModelList) String 

func (m *NotebookModelList) String() string

func (*NotebookModelList) Unmarshal 

func (m *NotebookModelList) Unmarshal(dAtA []byte) error

func (*NotebookModelList) XXX_DiscardUnknown 

func (m *NotebookModelList) XXX_DiscardUnknown()

func (*NotebookModelList) XXX_Marshal 

func (m *NotebookModelList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NotebookModelList) XXX_Merge 

func (m *NotebookModelList) XXX_Merge(src proto.Message)

func (*NotebookModelList) XXX_Size 

func (m *NotebookModelList) XXX_Size() int

func (*NotebookModelList) XXX_Unmarshal 

func (m *NotebookModelList) XXX_Unmarshal(b []byte) error

type NotebookServiceClient 

type NotebookServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None (authenticated only)
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Get a Notebook using its ID.
	// Required permissions:
	// - notebook.notebook.get on the notebook
	GetNotebook(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*Notebook, error)
	// Create a new Notebook by specifying its configuration.
	// Required permissions:
	// - notebook.notebook.create on the deployment
	CreateNotebook(ctx context.Context, in *Notebook, opts ...grpc.CallOption) (*Notebook, error)
	// Delete an existing notebook using its ID.
	// This initially marks the notebook for deletion. It is deleted from CP once all its child resources are deleted.
	// Required permissions:
	// - notebook.notebook.delete on the notebook
	DeleteNotebook(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Update an existing notebook. Returns updated Notebook.
	// Required permissions:
	// - notebook.notebook.update on the notebook
	UpdateNotebook(ctx context.Context, in *Notebook, opts ...grpc.CallOption) (*v1.Empty, error)
	// List all notebooks for the deployments identified by the given deployment identifier.
	// Required permissions:
	// - notebook.notebook.list on the deployment
	ListNotebooks(ctx context.Context, in *ListNotebooksRequest, opts ...grpc.CallOption) (*NotebookList, error)
	// List all notebook models available in the context of the given deployment.
	// Required permissions:
	// - notebook.model.list globally
	ListNotebookModels(ctx context.Context, in *ListNotebookModelsRequest, opts ...grpc.CallOption) (*NotebookModelList, error)
	// Pauses a running notebook identified by the given id.
	// Required permissions:
	// - notebook.notebook.pause on the notebook
	PauseNotebook(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Resumes a paused notebook identified by the given id.
	// When ResumeNotebook is invoked on a notebook that has is_paused not set, an PreconditionFailed error is returned.
	// Required permissions:
	// - notebook.notebook.resume on the notebook
	ResumeNotebook(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
}

NotebookServiceClient is the client API for NotebookService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewNotebookServiceClient 

func NewNotebookServiceClient(cc *grpc.ClientConn) NotebookServiceClient

type NotebookServiceServer 

type NotebookServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None (authenticated only)
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Get a Notebook using its ID.
	// Required permissions:
	// - notebook.notebook.get on the notebook
	GetNotebook(context.Context, *v1.IDOptions) (*Notebook, error)
	// Create a new Notebook by specifying its configuration.
	// Required permissions:
	// - notebook.notebook.create on the deployment
	CreateNotebook(context.Context, *Notebook) (*Notebook, error)
	// Delete an existing notebook using its ID.
	// This initially marks the notebook for deletion. It is deleted from CP once all its child resources are deleted.
	// Required permissions:
	// - notebook.notebook.delete on the notebook
	DeleteNotebook(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Update an existing notebook. Returns updated Notebook.
	// Required permissions:
	// - notebook.notebook.update on the notebook
	UpdateNotebook(context.Context, *Notebook) (*v1.Empty, error)
	// List all notebooks for the deployments identified by the given deployment identifier.
	// Required permissions:
	// - notebook.notebook.list on the deployment
	ListNotebooks(context.Context, *ListNotebooksRequest) (*NotebookList, error)
	// List all notebook models available in the context of the given deployment.
	// Required permissions:
	// - notebook.model.list globally
	ListNotebookModels(context.Context, *ListNotebookModelsRequest) (*NotebookModelList, error)
	// Pauses a running notebook identified by the given id.
	// Required permissions:
	// - notebook.notebook.pause on the notebook
	PauseNotebook(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Resumes a paused notebook identified by the given id.
	// When ResumeNotebook is invoked on a notebook that has is_paused not set, an PreconditionFailed error is returned.
	// Required permissions:
	// - notebook.notebook.resume on the notebook
	ResumeNotebook(context.Context, *v1.IDOptions) (*v1.Empty, error)
}

NotebookServiceServer is the server API for NotebookService service.

type Status 

type Status struct {
	// Where the notebook is in its lifecycle at any given time.
	// Should contain only one of the following values:
	// "Initialising"   - Notebook is initialising.
	// "Running"        - Notebook is running.
	// "Hibernating"    - Notebook is moving to a hibernated state.
	// "Hibernated"     - Notebook has moved to a hibernated state.
	// "Error"          - Notebook is in an errored state. Additional information can be obtained from `message` field.
	Phase string `protobuf:"bytes,1,opt,name=phase,proto3" json:"phase,omitempty"`
	// Supporting information about the notebook phase - such as error messages in case of failures.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// The timestamp of when the status of the notebook was last updated.
	LastUpdatedAt *types.Timestamp `protobuf:"bytes,3,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`
	// Endpoint URL used to reach the notebook
	// This value will be empty during the creation of the notebook.
	Endpoint string `protobuf:"bytes,4,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Endpoint URL used to reach the notebook on default port 443
	// This value will be empty during the creation of the notebook.
	// This endpoint is recommended for human-to-notebook connections.
	EndpointDefault string `protobuf:"bytes,5,opt,name=endpoint_default,json=endpointDefault,proto3" json:"endpoint_default,omitempty"`
	// Endpoint URL used to reach the notebook with self signed certificate on port 18829
	// This value will be empty during the creation of the notebook.
	EndpointSelfSigned string `protobuf:"bytes,6,opt,name=endpoint_self_signed,json=endpointSelfSigned,proto3" json:"endpoint_self_signed,omitempty"`
	// The timestamp of when this notebook was last reported to be active.
	LastActiveAt *types.Timestamp `protobuf:"bytes,7,opt,name=last_active_at,json=lastActiveAt,proto3" json:"last_active_at,omitempty"`
	// Resource usage of the notebook.
	Usage                *Status_Usage `protobuf:"bytes,10,opt,name=usage,proto3" json:"usage,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

Status of the notebook. Note: all fields in this block are read-only.

func (*Status) Descriptor 

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

func (*Status) Equals added in v0.76.6 

func (source *Status) Equals(other *Status) bool

Equals returns true when source and other have the same values.

func (*Status) GetEndpoint 

func (m *Status) GetEndpoint() string

func (*Status) GetEndpointDefault added in v0.81.2 

func (m *Status) GetEndpointDefault() string

func (*Status) GetEndpointSelfSigned added in v0.81.2 

func (m *Status) GetEndpointSelfSigned() string

func (*Status) GetLastActiveAt added in v0.79.14 

func (m *Status) GetLastActiveAt() *types.Timestamp

func (*Status) GetLastUpdatedAt 

func (m *Status) GetLastUpdatedAt() *types.Timestamp

func (*Status) GetMessage 

func (m *Status) GetMessage() string

func (*Status) GetPhase 

func (m *Status) GetPhase() string

func (*Status) GetUsage 

func (m *Status) GetUsage() *Status_Usage

func (*Status) Marshal 

func (m *Status) Marshal() (dAtA []byte, err error)

func (*Status) MarshalTo 

func (m *Status) MarshalTo(dAtA []byte) (int, error)

func (*Status) MarshalToSizedBuffer 

func (m *Status) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) Reset 

func (m *Status) Reset()

func (*Status) Size 

func (m *Status) Size() (n int)

func (*Status) String 

func (m *Status) String() string

func (*Status) Unmarshal 

func (m *Status) Unmarshal(dAtA []byte) error

func (*Status) XXX_DiscardUnknown 

func (m *Status) XXX_DiscardUnknown()

func (*Status) XXX_Marshal 

func (m *Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Status) XXX_Merge 

func (m *Status) XXX_Merge(src proto.Message)

func (*Status) XXX_Size 

func (m *Status) XXX_Size() int

func (*Status) XXX_Unmarshal 

func (m *Status) XXX_Unmarshal(b []byte) error

type Status_Usage 

type Status_Usage struct {
	// Information about the data volume used to store the data
	DataVolumeInfo *v11.DataVolumeInfo `protobuf:"bytes,1,opt,name=data_volume_info,json=dataVolumeInfo,proto3" json:"data_volume_info,omitempty"`
	// Last known memory usage in bytes
	LastMemoryUsage int64 `protobuf:"varint,2,opt,name=last_memory_usage,json=lastMemoryUsage,proto3" json:"last_memory_usage,omitempty"`
	// Last known CPU usage in vCPU units
	LastCpuUsage float32 `protobuf:"fixed32,3,opt,name=last_cpu_usage,json=lastCpuUsage,proto3" json:"last_cpu_usage,omitempty"`
	// Last known memory limit in bytes
	LastMemoryLimit int64 `protobuf:"varint,4,opt,name=last_memory_limit,json=lastMemoryLimit,proto3" json:"last_memory_limit,omitempty"`
	// Last known CPU limit in vCPU units
	LastCpuLimit float32 `protobuf:"fixed32,5,opt,name=last_cpu_limit,json=lastCpuLimit,proto3" json:"last_cpu_limit,omitempty"`
	// Last known GPU usage in GPU units
	LastGpuUsage float32 `protobuf:"fixed32,6,opt,name=last_gpu_usage,json=lastGpuUsage,proto3" json:"last_gpu_usage,omitempty"`
	// Last known GPU limit in GPU units
	LastGpuLimit         float32  `protobuf:"fixed32,7,opt,name=last_gpu_limit,json=lastGpuLimit,proto3" json:"last_gpu_limit,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Resource usage of the notebook.

func (*Status_Usage) Descriptor 

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

func (*Status_Usage) GetDataVolumeInfo 

func (m *Status_Usage) GetDataVolumeInfo() *v11.DataVolumeInfo

func (*Status_Usage) GetLastCpuLimit 

func (m *Status_Usage) GetLastCpuLimit() float32

func (*Status_Usage) GetLastCpuUsage 

func (m *Status_Usage) GetLastCpuUsage() float32

func (*Status_Usage) GetLastGpuLimit added in v0.79.17 

func (m *Status_Usage) GetLastGpuLimit() float32

func (*Status_Usage) GetLastGpuUsage added in v0.79.17 

func (m *Status_Usage) GetLastGpuUsage() float32

func (*Status_Usage) GetLastMemoryLimit 

func (m *Status_Usage) GetLastMemoryLimit() int64

func (*Status_Usage) GetLastMemoryUsage 

func (m *Status_Usage) GetLastMemoryUsage() int64

func (*Status_Usage) Marshal 

func (m *Status_Usage) Marshal() (dAtA []byte, err error)

func (*Status_Usage) MarshalTo 

func (m *Status_Usage) MarshalTo(dAtA []byte) (int, error)

func (*Status_Usage) MarshalToSizedBuffer 

func (m *Status_Usage) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Status_Usage) ProtoMessage 

func (*Status_Usage) ProtoMessage()

func (*Status_Usage) Reset 

func (m *Status_Usage) Reset()

func (*Status_Usage) Size 

func (m *Status_Usage) Size() (n int)

func (*Status_Usage) String 

func (m *Status_Usage) String() string

func (*Status_Usage) Unmarshal 

func (m *Status_Usage) Unmarshal(dAtA []byte) error

func (*Status_Usage) XXX_DiscardUnknown 

func (m *Status_Usage) XXX_DiscardUnknown()

func (*Status_Usage) XXX_Marshal 

func (m *Status_Usage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Status_Usage) XXX_Merge 

func (m *Status_Usage) XXX_Merge(src proto.Message)

func (*Status_Usage) XXX_Size 

func (m *Status_Usage) XXX_Size() int

func (*Status_Usage) XXX_Unmarshal 

func (m *Status_Usage) XXX_Unmarshal(b []byte) error

type UnimplementedNotebookServiceServer 

type UnimplementedNotebookServiceServer struct {
}

UnimplementedNotebookServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNotebookServiceServer) CreateNotebook 

func (*UnimplementedNotebookServiceServer) CreateNotebook(ctx context.Context, req *Notebook) (*Notebook, error)

func (*UnimplementedNotebookServiceServer) DeleteNotebook 

func (*UnimplementedNotebookServiceServer) DeleteNotebook(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedNotebookServiceServer) GetAPIVersion 

func (*UnimplementedNotebookServiceServer) GetAPIVersion(ctx context.Context, req *v1.Empty) (*v1.Version, error)

func (*UnimplementedNotebookServiceServer) GetNotebook 

func (*UnimplementedNotebookServiceServer) GetNotebook(ctx context.Context, req *v1.IDOptions) (*Notebook, error)

func (*UnimplementedNotebookServiceServer) ListNotebookModels 

func (*UnimplementedNotebookServiceServer) ListNotebookModels(ctx context.Context, req *ListNotebookModelsRequest) (*NotebookModelList, error)

func (*UnimplementedNotebookServiceServer) ListNotebooks 

func (*UnimplementedNotebookServiceServer) ListNotebooks(ctx context.Context, req *ListNotebooksRequest) (*NotebookList, error)

func (*UnimplementedNotebookServiceServer) PauseNotebook 

func (*UnimplementedNotebookServiceServer) PauseNotebook(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedNotebookServiceServer) ResumeNotebook 

func (*UnimplementedNotebookServiceServer) ResumeNotebook(ctx context.Context, req *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedNotebookServiceServer) UpdateNotebook 

func (*UnimplementedNotebookServiceServer) UpdateNotebook(ctx context.Context, req *Notebook) (*v1.Empty, error)

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.