v1

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:"-"`
}

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:"-"`
}

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:"-"`
}

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:"-"`
}

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

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:"-"`
}

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"`
	// Initial amount of disk space (in GiB) available to the notebook.
	InitialDiskSize      int32    `protobuf:"varint,8,opt,name=initial_disk_size,json=initialDiskSize,proto3" json:"initial_disk_size,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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:"-"`
}

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)
}

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)
}

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:"-"`
}

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:"-"`
}

type UnimplementedNotebookServiceServer struct {
}