Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Instance_AcceleratorType_name = map[int32]string{
		0:  "ACCELERATOR_TYPE_UNSPECIFIED",
		1:  "NVIDIA_TESLA_K80",
		2:  "NVIDIA_TESLA_P100",
		3:  "NVIDIA_TESLA_V100",
		4:  "NVIDIA_TESLA_P4",
		5:  "NVIDIA_TESLA_T4",
		8:  "NVIDIA_TESLA_T4_VWS",
		9:  "NVIDIA_TESLA_P100_VWS",
		10: "NVIDIA_TESLA_P4_VWS",
		6:  "TPU_V2",
		7:  "TPU_V3",
	}
	Instance_AcceleratorType_value = map[string]int32{
		"ACCELERATOR_TYPE_UNSPECIFIED": 0,
		"NVIDIA_TESLA_K80":             1,
		"NVIDIA_TESLA_P100":            2,
		"NVIDIA_TESLA_V100":            3,
		"NVIDIA_TESLA_P4":              4,
		"NVIDIA_TESLA_T4":              5,
		"NVIDIA_TESLA_T4_VWS":          8,
		"NVIDIA_TESLA_P100_VWS":        9,
		"NVIDIA_TESLA_P4_VWS":          10,
		"TPU_V2":                       6,
		"TPU_V3":                       7,
	}
)

Enum value maps for Instance_AcceleratorType.

View Source
var (
	Instance_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STARTING",
		2: "PROVISIONING",
		3: "ACTIVE",
		4: "STOPPING",
		5: "STOPPED",
		6: "DELETED",
		7: "UPGRADING",
		8: "INITIALIZING",
		9: "REGISTERING",
	}
	Instance_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STARTING":          1,
		"PROVISIONING":      2,
		"ACTIVE":            3,
		"STOPPING":          4,
		"STOPPED":           5,
		"DELETED":           6,
		"UPGRADING":         7,
		"INITIALIZING":      8,
		"REGISTERING":       9,
	}
)

Enum value maps for Instance_State.

View Source
var (
	Instance_DiskType_name = map[int32]string{
		0: "DISK_TYPE_UNSPECIFIED",
		1: "PD_STANDARD",
		2: "PD_SSD",
		3: "PD_BALANCED",
	}
	Instance_DiskType_value = map[string]int32{
		"DISK_TYPE_UNSPECIFIED": 0,
		"PD_STANDARD":           1,
		"PD_SSD":                2,
		"PD_BALANCED":           3,
	}
)

Enum value maps for Instance_DiskType.

View Source
var (
	Instance_DiskEncryption_name = map[int32]string{
		0: "DISK_ENCRYPTION_UNSPECIFIED",
		1: "GMEK",
		2: "CMEK",
	}
	Instance_DiskEncryption_value = map[string]int32{
		"DISK_ENCRYPTION_UNSPECIFIED": 0,
		"GMEK":                        1,
		"CMEK":                        2,
	}
)

Enum value maps for Instance_DiskEncryption.

View Source
var File_google_cloud_notebooks_v1beta1_environment_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_notebooks_v1beta1_instance_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_notebooks_v1beta1_service_proto protoreflect.FileDescriptor

Functions

func RegisterNotebookServiceServer

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

Types

type ContainerImage

type ContainerImage struct {

	// Required. The path to the container image repository. For example:
	// `gcr.io/{project_id}/{image_name}`
	Repository string `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
	// The tag of the container image. If not specified, this defaults
	// to the latest tag.
	Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

Definition of a container image for starting a notebook instance with the environment installed in a container.

func (*ContainerImage) Descriptor

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

Deprecated: Use ContainerImage.ProtoReflect.Descriptor instead.

func (*ContainerImage) GetRepository

func (x *ContainerImage) GetRepository() string

func (*ContainerImage) GetTag

func (x *ContainerImage) GetTag() string

func (*ContainerImage) ProtoMessage

func (*ContainerImage) ProtoMessage()

func (*ContainerImage) ProtoReflect

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

func (*ContainerImage) Reset

func (x *ContainerImage) Reset()

func (*ContainerImage) String

func (x *ContainerImage) String() string

type CreateEnvironmentRequest

type CreateEnvironmentRequest struct {

	// Required. Format: `projects/{project_id}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User-defined unique ID of this environment. The `environment_id` must
	// be 1 to 63 characters long and contain only lowercase letters,
	// numeric characters, and dashes. The first character must be a lowercase
	// letter and the last character cannot be a dash.
	EnvironmentId string `protobuf:"bytes,2,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// Required. The environment to be created.
	Environment *Environment `protobuf:"bytes,3,opt,name=environment,proto3" json:"environment,omitempty"`
	// contains filtered or unexported fields
}

Request for creating a notebook environment.

func (*CreateEnvironmentRequest) Descriptor

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

Deprecated: Use CreateEnvironmentRequest.ProtoReflect.Descriptor instead.

func (*CreateEnvironmentRequest) GetEnvironment

func (x *CreateEnvironmentRequest) GetEnvironment() *Environment

func (*CreateEnvironmentRequest) GetEnvironmentId

func (x *CreateEnvironmentRequest) GetEnvironmentId() string

func (*CreateEnvironmentRequest) GetParent

func (x *CreateEnvironmentRequest) GetParent() string

func (*CreateEnvironmentRequest) ProtoMessage

func (*CreateEnvironmentRequest) ProtoMessage()

func (*CreateEnvironmentRequest) ProtoReflect

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

func (*CreateEnvironmentRequest) Reset

func (x *CreateEnvironmentRequest) Reset()

func (*CreateEnvironmentRequest) String

func (x *CreateEnvironmentRequest) String() string

type CreateInstanceRequest

type CreateInstanceRequest struct {

	// Required. Format:
	// `parent=projects/{project_id}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User-defined unique ID of this instance.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The instance to be created.
	Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// contains filtered or unexported fields
}

Request for creating a notebook instance.

func (*CreateInstanceRequest) Descriptor

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

Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateInstanceRequest) GetInstance

func (x *CreateInstanceRequest) GetInstance() *Instance

func (*CreateInstanceRequest) GetInstanceId

func (x *CreateInstanceRequest) GetInstanceId() string

func (*CreateInstanceRequest) GetParent

func (x *CreateInstanceRequest) GetParent() string

func (*CreateInstanceRequest) ProtoMessage

func (*CreateInstanceRequest) ProtoMessage()

func (*CreateInstanceRequest) ProtoReflect

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

func (*CreateInstanceRequest) Reset

func (x *CreateInstanceRequest) Reset()

func (*CreateInstanceRequest) String

func (x *CreateInstanceRequest) String() string

type DeleteEnvironmentRequest

type DeleteEnvironmentRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/environments/{environment_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for deleting a notebook environment.

func (*DeleteEnvironmentRequest) Descriptor

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

Deprecated: Use DeleteEnvironmentRequest.ProtoReflect.Descriptor instead.

func (*DeleteEnvironmentRequest) GetName

func (x *DeleteEnvironmentRequest) GetName() string

func (*DeleteEnvironmentRequest) ProtoMessage

func (*DeleteEnvironmentRequest) ProtoMessage()

func (*DeleteEnvironmentRequest) ProtoReflect

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

func (*DeleteEnvironmentRequest) Reset

func (x *DeleteEnvironmentRequest) Reset()

func (*DeleteEnvironmentRequest) String

func (x *DeleteEnvironmentRequest) String() string

type DeleteInstanceRequest

type DeleteInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for deleting a notebook instance.

func (*DeleteInstanceRequest) Descriptor

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

Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.

func (*DeleteInstanceRequest) GetName

func (x *DeleteInstanceRequest) GetName() string

func (*DeleteInstanceRequest) ProtoMessage

func (*DeleteInstanceRequest) ProtoMessage()

func (*DeleteInstanceRequest) ProtoReflect

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

func (*DeleteInstanceRequest) Reset

func (x *DeleteInstanceRequest) Reset()

func (*DeleteInstanceRequest) String

func (x *DeleteInstanceRequest) String() string

type Environment

type Environment struct {

	// Output only. Name of this environment.
	// Format:
	// `projects/{project_id}/locations/{location}/environments/{environment_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Display name of this environment for the UI.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A brief description of this environment.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Type of the environment; can be one of VM image, or container image.
	//
	// Types that are assignable to ImageType:
	//	*Environment_VmImage
	//	*Environment_ContainerImage
	ImageType isEnvironment_ImageType `protobuf_oneof:"image_type"`
	// Path to a Bash script that automatically runs after a notebook instance
	// fully boots up. The path must be a URL or
	// Cloud Storage path. Example: `"gs://path-to-file/file-name"`
	PostStartupScript string `protobuf:"bytes,8,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
	// Output only. The time at which this environment was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Definition of a software environment that is used to start a notebook instance.

func (*Environment) Descriptor

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

Deprecated: Use Environment.ProtoReflect.Descriptor instead.

func (*Environment) GetContainerImage

func (x *Environment) GetContainerImage() *ContainerImage

func (*Environment) GetCreateTime

func (x *Environment) GetCreateTime() *timestamppb.Timestamp

func (*Environment) GetDescription

func (x *Environment) GetDescription() string

func (*Environment) GetDisplayName

func (x *Environment) GetDisplayName() string

func (*Environment) GetImageType

func (m *Environment) GetImageType() isEnvironment_ImageType

func (*Environment) GetName

func (x *Environment) GetName() string

func (*Environment) GetPostStartupScript

func (x *Environment) GetPostStartupScript() string

func (*Environment) GetVmImage

func (x *Environment) GetVmImage() *VmImage

func (*Environment) ProtoMessage

func (*Environment) ProtoMessage()

func (*Environment) ProtoReflect

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

func (*Environment) Reset

func (x *Environment) Reset()

func (*Environment) String

func (x *Environment) String() string

type Environment_ContainerImage

type Environment_ContainerImage struct {
	// Use a container image to start the notebook instance.
	ContainerImage *ContainerImage `protobuf:"bytes,7,opt,name=container_image,json=containerImage,proto3,oneof"`
}

type Environment_VmImage

type Environment_VmImage struct {
	// Use a Compute Engine VM image to start the notebook instance.
	VmImage *VmImage `protobuf:"bytes,6,opt,name=vm_image,json=vmImage,proto3,oneof"`
}

type GetEnvironmentRequest

type GetEnvironmentRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/environments/{environment_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting a notebook environment.

func (*GetEnvironmentRequest) Descriptor

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

Deprecated: Use GetEnvironmentRequest.ProtoReflect.Descriptor instead.

func (*GetEnvironmentRequest) GetName

func (x *GetEnvironmentRequest) GetName() string

func (*GetEnvironmentRequest) ProtoMessage

func (*GetEnvironmentRequest) ProtoMessage()

func (*GetEnvironmentRequest) ProtoReflect

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

func (*GetEnvironmentRequest) Reset

func (x *GetEnvironmentRequest) Reset()

func (*GetEnvironmentRequest) String

func (x *GetEnvironmentRequest) String() string

type GetInstanceRequest

type GetInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting a notebook instance.

func (*GetInstanceRequest) Descriptor

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetName

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) ProtoMessage

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect

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

func (*GetInstanceRequest) Reset

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String

func (x *GetInstanceRequest) String() string

type Instance

type Instance struct {

	// Output only. The name of this notebook instance. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of the environment; can be one of VM image, or container image.
	//
	// Types that are assignable to Environment:
	//	*Instance_VmImage
	//	*Instance_ContainerImage
	Environment isInstance_Environment `protobuf_oneof:"environment"`
	// Path to a Bash script that automatically runs after a notebook instance
	// fully boots up. The path must be a URL or
	// Cloud Storage path (`gs://path-to-file/file-name`).
	PostStartupScript string `protobuf:"bytes,4,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
	// Output only. The proxy endpoint that is used to access the Jupyter notebook.
	ProxyUri string `protobuf:"bytes,5,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
	// Input only. The owner of this instance after creation. Format: `alias@example.com`
	//
	// Currently supports one owner only. If not specified, all of the service
	// account users of your VM instance's service account can use
	// the instance.
	InstanceOwners []string `protobuf:"bytes,6,rep,name=instance_owners,json=instanceOwners,proto3" json:"instance_owners,omitempty"`
	// The service account on this instance, giving access to other Google
	// Cloud services.
	// You can use any service account within the same project, but you
	// must have the service account user permission to use the instance.
	//
	// If not specified, the [Compute Engine default service
	// account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
	// is used.
	ServiceAccount string `protobuf:"bytes,7,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this
	// instance.
	MachineType string `protobuf:"bytes,8,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// The hardware accelerator used on this instance. If you use
	// accelerators, make sure that your configuration has
	// [enough vCPUs and memory to support the `machine_type` you
	// have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
	AcceleratorConfig *Instance_AcceleratorConfig `protobuf:"bytes,9,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
	// Output only. The state of this instance.
	State Instance_State `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.notebooks.v1beta1.Instance_State" json:"state,omitempty"`
	// Whether the end user authorizes Google Cloud to install GPU driver
	// on this instance.
	// If this field is empty or set to false, the GPU driver won't be installed.
	// Only applicable to instances with GPUs.
	InstallGpuDriver bool `protobuf:"varint,11,opt,name=install_gpu_driver,json=installGpuDriver,proto3" json:"install_gpu_driver,omitempty"`
	// Specify a custom Cloud Storage path where the GPU driver is stored.
	// If not specified, we'll automatically choose from official GPU drivers.
	CustomGpuDriverPath string `protobuf:"bytes,12,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
	// Input only. The type of the boot disk attached to this instance, defaults to
	// standard persistent disk (`PD_STANDARD`).
	BootDiskType Instance_DiskType `` /* 155-byte string literal not displayed */
	// Input only. The size of the boot disk in GB attached to this instance, up to a maximum
	// of 64000 GB (64 TB). The minimum recommended value is
	// 100 GB. If not specified, this defaults to 100.
	BootDiskSizeGb int64 `protobuf:"varint,14,opt,name=boot_disk_size_gb,json=bootDiskSizeGb,proto3" json:"boot_disk_size_gb,omitempty"`
	// Input only. The type of the data disk attached to this instance, defaults to
	// standard persistent disk (`PD_STANDARD`).
	DataDiskType Instance_DiskType `` /* 155-byte string literal not displayed */
	// Input only. The size of the data disk in GB attached to this instance, up to a maximum
	// of 64000 GB (64 TB). You can choose the size of the data disk
	// based on how big your notebooks and data are. If not specified, this
	// defaults to 100.
	DataDiskSizeGb int64 `protobuf:"varint,26,opt,name=data_disk_size_gb,json=dataDiskSizeGb,proto3" json:"data_disk_size_gb,omitempty"`
	// Input only. If true, the data disk will not be auto deleted when deleting the instance.
	NoRemoveDataDisk bool `protobuf:"varint,27,opt,name=no_remove_data_disk,json=noRemoveDataDisk,proto3" json:"no_remove_data_disk,omitempty"`
	// Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
	DiskEncryption Instance_DiskEncryption `` /* 165-byte string literal not displayed */
	// Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption
	// is CMEK.
	// Format:
	// `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`
	//
	// Learn more about [using your own encryption keys]( https://cloud.google.com/kms/docs/quickstart).
	KmsKey string `protobuf:"bytes,16,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// If true, no public IP will be assigned to this instance.
	NoPublicIp bool `protobuf:"varint,17,opt,name=no_public_ip,json=noPublicIp,proto3" json:"no_public_ip,omitempty"`
	// If true, the notebook instance will not register with the proxy.
	NoProxyAccess bool `protobuf:"varint,18,opt,name=no_proxy_access,json=noProxyAccess,proto3" json:"no_proxy_access,omitempty"`
	// The name of the VPC that this instance is in.
	// Format:
	// `projects/{project_id}/global/networks/{network_id}`
	Network string `protobuf:"bytes,19,opt,name=network,proto3" json:"network,omitempty"`
	// The name of the subnet that this instance is in.
	// Format:
	// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
	Subnet string `protobuf:"bytes,20,opt,name=subnet,proto3" json:"subnet,omitempty"`
	// Labels to apply to this instance.
	// These can be later modified by the setLabels method.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// Custom metadata to apply to this instance.
	Metadata map[string]string `` /* 158-byte string literal not displayed */
	// Output only. Instance creation time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,23,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Instance update time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,24,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

The definition of a notebook instance.

func (*Instance) Descriptor

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAcceleratorConfig

func (x *Instance) GetAcceleratorConfig() *Instance_AcceleratorConfig

func (*Instance) GetBootDiskSizeGb

func (x *Instance) GetBootDiskSizeGb() int64

func (*Instance) GetBootDiskType

func (x *Instance) GetBootDiskType() Instance_DiskType

func (*Instance) GetContainerImage

func (x *Instance) GetContainerImage() *ContainerImage

func (*Instance) GetCreateTime

func (x *Instance) GetCreateTime() *timestamppb.Timestamp

func (*Instance) GetCustomGpuDriverPath

func (x *Instance) GetCustomGpuDriverPath() string

func (*Instance) GetDataDiskSizeGb

func (x *Instance) GetDataDiskSizeGb() int64

func (*Instance) GetDataDiskType

func (x *Instance) GetDataDiskType() Instance_DiskType

func (*Instance) GetDiskEncryption

func (x *Instance) GetDiskEncryption() Instance_DiskEncryption

func (*Instance) GetEnvironment

func (m *Instance) GetEnvironment() isInstance_Environment

func (*Instance) GetInstallGpuDriver

func (x *Instance) GetInstallGpuDriver() bool

func (*Instance) GetInstanceOwners

func (x *Instance) GetInstanceOwners() []string

func (*Instance) GetKmsKey

func (x *Instance) GetKmsKey() string

func (*Instance) GetLabels

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

func (*Instance) GetMachineType

func (x *Instance) GetMachineType() string

func (*Instance) GetMetadata

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

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetNetwork

func (x *Instance) GetNetwork() string

func (*Instance) GetNoProxyAccess

func (x *Instance) GetNoProxyAccess() bool

func (*Instance) GetNoPublicIp

func (x *Instance) GetNoPublicIp() bool

func (*Instance) GetNoRemoveDataDisk

func (x *Instance) GetNoRemoveDataDisk() bool

func (*Instance) GetPostStartupScript

func (x *Instance) GetPostStartupScript() string

func (*Instance) GetProxyUri

func (x *Instance) GetProxyUri() string

func (*Instance) GetServiceAccount

func (x *Instance) GetServiceAccount() string

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetSubnet

func (x *Instance) GetSubnet() string

func (*Instance) GetUpdateTime

func (x *Instance) GetUpdateTime() *timestamppb.Timestamp

func (*Instance) GetVmImage

func (x *Instance) GetVmImage() *VmImage

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

type Instance_AcceleratorConfig

type Instance_AcceleratorConfig struct {

	// Type of this accelerator.
	Type Instance_AcceleratorType `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.notebooks.v1beta1.Instance_AcceleratorType" json:"type,omitempty"`
	// Count of cores of this accelerator.
	CoreCount int64 `protobuf:"varint,2,opt,name=core_count,json=coreCount,proto3" json:"core_count,omitempty"`
	// contains filtered or unexported fields
}

Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.

func (*Instance_AcceleratorConfig) Descriptor

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

Deprecated: Use Instance_AcceleratorConfig.ProtoReflect.Descriptor instead.

func (*Instance_AcceleratorConfig) GetCoreCount

func (x *Instance_AcceleratorConfig) GetCoreCount() int64

func (*Instance_AcceleratorConfig) GetType

func (*Instance_AcceleratorConfig) ProtoMessage

func (*Instance_AcceleratorConfig) ProtoMessage()

func (*Instance_AcceleratorConfig) ProtoReflect

func (*Instance_AcceleratorConfig) Reset

func (x *Instance_AcceleratorConfig) Reset()

func (*Instance_AcceleratorConfig) String

func (x *Instance_AcceleratorConfig) String() string

type Instance_AcceleratorType

type Instance_AcceleratorType int32

Definition of the types of hardware accelerators that can be used on this instance.

const (
	// Accelerator type is not specified.
	Instance_ACCELERATOR_TYPE_UNSPECIFIED Instance_AcceleratorType = 0
	// Accelerator type is Nvidia Tesla K80.
	Instance_NVIDIA_TESLA_K80 Instance_AcceleratorType = 1
	// Accelerator type is Nvidia Tesla P100.
	Instance_NVIDIA_TESLA_P100 Instance_AcceleratorType = 2
	// Accelerator type is Nvidia Tesla V100.
	Instance_NVIDIA_TESLA_V100 Instance_AcceleratorType = 3
	// Accelerator type is Nvidia Tesla P_4.
	Instance_NVIDIA_TESLA_P4 Instance_AcceleratorType = 4
	// Accelerator type is Nvidia Tesla T4.
	Instance_NVIDIA_TESLA_T4 Instance_AcceleratorType = 5
	// Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
	Instance_NVIDIA_TESLA_T4_VWS Instance_AcceleratorType = 8
	// Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
	Instance_NVIDIA_TESLA_P100_VWS Instance_AcceleratorType = 9
	// Accelerator type is NVIDIA Tesla P_4 Virtual Workstations.
	Instance_NVIDIA_TESLA_P4_VWS Instance_AcceleratorType = 10
	// (Coming soon) Accelerator type is TPU V2.
	Instance_TPU_V2 Instance_AcceleratorType = 6
	// (Coming soon) Accelerator type is TPU V3.
	Instance_TPU_V3 Instance_AcceleratorType = 7
)

func (Instance_AcceleratorType) Descriptor

func (Instance_AcceleratorType) Enum

func (Instance_AcceleratorType) EnumDescriptor

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

Deprecated: Use Instance_AcceleratorType.Descriptor instead.

func (Instance_AcceleratorType) Number

func (Instance_AcceleratorType) String

func (x Instance_AcceleratorType) String() string

func (Instance_AcceleratorType) Type

type Instance_ContainerImage

type Instance_ContainerImage struct {
	// Use a container image to start the notebook instance.
	ContainerImage *ContainerImage `protobuf:"bytes,3,opt,name=container_image,json=containerImage,proto3,oneof"`
}

type Instance_DiskEncryption

type Instance_DiskEncryption int32

Definition of the disk encryption options.

const (
	// Disk encryption is not specified.
	Instance_DISK_ENCRYPTION_UNSPECIFIED Instance_DiskEncryption = 0
	// Use Google managed encryption keys to encrypt the boot disk.
	Instance_GMEK Instance_DiskEncryption = 1
	// Use customer managed encryption keys to encrypt the boot disk.
	Instance_CMEK Instance_DiskEncryption = 2
)

func (Instance_DiskEncryption) Descriptor

func (Instance_DiskEncryption) Enum

func (Instance_DiskEncryption) EnumDescriptor

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

Deprecated: Use Instance_DiskEncryption.Descriptor instead.

func (Instance_DiskEncryption) Number

func (Instance_DiskEncryption) String

func (x Instance_DiskEncryption) String() string

func (Instance_DiskEncryption) Type

type Instance_DiskType

type Instance_DiskType int32

Possible disk types for notebook instances.

const (
	// Disk type not set.
	Instance_DISK_TYPE_UNSPECIFIED Instance_DiskType = 0
	// Standard persistent disk type.
	Instance_PD_STANDARD Instance_DiskType = 1
	// SSD persistent disk type.
	Instance_PD_SSD Instance_DiskType = 2
	// Balanced persistent disk type.
	Instance_PD_BALANCED Instance_DiskType = 3
)

func (Instance_DiskType) Descriptor

func (Instance_DiskType) Enum

func (Instance_DiskType) EnumDescriptor

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

Deprecated: Use Instance_DiskType.Descriptor instead.

func (Instance_DiskType) Number

func (Instance_DiskType) String

func (x Instance_DiskType) String() string

func (Instance_DiskType) Type

type Instance_State

type Instance_State int32

The definition of the states of this instance.

const (
	// State is not specified.
	Instance_STATE_UNSPECIFIED Instance_State = 0
	// The control logic is starting the instance.
	Instance_STARTING Instance_State = 1
	// The control logic is installing required frameworks and registering the
	// instance with notebook proxy
	Instance_PROVISIONING Instance_State = 2
	// The instance is running.
	Instance_ACTIVE Instance_State = 3
	// The control logic is stopping the instance.
	Instance_STOPPING Instance_State = 4
	// The instance is stopped.
	Instance_STOPPED Instance_State = 5
	// The instance is deleted.
	Instance_DELETED Instance_State = 6
	// The instance is upgrading.
	Instance_UPGRADING Instance_State = 7
	// The instance is being created.
	Instance_INITIALIZING Instance_State = 8
	// The instance is getting registered.
	Instance_REGISTERING Instance_State = 9
)

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor

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

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

type Instance_VmImage

type Instance_VmImage struct {
	// Use a Compute Engine VM image to start the notebook instance.
	VmImage *VmImage `protobuf:"bytes,2,opt,name=vm_image,json=vmImage,proto3,oneof"`
}

type IsInstanceUpgradeableRequest

type IsInstanceUpgradeableRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	NotebookInstance string `protobuf:"bytes,1,opt,name=notebook_instance,json=notebookInstance,proto3" json:"notebook_instance,omitempty"`
	// contains filtered or unexported fields
}

Request for checking if a notebook instance is upgradeable.

func (*IsInstanceUpgradeableRequest) Descriptor

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

Deprecated: Use IsInstanceUpgradeableRequest.ProtoReflect.Descriptor instead.

func (*IsInstanceUpgradeableRequest) GetNotebookInstance

func (x *IsInstanceUpgradeableRequest) GetNotebookInstance() string

func (*IsInstanceUpgradeableRequest) ProtoMessage

func (*IsInstanceUpgradeableRequest) ProtoMessage()

func (*IsInstanceUpgradeableRequest) ProtoReflect

func (*IsInstanceUpgradeableRequest) Reset

func (x *IsInstanceUpgradeableRequest) Reset()

func (*IsInstanceUpgradeableRequest) String

type IsInstanceUpgradeableResponse

type IsInstanceUpgradeableResponse struct {

	// If an instance is upgradeable.
	Upgradeable bool `protobuf:"varint,1,opt,name=upgradeable,proto3" json:"upgradeable,omitempty"`
	// The version this instance will be upgraded to if calling the upgrade
	// endpoint. This field will only be populated if field upgradeable is true.
	UpgradeVersion string `protobuf:"bytes,2,opt,name=upgrade_version,json=upgradeVersion,proto3" json:"upgrade_version,omitempty"`
	// Additional information about upgrade.
	UpgradeInfo string `protobuf:"bytes,3,opt,name=upgrade_info,json=upgradeInfo,proto3" json:"upgrade_info,omitempty"`
	// contains filtered or unexported fields
}

Response for checking if a notebook instance is upgradeable.

func (*IsInstanceUpgradeableResponse) Descriptor

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

Deprecated: Use IsInstanceUpgradeableResponse.ProtoReflect.Descriptor instead.

func (*IsInstanceUpgradeableResponse) GetUpgradeInfo

func (x *IsInstanceUpgradeableResponse) GetUpgradeInfo() string

func (*IsInstanceUpgradeableResponse) GetUpgradeVersion

func (x *IsInstanceUpgradeableResponse) GetUpgradeVersion() string

func (*IsInstanceUpgradeableResponse) GetUpgradeable

func (x *IsInstanceUpgradeableResponse) GetUpgradeable() bool

func (*IsInstanceUpgradeableResponse) ProtoMessage

func (*IsInstanceUpgradeableResponse) ProtoMessage()

func (*IsInstanceUpgradeableResponse) ProtoReflect

func (*IsInstanceUpgradeableResponse) Reset

func (x *IsInstanceUpgradeableResponse) Reset()

func (*IsInstanceUpgradeableResponse) String

type ListEnvironmentsRequest

type ListEnvironmentsRequest struct {

	// Required. Format: `projects/{project_id}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum return size of the list call.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A previous returned page token that can be used to continue listing from
	// the last result.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing environments.

func (*ListEnvironmentsRequest) Descriptor

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

Deprecated: Use ListEnvironmentsRequest.ProtoReflect.Descriptor instead.

func (*ListEnvironmentsRequest) GetPageSize

func (x *ListEnvironmentsRequest) GetPageSize() int32

func (*ListEnvironmentsRequest) GetPageToken

func (x *ListEnvironmentsRequest) GetPageToken() string

func (*ListEnvironmentsRequest) GetParent

func (x *ListEnvironmentsRequest) GetParent() string

func (*ListEnvironmentsRequest) ProtoMessage

func (*ListEnvironmentsRequest) ProtoMessage()

func (*ListEnvironmentsRequest) ProtoReflect

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

func (*ListEnvironmentsRequest) Reset

func (x *ListEnvironmentsRequest) Reset()

func (*ListEnvironmentsRequest) String

func (x *ListEnvironmentsRequest) String() string

type ListEnvironmentsResponse

type ListEnvironmentsResponse struct {

	// A list of returned environments.
	Environments []*Environment `protobuf:"bytes,1,rep,name=environments,proto3" json:"environments,omitempty"`
	// A page token that can be used to continue listing from the last result
	// in the next list call.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response for listing environments.

func (*ListEnvironmentsResponse) Descriptor

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

Deprecated: Use ListEnvironmentsResponse.ProtoReflect.Descriptor instead.

func (*ListEnvironmentsResponse) GetEnvironments

func (x *ListEnvironmentsResponse) GetEnvironments() []*Environment

func (*ListEnvironmentsResponse) GetNextPageToken

func (x *ListEnvironmentsResponse) GetNextPageToken() string

func (*ListEnvironmentsResponse) GetUnreachable

func (x *ListEnvironmentsResponse) GetUnreachable() []string

func (*ListEnvironmentsResponse) ProtoMessage

func (*ListEnvironmentsResponse) ProtoMessage()

func (*ListEnvironmentsResponse) ProtoReflect

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

func (*ListEnvironmentsResponse) Reset

func (x *ListEnvironmentsResponse) Reset()

func (*ListEnvironmentsResponse) String

func (x *ListEnvironmentsResponse) String() string

type ListInstancesRequest

type ListInstancesRequest struct {

	// Required. Format:
	// `parent=projects/{project_id}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum return size of the list call.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A previous returned page token that can be used to continue listing
	// from the last result.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing notebook instances.

func (*ListInstancesRequest) Descriptor

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

Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.

func (*ListInstancesRequest) GetPageSize

func (x *ListInstancesRequest) GetPageSize() int32

func (*ListInstancesRequest) GetPageToken

func (x *ListInstancesRequest) GetPageToken() string

func (*ListInstancesRequest) GetParent

func (x *ListInstancesRequest) GetParent() string

func (*ListInstancesRequest) ProtoMessage

func (*ListInstancesRequest) ProtoMessage()

func (*ListInstancesRequest) ProtoReflect

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

func (*ListInstancesRequest) Reset

func (x *ListInstancesRequest) Reset()

func (*ListInstancesRequest) String

func (x *ListInstancesRequest) String() string

type ListInstancesResponse

type ListInstancesResponse struct {

	// A list of returned instances.
	Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// Page token that can be used to continue listing from the last result in the
	// next list call.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached. For example,
	// ['us-west1-a', 'us-central1-b'].
	// A ListInstancesResponse will only contain either instances or unreachables,
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response for listing notebook instances.

func (*ListInstancesResponse) Descriptor

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

Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.

func (*ListInstancesResponse) GetInstances

func (x *ListInstancesResponse) GetInstances() []*Instance

func (*ListInstancesResponse) GetNextPageToken

func (x *ListInstancesResponse) GetNextPageToken() string

func (*ListInstancesResponse) GetUnreachable

func (x *ListInstancesResponse) GetUnreachable() []string

func (*ListInstancesResponse) ProtoMessage

func (*ListInstancesResponse) ProtoMessage()

func (*ListInstancesResponse) ProtoReflect

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

func (*ListInstancesResponse) Reset

func (x *ListInstancesResponse) Reset()

func (*ListInstancesResponse) String

func (x *ListInstancesResponse) String() string

type NotebookServiceClient

type NotebookServiceClient interface {
	// Lists instances in a given project and location.
	ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
	// Gets details of a single Instance.
	GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
	// Creates a new Instance in a given project and location.
	CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Registers an existing legacy notebook instance to the Notebooks API server.
	// Legacy instances are instances created with the legacy Compute Engine
	// calls. They are not manageable by the Notebooks API out of the box. This
	// call makes these instances manageable by the Notebooks API.
	RegisterInstance(ctx context.Context, in *RegisterInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Updates the guest accelerators of a single Instance.
	SetInstanceAccelerator(ctx context.Context, in *SetInstanceAcceleratorRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Updates the machine type of a single Instance.
	SetInstanceMachineType(ctx context.Context, in *SetInstanceMachineTypeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Updates the labels of an Instance.
	SetInstanceLabels(ctx context.Context, in *SetInstanceLabelsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Starts a notebook instance.
	StartInstance(ctx context.Context, in *StartInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Stops a notebook instance.
	StopInstance(ctx context.Context, in *StopInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Resets a notebook instance.
	ResetInstance(ctx context.Context, in *ResetInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Allows notebook instances to
	// report their latest instance information to the Notebooks
	// API server. The server will merge the reported information to
	// the instance metadata store. Do not use this method directly.
	ReportInstanceInfo(ctx context.Context, in *ReportInstanceInfoRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Check if a notebook instance is upgradable.
	IsInstanceUpgradeable(ctx context.Context, in *IsInstanceUpgradeableRequest, opts ...grpc.CallOption) (*IsInstanceUpgradeableResponse, error)
	// Upgrades a notebook instance to the latest version.
	UpgradeInstance(ctx context.Context, in *UpgradeInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Allows notebook instances to
	// call this endpoint to upgrade themselves. Do not use this method directly.
	UpgradeInstanceInternal(ctx context.Context, in *UpgradeInstanceInternalRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Lists environments in a project.
	ListEnvironments(ctx context.Context, in *ListEnvironmentsRequest, opts ...grpc.CallOption) (*ListEnvironmentsResponse, error)
	// Gets details of a single Environment.
	GetEnvironment(ctx context.Context, in *GetEnvironmentRequest, opts ...grpc.CallOption) (*Environment, error)
	// Creates a new Environment.
	CreateEnvironment(ctx context.Context, in *CreateEnvironmentRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Deletes a single Environment.
	DeleteEnvironment(ctx context.Context, in *DeleteEnvironmentRequest, opts ...grpc.CallOption) (*longrunning.Operation, 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.

type NotebookServiceServer

type NotebookServiceServer interface {
	// Lists instances in a given project and location.
	ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
	// Gets details of a single Instance.
	GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
	// Creates a new Instance in a given project and location.
	CreateInstance(context.Context, *CreateInstanceRequest) (*longrunning.Operation, error)
	// Registers an existing legacy notebook instance to the Notebooks API server.
	// Legacy instances are instances created with the legacy Compute Engine
	// calls. They are not manageable by the Notebooks API out of the box. This
	// call makes these instances manageable by the Notebooks API.
	RegisterInstance(context.Context, *RegisterInstanceRequest) (*longrunning.Operation, error)
	// Updates the guest accelerators of a single Instance.
	SetInstanceAccelerator(context.Context, *SetInstanceAcceleratorRequest) (*longrunning.Operation, error)
	// Updates the machine type of a single Instance.
	SetInstanceMachineType(context.Context, *SetInstanceMachineTypeRequest) (*longrunning.Operation, error)
	// Updates the labels of an Instance.
	SetInstanceLabels(context.Context, *SetInstanceLabelsRequest) (*longrunning.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunning.Operation, error)
	// Starts a notebook instance.
	StartInstance(context.Context, *StartInstanceRequest) (*longrunning.Operation, error)
	// Stops a notebook instance.
	StopInstance(context.Context, *StopInstanceRequest) (*longrunning.Operation, error)
	// Resets a notebook instance.
	ResetInstance(context.Context, *ResetInstanceRequest) (*longrunning.Operation, error)
	// Allows notebook instances to
	// report their latest instance information to the Notebooks
	// API server. The server will merge the reported information to
	// the instance metadata store. Do not use this method directly.
	ReportInstanceInfo(context.Context, *ReportInstanceInfoRequest) (*longrunning.Operation, error)
	// Check if a notebook instance is upgradable.
	IsInstanceUpgradeable(context.Context, *IsInstanceUpgradeableRequest) (*IsInstanceUpgradeableResponse, error)
	// Upgrades a notebook instance to the latest version.
	UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunning.Operation, error)
	// Allows notebook instances to
	// call this endpoint to upgrade themselves. Do not use this method directly.
	UpgradeInstanceInternal(context.Context, *UpgradeInstanceInternalRequest) (*longrunning.Operation, error)
	// Lists environments in a project.
	ListEnvironments(context.Context, *ListEnvironmentsRequest) (*ListEnvironmentsResponse, error)
	// Gets details of a single Environment.
	GetEnvironment(context.Context, *GetEnvironmentRequest) (*Environment, error)
	// Creates a new Environment.
	CreateEnvironment(context.Context, *CreateEnvironmentRequest) (*longrunning.Operation, error)
	// Deletes a single Environment.
	DeleteEnvironment(context.Context, *DeleteEnvironmentRequest) (*longrunning.Operation, error)
}

NotebookServiceServer is the server API for NotebookService service.

type OperationMetadata

type OperationMetadata struct {

	// The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Identifies whether the user has requested cancellation
	// of the operation. Operations that have successfully been cancelled
	// have [Operation.error][] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// API endpoint name of this operation.
	Endpoint string `protobuf:"bytes,8,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndpoint

func (x *OperationMetadata) GetEndpoint() string

func (*OperationMetadata) GetRequestedCancellation

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

type RegisterInstanceRequest

type RegisterInstanceRequest struct {

	// Required. Format:
	// `parent=projects/{project_id}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User defined unique ID of this instance. The `instance_id` must
	// be 1 to 63 characters long and contain only lowercase letters,
	// numeric characters, and dashes. The first character must be a lowercase
	// letter and the last character cannot be a dash.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// contains filtered or unexported fields
}

Request for registering a notebook instance.

func (*RegisterInstanceRequest) Descriptor

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

Deprecated: Use RegisterInstanceRequest.ProtoReflect.Descriptor instead.

func (*RegisterInstanceRequest) GetInstanceId

func (x *RegisterInstanceRequest) GetInstanceId() string

func (*RegisterInstanceRequest) GetParent

func (x *RegisterInstanceRequest) GetParent() string

func (*RegisterInstanceRequest) ProtoMessage

func (*RegisterInstanceRequest) ProtoMessage()

func (*RegisterInstanceRequest) ProtoReflect

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

func (*RegisterInstanceRequest) Reset

func (x *RegisterInstanceRequest) Reset()

func (*RegisterInstanceRequest) String

func (x *RegisterInstanceRequest) String() string

type ReportInstanceInfoRequest

type ReportInstanceInfoRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
	// The metadata reported to Notebooks API. This will be merged to the instance
	// metadata store
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request for notebook instances to report information to Notebooks API.

func (*ReportInstanceInfoRequest) Descriptor

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

Deprecated: Use ReportInstanceInfoRequest.ProtoReflect.Descriptor instead.

func (*ReportInstanceInfoRequest) GetMetadata

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

func (*ReportInstanceInfoRequest) GetName

func (x *ReportInstanceInfoRequest) GetName() string

func (*ReportInstanceInfoRequest) GetVmId

func (x *ReportInstanceInfoRequest) GetVmId() string

func (*ReportInstanceInfoRequest) ProtoMessage

func (*ReportInstanceInfoRequest) ProtoMessage()

func (*ReportInstanceInfoRequest) ProtoReflect

func (*ReportInstanceInfoRequest) Reset

func (x *ReportInstanceInfoRequest) Reset()

func (*ReportInstanceInfoRequest) String

func (x *ReportInstanceInfoRequest) String() string

type ResetInstanceRequest

type ResetInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for reseting a notebook instance

func (*ResetInstanceRequest) Descriptor

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

Deprecated: Use ResetInstanceRequest.ProtoReflect.Descriptor instead.

func (*ResetInstanceRequest) GetName

func (x *ResetInstanceRequest) GetName() string

func (*ResetInstanceRequest) ProtoMessage

func (*ResetInstanceRequest) ProtoMessage()

func (*ResetInstanceRequest) ProtoReflect

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

func (*ResetInstanceRequest) Reset

func (x *ResetInstanceRequest) Reset()

func (*ResetInstanceRequest) String

func (x *ResetInstanceRequest) String() string

type SetInstanceAcceleratorRequest

type SetInstanceAcceleratorRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Type of this accelerator.
	Type Instance_AcceleratorType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1beta1.Instance_AcceleratorType" json:"type,omitempty"`
	// Required. Count of cores of this accelerator. Note that not all combinations
	// of `type` and `core_count` are valid. Check [GPUs on
	// Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
	// find a valid combination. TPUs are not supported.
	CoreCount int64 `protobuf:"varint,3,opt,name=core_count,json=coreCount,proto3" json:"core_count,omitempty"`
	// contains filtered or unexported fields
}

Request for setting instance accelerator.

func (*SetInstanceAcceleratorRequest) Descriptor

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

Deprecated: Use SetInstanceAcceleratorRequest.ProtoReflect.Descriptor instead.

func (*SetInstanceAcceleratorRequest) GetCoreCount

func (x *SetInstanceAcceleratorRequest) GetCoreCount() int64

func (*SetInstanceAcceleratorRequest) GetName

func (*SetInstanceAcceleratorRequest) GetType

func (*SetInstanceAcceleratorRequest) ProtoMessage

func (*SetInstanceAcceleratorRequest) ProtoMessage()

func (*SetInstanceAcceleratorRequest) ProtoReflect

func (*SetInstanceAcceleratorRequest) Reset

func (x *SetInstanceAcceleratorRequest) Reset()

func (*SetInstanceAcceleratorRequest) String

type SetInstanceLabelsRequest

type SetInstanceLabelsRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Labels to apply to this instance.
	// These can be later modified by the setLabels method
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request for setting instance labels.

func (*SetInstanceLabelsRequest) Descriptor

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

Deprecated: Use SetInstanceLabelsRequest.ProtoReflect.Descriptor instead.

func (*SetInstanceLabelsRequest) GetLabels

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

func (*SetInstanceLabelsRequest) GetName

func (x *SetInstanceLabelsRequest) GetName() string

func (*SetInstanceLabelsRequest) ProtoMessage

func (*SetInstanceLabelsRequest) ProtoMessage()

func (*SetInstanceLabelsRequest) ProtoReflect

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

func (*SetInstanceLabelsRequest) Reset

func (x *SetInstanceLabelsRequest) Reset()

func (*SetInstanceLabelsRequest) String

func (x *SetInstanceLabelsRequest) String() string

type SetInstanceMachineTypeRequest

type SetInstanceMachineTypeRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The [Compute Engine machine
	// type](https://cloud.google.com/compute/docs/machine-types).
	MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// contains filtered or unexported fields
}

Request for setting instance machine type.

func (*SetInstanceMachineTypeRequest) Descriptor

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

Deprecated: Use SetInstanceMachineTypeRequest.ProtoReflect.Descriptor instead.

func (*SetInstanceMachineTypeRequest) GetMachineType

func (x *SetInstanceMachineTypeRequest) GetMachineType() string

func (*SetInstanceMachineTypeRequest) GetName

func (*SetInstanceMachineTypeRequest) ProtoMessage

func (*SetInstanceMachineTypeRequest) ProtoMessage()

func (*SetInstanceMachineTypeRequest) ProtoReflect

func (*SetInstanceMachineTypeRequest) Reset

func (x *SetInstanceMachineTypeRequest) Reset()

func (*SetInstanceMachineTypeRequest) String

type StartInstanceRequest

type StartInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for starting a notebook instance

func (*StartInstanceRequest) Descriptor

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

Deprecated: Use StartInstanceRequest.ProtoReflect.Descriptor instead.

func (*StartInstanceRequest) GetName

func (x *StartInstanceRequest) GetName() string

func (*StartInstanceRequest) ProtoMessage

func (*StartInstanceRequest) ProtoMessage()

func (*StartInstanceRequest) ProtoReflect

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

func (*StartInstanceRequest) Reset

func (x *StartInstanceRequest) Reset()

func (*StartInstanceRequest) String

func (x *StartInstanceRequest) String() string

type StopInstanceRequest

type StopInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for stopping a notebook instance

func (*StopInstanceRequest) Descriptor

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

Deprecated: Use StopInstanceRequest.ProtoReflect.Descriptor instead.

func (*StopInstanceRequest) GetName

func (x *StopInstanceRequest) GetName() string

func (*StopInstanceRequest) ProtoMessage

func (*StopInstanceRequest) ProtoMessage()

func (*StopInstanceRequest) ProtoReflect

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

func (*StopInstanceRequest) Reset

func (x *StopInstanceRequest) Reset()

func (*StopInstanceRequest) String

func (x *StopInstanceRequest) String() string

type UnimplementedNotebookServiceServer

type UnimplementedNotebookServiceServer struct {
}

UnimplementedNotebookServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNotebookServiceServer) CreateEnvironment

func (*UnimplementedNotebookServiceServer) CreateInstance

func (*UnimplementedNotebookServiceServer) DeleteEnvironment

func (*UnimplementedNotebookServiceServer) DeleteInstance

func (*UnimplementedNotebookServiceServer) GetEnvironment

func (*UnimplementedNotebookServiceServer) GetInstance

func (*UnimplementedNotebookServiceServer) ListEnvironments

func (*UnimplementedNotebookServiceServer) ListInstances

func (*UnimplementedNotebookServiceServer) RegisterInstance

func (*UnimplementedNotebookServiceServer) ReportInstanceInfo

func (*UnimplementedNotebookServiceServer) ResetInstance

func (*UnimplementedNotebookServiceServer) SetInstanceAccelerator

func (*UnimplementedNotebookServiceServer) SetInstanceLabels

func (*UnimplementedNotebookServiceServer) SetInstanceMachineType

func (*UnimplementedNotebookServiceServer) StartInstance

func (*UnimplementedNotebookServiceServer) StopInstance

func (*UnimplementedNotebookServiceServer) UpgradeInstance

func (*UnimplementedNotebookServiceServer) UpgradeInstanceInternal

type UpgradeInstanceInternalRequest

type UpgradeInstanceInternalRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The VM hardware token for authenticating the VM.
	// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
	VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
	// contains filtered or unexported fields
}

Request for upgrading a notebook instance from within the VM

func (*UpgradeInstanceInternalRequest) Descriptor

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

Deprecated: Use UpgradeInstanceInternalRequest.ProtoReflect.Descriptor instead.

func (*UpgradeInstanceInternalRequest) GetName

func (*UpgradeInstanceInternalRequest) GetVmId

func (*UpgradeInstanceInternalRequest) ProtoMessage

func (*UpgradeInstanceInternalRequest) ProtoMessage()

func (*UpgradeInstanceInternalRequest) ProtoReflect

func (*UpgradeInstanceInternalRequest) Reset

func (x *UpgradeInstanceInternalRequest) Reset()

func (*UpgradeInstanceInternalRequest) String

type UpgradeInstanceRequest

type UpgradeInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for upgrading a notebook instance

func (*UpgradeInstanceRequest) Descriptor

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

Deprecated: Use UpgradeInstanceRequest.ProtoReflect.Descriptor instead.

func (*UpgradeInstanceRequest) GetName

func (x *UpgradeInstanceRequest) GetName() string

func (*UpgradeInstanceRequest) ProtoMessage

func (*UpgradeInstanceRequest) ProtoMessage()

func (*UpgradeInstanceRequest) ProtoReflect

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

func (*UpgradeInstanceRequest) Reset

func (x *UpgradeInstanceRequest) Reset()

func (*UpgradeInstanceRequest) String

func (x *UpgradeInstanceRequest) String() string

type VmImage

type VmImage struct {

	// Required. The name of the Google Cloud project that this VM image belongs to.
	// Format: `projects/{project_id}`
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The reference to an external Compute Engine VM image.
	//
	// Types that are assignable to Image:
	//	*VmImage_ImageName
	//	*VmImage_ImageFamily
	Image isVmImage_Image `protobuf_oneof:"image"`
	// contains filtered or unexported fields
}

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

func (*VmImage) Descriptor

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

Deprecated: Use VmImage.ProtoReflect.Descriptor instead.

func (*VmImage) GetImage

func (m *VmImage) GetImage() isVmImage_Image

func (*VmImage) GetImageFamily

func (x *VmImage) GetImageFamily() string

func (*VmImage) GetImageName

func (x *VmImage) GetImageName() string

func (*VmImage) GetProject

func (x *VmImage) GetProject() string

func (*VmImage) ProtoMessage

func (*VmImage) ProtoMessage()

func (*VmImage) ProtoReflect

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

func (*VmImage) Reset

func (x *VmImage) Reset()

func (*VmImage) String

func (x *VmImage) String() string

type VmImage_ImageFamily

type VmImage_ImageFamily struct {
	// Use this VM image family to find the image; the newest image in this
	// family will be used.
	ImageFamily string `protobuf:"bytes,3,opt,name=image_family,json=imageFamily,proto3,oneof"`
}

type VmImage_ImageName

type VmImage_ImageName struct {
	// Use VM image name to find the image.
	ImageName string `protobuf:"bytes,2,opt,name=image_name,json=imageName,proto3,oneof"`
}