Package cloud.google.com/go/notebooks/apiv2/notebookspb (v1.12.6)

Variables

Event_EventType_name, Event_EventType_value

var (
	Event_EventType_name = map[int32]string{
		0: "EVENT_TYPE_UNSPECIFIED",
		1: "IDLE",
		2: "HEARTBEAT",
		3: "HEALTH",
		4: "MAINTENANCE",
		5: "METADATA_CHANGE",
	}
	Event_EventType_value = map[string]int32{
		"EVENT_TYPE_UNSPECIFIED": 0,
		"IDLE":                   1,
		"HEARTBEAT":              2,
		"HEALTH":                 3,
		"MAINTENANCE":            4,
		"METADATA_CHANGE":        5,
	}
)

Enum value maps for Event_EventType.

DiskEncryption_name, DiskEncryption_value

var (
	DiskEncryption_name = map[int32]string{
		0: "DISK_ENCRYPTION_UNSPECIFIED",
		1: "GMEK",
		2: "CMEK",
	}
	DiskEncryption_value = map[string]int32{
		"DISK_ENCRYPTION_UNSPECIFIED": 0,
		"GMEK":                        1,
		"CMEK":                        2,
	}
)

Enum value maps for DiskEncryption.

DiskType_name, DiskType_value

var (
	DiskType_name = map[int32]string{
		0: "DISK_TYPE_UNSPECIFIED",
		1: "PD_STANDARD",
		2: "PD_SSD",
		3: "PD_BALANCED",
		4: "PD_EXTREME",
	}
	DiskType_value = map[string]int32{
		"DISK_TYPE_UNSPECIFIED": 0,
		"PD_STANDARD":           1,
		"PD_SSD":                2,
		"PD_BALANCED":           3,
		"PD_EXTREME":            4,
	}
)

Enum value maps for DiskType.

NetworkInterface_NicType_name, NetworkInterface_NicType_value

var (
	NetworkInterface_NicType_name = map[int32]string{
		0: "NIC_TYPE_UNSPECIFIED",
		1: "VIRTIO_NET",
		2: "GVNIC",
	}
	NetworkInterface_NicType_value = map[string]int32{
		"NIC_TYPE_UNSPECIFIED": 0,
		"VIRTIO_NET":           1,
		"GVNIC":                2,
	}
)

Enum value maps for NetworkInterface_NicType.

AcceleratorConfig_AcceleratorType_name, AcceleratorConfig_AcceleratorType_value

var (
	AcceleratorConfig_AcceleratorType_name = map[int32]string{
		0:  "ACCELERATOR_TYPE_UNSPECIFIED",
		2:  "NVIDIA_TESLA_P100",
		3:  "NVIDIA_TESLA_V100",
		4:  "NVIDIA_TESLA_P4",
		5:  "NVIDIA_TESLA_T4",
		11: "NVIDIA_TESLA_A100",
		12: "NVIDIA_A100_80GB",
		13: "NVIDIA_L4",
		8:  "NVIDIA_TESLA_T4_VWS",
		9:  "NVIDIA_TESLA_P100_VWS",
		10: "NVIDIA_TESLA_P4_VWS",
	}
	AcceleratorConfig_AcceleratorType_value = map[string]int32{
		"ACCELERATOR_TYPE_UNSPECIFIED": 0,
		"NVIDIA_TESLA_P100":            2,
		"NVIDIA_TESLA_V100":            3,
		"NVIDIA_TESLA_P4":              4,
		"NVIDIA_TESLA_T4":              5,
		"NVIDIA_TESLA_A100":            11,
		"NVIDIA_A100_80GB":             12,
		"NVIDIA_L4":                    13,
		"NVIDIA_TESLA_T4_VWS":          8,
		"NVIDIA_TESLA_P100_VWS":        9,
		"NVIDIA_TESLA_P4_VWS":          10,
	}
)

Enum value maps for AcceleratorConfig_AcceleratorType.

State_name, State_value

var (
	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:  "SUSPENDING",
		10: "SUSPENDED",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STARTING":          1,
		"PROVISIONING":      2,
		"ACTIVE":            3,
		"STOPPING":          4,
		"STOPPED":           5,
		"DELETED":           6,
		"UPGRADING":         7,
		"INITIALIZING":      8,
		"SUSPENDING":        9,
		"SUSPENDED":         10,
	}
)

Enum value maps for State.

HealthState_name, HealthState_value

var (
	HealthState_name = map[int32]string{
		0: "HEALTH_STATE_UNSPECIFIED",
		1: "HEALTHY",
		2: "UNHEALTHY",
		3: "AGENT_NOT_INSTALLED",
		4: "AGENT_NOT_RUNNING",
	}
	HealthState_value = map[string]int32{
		"HEALTH_STATE_UNSPECIFIED": 0,
		"HEALTHY":                  1,
		"UNHEALTHY":                2,
		"AGENT_NOT_INSTALLED":      3,
		"AGENT_NOT_RUNNING":        4,
	}
)

Enum value maps for HealthState.

UpgradeHistoryEntry_State_name, UpgradeHistoryEntry_State_value

var (
	UpgradeHistoryEntry_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STARTED",
		2: "SUCCEEDED",
		3: "FAILED",
	}
	UpgradeHistoryEntry_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STARTED":           1,
		"SUCCEEDED":         2,
		"FAILED":            3,
	}
)

Enum value maps for UpgradeHistoryEntry_State.

UpgradeHistoryEntry_Action_name, UpgradeHistoryEntry_Action_value

var (
	UpgradeHistoryEntry_Action_name = map[int32]string{
		0: "ACTION_UNSPECIFIED",
		1: "UPGRADE",
		2: "ROLLBACK",
	}
	UpgradeHistoryEntry_Action_value = map[string]int32{
		"ACTION_UNSPECIFIED": 0,
		"UPGRADE":            1,
		"ROLLBACK":           2,
	}
)

Enum value maps for UpgradeHistoryEntry_Action.

File_google_cloud_notebooks_v2_diagnostic_config_proto

var File_google_cloud_notebooks_v2_diagnostic_config_proto protoreflect.FileDescriptor

File_google_cloud_notebooks_v2_event_proto

var File_google_cloud_notebooks_v2_event_proto protoreflect.FileDescriptor

File_google_cloud_notebooks_v2_gce_setup_proto

var File_google_cloud_notebooks_v2_gce_setup_proto protoreflect.FileDescriptor

File_google_cloud_notebooks_v2_instance_proto

var File_google_cloud_notebooks_v2_instance_proto protoreflect.FileDescriptor

File_google_cloud_notebooks_v2_service_proto

var File_google_cloud_notebooks_v2_service_proto protoreflect.FileDescriptor

Functions

func RegisterNotebookServiceServer

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

AcceleratorConfig

type AcceleratorConfig struct {

	// Optional. Type of this accelerator.
	Type AcceleratorConfig_AcceleratorType `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.notebooks.v2.AcceleratorConfig_AcceleratorType" json:"type,omitempty"`
	// Optional. 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
}

An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on type and core_count combinations. TPUs are not supported. See GPUs on Compute Engine to find a valid combination.

func (*AcceleratorConfig) Descriptor

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

Deprecated: Use AcceleratorConfig.ProtoReflect.Descriptor instead.

func (*AcceleratorConfig) GetCoreCount

func (x *AcceleratorConfig) GetCoreCount() int64

func (*AcceleratorConfig) GetType

func (x *AcceleratorConfig) GetType() AcceleratorConfig_AcceleratorType

func (*AcceleratorConfig) ProtoMessage

func (*AcceleratorConfig) ProtoMessage()

func (*AcceleratorConfig) ProtoReflect

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

func (*AcceleratorConfig) Reset

func (x *AcceleratorConfig) Reset()

func (*AcceleratorConfig) String

func (x *AcceleratorConfig) String() string

AcceleratorConfig_AcceleratorType

type AcceleratorConfig_AcceleratorType int32

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

AcceleratorConfig_ACCELERATOR_TYPE_UNSPECIFIED, AcceleratorConfig_NVIDIA_TESLA_P100, AcceleratorConfig_NVIDIA_TESLA_V100, AcceleratorConfig_NVIDIA_TESLA_P4, AcceleratorConfig_NVIDIA_TESLA_T4, AcceleratorConfig_NVIDIA_TESLA_A100, AcceleratorConfig_NVIDIA_A100_80GB, AcceleratorConfig_NVIDIA_L4, AcceleratorConfig_NVIDIA_TESLA_T4_VWS, AcceleratorConfig_NVIDIA_TESLA_P100_VWS, AcceleratorConfig_NVIDIA_TESLA_P4_VWS

const (
	// Accelerator type is not specified.
	AcceleratorConfig_ACCELERATOR_TYPE_UNSPECIFIED AcceleratorConfig_AcceleratorType = 0
	// Accelerator type is Nvidia Tesla P100.
	AcceleratorConfig_NVIDIA_TESLA_P100 AcceleratorConfig_AcceleratorType = 2
	// Accelerator type is Nvidia Tesla V100.
	AcceleratorConfig_NVIDIA_TESLA_V100 AcceleratorConfig_AcceleratorType = 3
	// Accelerator type is Nvidia Tesla P4.
	AcceleratorConfig_NVIDIA_TESLA_P4 AcceleratorConfig_AcceleratorType = 4
	// Accelerator type is Nvidia Tesla T4.
	AcceleratorConfig_NVIDIA_TESLA_T4 AcceleratorConfig_AcceleratorType = 5
	// Accelerator type is Nvidia Tesla A100 - 40GB.
	AcceleratorConfig_NVIDIA_TESLA_A100 AcceleratorConfig_AcceleratorType = 11
	// Accelerator type is Nvidia Tesla A100 - 80GB.
	AcceleratorConfig_NVIDIA_A100_80GB AcceleratorConfig_AcceleratorType = 12
	// Accelerator type is Nvidia Tesla L4.
	AcceleratorConfig_NVIDIA_L4 AcceleratorConfig_AcceleratorType = 13
	// Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
	AcceleratorConfig_NVIDIA_TESLA_T4_VWS AcceleratorConfig_AcceleratorType = 8
	// Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
	AcceleratorConfig_NVIDIA_TESLA_P100_VWS AcceleratorConfig_AcceleratorType = 9
	// Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
	AcceleratorConfig_NVIDIA_TESLA_P4_VWS AcceleratorConfig_AcceleratorType = 10
)

func (AcceleratorConfig_AcceleratorType) Descriptor

func (AcceleratorConfig_AcceleratorType) Descriptor() protoreflect.EnumDescriptor

func (AcceleratorConfig_AcceleratorType) Enum

func (x AcceleratorConfig_AcceleratorType) Enum() *AcceleratorConfig_AcceleratorType

func (AcceleratorConfig_AcceleratorType) EnumDescriptor

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

Deprecated: Use AcceleratorConfig_AcceleratorType.Descriptor instead.

func (AcceleratorConfig_AcceleratorType) Number

func (x AcceleratorConfig_AcceleratorType) Number() protoreflect.EnumNumber

func (AcceleratorConfig_AcceleratorType) String

func (x AcceleratorConfig_AcceleratorType) String() string

func (AcceleratorConfig_AcceleratorType) Type

func (AcceleratorConfig_AcceleratorType) Type() protoreflect.EnumType

BootDisk

type BootDisk struct {

	// Optional. The size of the boot disk in GB attached to this instance, up to
	// a maximum of 64000 GB (64 TB). If not specified, this defaults to the
	// recommended value of 150GB.
	DiskSizeGb int64 `protobuf:"varint,1,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
	// Optional. Indicates the type of the disk.
	DiskType DiskType `protobuf:"varint,2,opt,name=disk_type,json=diskType,proto3,enum=google.cloud.notebooks.v2.DiskType" json:"disk_type,omitempty"`
	// Optional. Input only. Disk encryption method used on the boot and data
	// disks, defaults to GMEK.
	DiskEncryption DiskEncryption `protobuf:"varint,3,opt,name=disk_encryption,json=diskEncryption,proto3,enum=google.cloud.notebooks.v2.DiskEncryption" json:"disk_encryption,omitempty"`
	// Optional. 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.
	KmsKey string `protobuf:"bytes,4,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// contains filtered or unexported fields
}

The definition of a boot disk.

func (*BootDisk) Descriptor

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

Deprecated: Use BootDisk.ProtoReflect.Descriptor instead.

func (*BootDisk) GetDiskEncryption

func (x *BootDisk) GetDiskEncryption() DiskEncryption

func (*BootDisk) GetDiskSizeGb

func (x *BootDisk) GetDiskSizeGb() int64

func (*BootDisk) GetDiskType

func (x *BootDisk) GetDiskType() DiskType

func (*BootDisk) GetKmsKey

func (x *BootDisk) GetKmsKey() string

func (*BootDisk) ProtoMessage

func (*BootDisk) ProtoMessage()

func (*BootDisk) ProtoReflect

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

func (*BootDisk) Reset

func (x *BootDisk) Reset()

func (*BootDisk) String

func (x *BootDisk) String() string

CheckInstanceUpgradabilityRequest

type CheckInstanceUpgradabilityRequest 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 (*CheckInstanceUpgradabilityRequest) Descriptor

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

Deprecated: Use CheckInstanceUpgradabilityRequest.ProtoReflect.Descriptor instead.

func (*CheckInstanceUpgradabilityRequest) GetNotebookInstance

func (x *CheckInstanceUpgradabilityRequest) GetNotebookInstance() string

func (*CheckInstanceUpgradabilityRequest) ProtoMessage

func (*CheckInstanceUpgradabilityRequest) ProtoMessage()

func (*CheckInstanceUpgradabilityRequest) ProtoReflect

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

func (*CheckInstanceUpgradabilityRequest) Reset

func (x *CheckInstanceUpgradabilityRequest) Reset()

func (*CheckInstanceUpgradabilityRequest) String

func (x *CheckInstanceUpgradabilityRequest) String() string

CheckInstanceUpgradabilityResponse

type CheckInstanceUpgradabilityResponse 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"`
	// The new image self link this instance will be upgraded to if calling the
	// upgrade endpoint. This field will only be populated if field upgradeable
	// is true.
	UpgradeImage string `protobuf:"bytes,4,opt,name=upgrade_image,json=upgradeImage,proto3" json:"upgrade_image,omitempty"`
	// contains filtered or unexported fields
}

Response for checking if a notebook instance is upgradeable.

func (*CheckInstanceUpgradabilityResponse) Descriptor

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

Deprecated: Use CheckInstanceUpgradabilityResponse.ProtoReflect.Descriptor instead.

func (*CheckInstanceUpgradabilityResponse) GetUpgradeImage

func (x *CheckInstanceUpgradabilityResponse) GetUpgradeImage() string

func (*CheckInstanceUpgradabilityResponse) GetUpgradeInfo

func (x *CheckInstanceUpgradabilityResponse) GetUpgradeInfo() string

func (*CheckInstanceUpgradabilityResponse) GetUpgradeVersion

func (x *CheckInstanceUpgradabilityResponse) GetUpgradeVersion() string

func (*CheckInstanceUpgradabilityResponse) GetUpgradeable

func (x *CheckInstanceUpgradabilityResponse) GetUpgradeable() bool

func (*CheckInstanceUpgradabilityResponse) ProtoMessage

func (*CheckInstanceUpgradabilityResponse) ProtoMessage()

func (*CheckInstanceUpgradabilityResponse) ProtoReflect

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

func (*CheckInstanceUpgradabilityResponse) Reset

func (x *CheckInstanceUpgradabilityResponse) Reset()

func (*CheckInstanceUpgradabilityResponse) String

func (x *CheckInstanceUpgradabilityResponse) String() string

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"`
	// Optional. 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

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"`
	// Optional. Idempotent request UUID.
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,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) GetRequestId

func (x *CreateInstanceRequest) GetRequestId() 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

DataDisk

type DataDisk struct {

	// Optional. The size of the disk in GB attached to this VM instance, up to a
	// maximum of 64000 GB (64 TB). If not specified, this defaults to 100.
	DiskSizeGb int64 `protobuf:"varint,1,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
	// Optional. Input only. Indicates the type of the disk.
	DiskType DiskType `protobuf:"varint,2,opt,name=disk_type,json=diskType,proto3,enum=google.cloud.notebooks.v2.DiskType" json:"disk_type,omitempty"`
	// Optional. Input only. Disk encryption method used on the boot and data
	// disks, defaults to GMEK.
	DiskEncryption DiskEncryption `protobuf:"varint,5,opt,name=disk_encryption,json=diskEncryption,proto3,enum=google.cloud.notebooks.v2.DiskEncryption" json:"disk_encryption,omitempty"`
	// Optional. 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.
	KmsKey string `protobuf:"bytes,6,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// contains filtered or unexported fields
}

An instance-attached disk resource.

func (*DataDisk) Descriptor

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

Deprecated: Use DataDisk.ProtoReflect.Descriptor instead.

func (*DataDisk) GetDiskEncryption

func (x *DataDisk) GetDiskEncryption() DiskEncryption

func (*DataDisk) GetDiskSizeGb

func (x *DataDisk) GetDiskSizeGb() int64

func (*DataDisk) GetDiskType

func (x *DataDisk) GetDiskType() DiskType

func (*DataDisk) GetKmsKey

func (x *DataDisk) GetKmsKey() string

func (*DataDisk) ProtoMessage

func (*DataDisk) ProtoMessage()

func (*DataDisk) ProtoReflect

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

func (*DataDisk) Reset

func (x *DataDisk) Reset()

func (*DataDisk) String

func (x *DataDisk) String() string

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"`
	// Optional. Idempotent request UUID.
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,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) GetRequestId

func (x *DeleteInstanceRequest) GetRequestId() 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

DiagnoseInstanceRequest

type DiagnoseInstanceRequest struct {

	// Required. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Defines flags that are used to run the diagnostic tool
	DiagnosticConfig *DiagnosticConfig `protobuf:"bytes,2,opt,name=diagnostic_config,json=diagnosticConfig,proto3" json:"diagnostic_config,omitempty"`
	// Optional. Maxmium amount of time in minutes before the operation times out.
	TimeoutMinutes int32 `protobuf:"varint,3,opt,name=timeout_minutes,json=timeoutMinutes,proto3" json:"timeout_minutes,omitempty"`
	// contains filtered or unexported fields
}

Request for creating a notebook instance diagnostic file.

func (*DiagnoseInstanceRequest) Descriptor

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

Deprecated: Use DiagnoseInstanceRequest.ProtoReflect.Descriptor instead.

func (*DiagnoseInstanceRequest) GetDiagnosticConfig

func (x *DiagnoseInstanceRequest) GetDiagnosticConfig() *DiagnosticConfig

func (*DiagnoseInstanceRequest) GetName

func (x *DiagnoseInstanceRequest) GetName() string

func (*DiagnoseInstanceRequest) GetTimeoutMinutes

func (x *DiagnoseInstanceRequest) GetTimeoutMinutes() int32

func (*DiagnoseInstanceRequest) ProtoMessage

func (*DiagnoseInstanceRequest) ProtoMessage()

func (*DiagnoseInstanceRequest) ProtoReflect

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

func (*DiagnoseInstanceRequest) Reset

func (x *DiagnoseInstanceRequest) Reset()

func (*DiagnoseInstanceRequest) String

func (x *DiagnoseInstanceRequest) String() string

DiagnosticConfig

type DiagnosticConfig struct {

	// Required. User Cloud Storage bucket location (REQUIRED).
	// Must be formatted with path prefix (`gs://$GCS_BUCKET`).
	//
	// Permissions:
	// User Managed Notebooks:
	//   - storage.buckets.writer: Must be given to the project's service account
	//     attached to VM.
	//
	// Google Managed Notebooks:
	//   - storage.buckets.writer: Must be given to the project's service account or
	//     user credentials attached to VM depending on authentication mode.
	//
	// Cloud Storage bucket Log file will be written to
	// `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
	GcsBucket string `protobuf:"bytes,1,opt,name=gcs_bucket,json=gcsBucket,proto3" json:"gcs_bucket,omitempty"`
	// Optional. Defines the relative storage path in the Cloud Storage bucket
	// where the diagnostic logs will be written: Default path will be the root
	// directory of the Cloud Storage bucket
	// (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file
	// will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
	RelativePath string `protobuf:"bytes,2,opt,name=relative_path,json=relativePath,proto3" json:"relative_path,omitempty"`
	// Optional. Enables flag to repair service for instance
	EnableRepairFlag bool `protobuf:"varint,3,opt,name=enable_repair_flag,json=enableRepairFlag,proto3" json:"enable_repair_flag,omitempty"`
	// Optional. Enables flag to capture packets from the instance for 30 seconds
	EnablePacketCaptureFlag bool `protobuf:"varint,4,opt,name=enable_packet_capture_flag,json=enablePacketCaptureFlag,proto3" json:"enable_packet_capture_flag,omitempty"`
	// Optional. Enables flag to copy all `/home/jupyter` folder contents
	EnableCopyHomeFilesFlag bool `protobuf:"varint,5,opt,name=enable_copy_home_files_flag,json=enableCopyHomeFilesFlag,proto3" json:"enable_copy_home_files_flag,omitempty"`
	// contains filtered or unexported fields
}

Defines flags that are used to run the diagnostic tool

func (*DiagnosticConfig) Descriptor

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

Deprecated: Use DiagnosticConfig.ProtoReflect.Descriptor instead.

func (*DiagnosticConfig) GetEnableCopyHomeFilesFlag

func (x *DiagnosticConfig) GetEnableCopyHomeFilesFlag() bool

func (*DiagnosticConfig) GetEnablePacketCaptureFlag

func (x *DiagnosticConfig) GetEnablePacketCaptureFlag() bool

func (*DiagnosticConfig) GetEnableRepairFlag

func (x *DiagnosticConfig) GetEnableRepairFlag() bool

func (*DiagnosticConfig) GetGcsBucket

func (x *DiagnosticConfig) GetGcsBucket() string

func (*DiagnosticConfig) GetRelativePath

func (x *DiagnosticConfig) GetRelativePath() string

func (*DiagnosticConfig) ProtoMessage

func (*DiagnosticConfig) ProtoMessage()

func (*DiagnosticConfig) ProtoReflect

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

func (*DiagnosticConfig) Reset

func (x *DiagnosticConfig) Reset()

func (*DiagnosticConfig) String

func (x *DiagnosticConfig) String() string

DiskEncryption

type DiskEncryption int32

Definition of the disk encryption options.

DiskEncryption_DISK_ENCRYPTION_UNSPECIFIED, DiskEncryption_GMEK, DiskEncryption_CMEK

const (
	// Disk encryption is not specified.
	DiskEncryption_DISK_ENCRYPTION_UNSPECIFIED DiskEncryption = 0
	// Use Google managed encryption keys to encrypt the boot disk.
	DiskEncryption_GMEK DiskEncryption = 1
	// Use customer managed encryption keys to encrypt the boot disk.
	DiskEncryption_CMEK DiskEncryption = 2
)

func (DiskEncryption) Descriptor

func (DiskEncryption) Descriptor() protoreflect.EnumDescriptor

func (DiskEncryption) Enum

func (x DiskEncryption) Enum() *DiskEncryption

func (DiskEncryption) EnumDescriptor

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

Deprecated: Use DiskEncryption.Descriptor instead.

func (DiskEncryption) Number

func (x DiskEncryption) Number() protoreflect.EnumNumber

func (DiskEncryption) String

func (x DiskEncryption) String() string

func (DiskEncryption) Type

func (DiskEncryption) Type() protoreflect.EnumType

DiskType

type DiskType int32

Possible disk types.

DiskType_DISK_TYPE_UNSPECIFIED, DiskType_PD_STANDARD, DiskType_PD_SSD, DiskType_PD_BALANCED, DiskType_PD_EXTREME

const (
	// Disk type not set.
	DiskType_DISK_TYPE_UNSPECIFIED DiskType = 0
	// Standard persistent disk type.
	DiskType_PD_STANDARD DiskType = 1
	// SSD persistent disk type.
	DiskType_PD_SSD DiskType = 2
	// Balanced persistent disk type.
	DiskType_PD_BALANCED DiskType = 3
	// Extreme persistent disk type.
	DiskType_PD_EXTREME DiskType = 4
)

func (DiskType) Descriptor

func (DiskType) Descriptor() protoreflect.EnumDescriptor

func (DiskType) Enum

func (x DiskType) Enum() *DiskType

func (DiskType) EnumDescriptor

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

Deprecated: Use DiskType.Descriptor instead.

func (DiskType) Number

func (x DiskType) Number() protoreflect.EnumNumber

func (DiskType) String

func (x DiskType) String() string

func (DiskType) Type

func (DiskType) Type() protoreflect.EnumType

Event

type Event struct {

	// Optional. Event report time.
	ReportTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`
	// Optional. Event type.
	Type Event_EventType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v2.Event_EventType" json:"type,omitempty"`
	// Optional. Event details. This field is used to pass event information.
	Details map[string]string `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

The definition of an Event for a managed / semi-managed notebook instance.

func (*Event) Descriptor

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetDetails

func (x *Event) GetDetails() map[string]string

func (*Event) GetReportTime

func (x *Event) GetReportTime() *timestamppb.Timestamp

func (*Event) GetType

func (x *Event) GetType() Event_EventType

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

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

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

Event_EventType

type Event_EventType int32

The definition of the event types.

Event_EVENT_TYPE_UNSPECIFIED, Event_IDLE, Event_HEARTBEAT, Event_HEALTH, Event_MAINTENANCE, Event_METADATA_CHANGE

const (
	// Event is not specified.
	Event_EVENT_TYPE_UNSPECIFIED Event_EventType = 0
	// The instance / runtime is idle
	Event_IDLE Event_EventType = 1
	// The instance / runtime is available.
	// This event indicates that instance / runtime underlying compute is
	// operational.
	Event_HEARTBEAT Event_EventType = 2
	// The instance / runtime health is available.
	// This event indicates that instance / runtime health information.
	Event_HEALTH Event_EventType = 3
	// The instance / runtime is available.
	// This event allows instance / runtime to send Host maintenance
	// information to Control Plane.
	// https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
	Event_MAINTENANCE Event_EventType = 4
	// The instance / runtime is available.
	// This event indicates that the instance had metadata that needs to be
	// modified.
	Event_METADATA_CHANGE Event_EventType = 5
)

func (Event_EventType) Descriptor

func (Event_EventType) Descriptor() protoreflect.EnumDescriptor

func (Event_EventType) Enum

func (x Event_EventType) Enum() *Event_EventType

func (Event_EventType) EnumDescriptor

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

Deprecated: Use Event_EventType.Descriptor instead.

func (Event_EventType) Number

func (x Event_EventType) Number() protoreflect.EnumNumber

func (Event_EventType) String

func (x Event_EventType) String() string

func (Event_EventType) Type

func (Event_EventType) Type() protoreflect.EnumType

GPUDriverConfig

type GPUDriverConfig struct {

	// Optional. Whether the end user authorizes Google Cloud to install GPU
	// driver on this VM instance. If this field is empty or set to false, the GPU
	// driver won't be installed. Only applicable to instances with GPUs.
	EnableGpuDriver bool `protobuf:"varint,1,opt,name=enable_gpu_driver,json=enableGpuDriver,proto3" json:"enable_gpu_driver,omitempty"`
	// Optional. 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,2,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
	// contains filtered or unexported fields
}

A GPU driver configuration

func (*GPUDriverConfig) Descriptor

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

Deprecated: Use GPUDriverConfig.ProtoReflect.Descriptor instead.

func (*GPUDriverConfig) GetCustomGpuDriverPath

func (x *GPUDriverConfig) GetCustomGpuDriverPath() string

func (*GPUDriverConfig) GetEnableGpuDriver

func (x *GPUDriverConfig) GetEnableGpuDriver() bool

func (*GPUDriverConfig) ProtoMessage

func (*GPUDriverConfig) ProtoMessage()

func (*GPUDriverConfig) ProtoReflect

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

func (*GPUDriverConfig) Reset

func (x *GPUDriverConfig) Reset()

func (*GPUDriverConfig) String

func (x *GPUDriverConfig) String() string

GceSetup

type GceSetup struct {

	// Optional. The machine type of the VM instance.
	// https://cloud.google.com/compute/docs/machine-resource
	MachineType string `protobuf:"bytes,1,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// Optional. The hardware accelerators 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).
	// Currently supports only one accelerator configuration.
	AcceleratorConfigs []*AcceleratorConfig `protobuf:"bytes,2,rep,name=accelerator_configs,json=acceleratorConfigs,proto3" json:"accelerator_configs,omitempty"`
	// Optional. The service account that serves as an identity for the VM
	// instance. Currently supports only one service account.
	ServiceAccounts []*ServiceAccount `protobuf:"bytes,3,rep,name=service_accounts,json=serviceAccounts,proto3" json:"service_accounts,omitempty"`
	// Type of the image; can be one of VM image, or container image.
	//
	// Types that are assignable to Image:
	//
	//	*GceSetup_VmImage
	//	*GceSetup_ContainerImage
	Image isGceSetup_Image `protobuf_oneof:"image"`
	// Optional. The boot disk for the VM.
	BootDisk *BootDisk `protobuf:"bytes,6,opt,name=boot_disk,json=bootDisk,proto3" json:"boot_disk,omitempty"`
	// Optional. Data disks attached to the VM instance.
	// Currently supports only one data disk.
	DataDisks []*DataDisk `protobuf:"bytes,7,rep,name=data_disks,json=dataDisks,proto3" json:"data_disks,omitempty"`
	// Optional. Shielded VM configuration.
	// [Images using supported Shielded VM
	// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
	ShieldedInstanceConfig *ShieldedInstanceConfig `protobuf:"bytes,8,opt,name=shielded_instance_config,json=shieldedInstanceConfig,proto3" json:"shielded_instance_config,omitempty"`
	// Optional. The network interfaces for the VM.
	// Supports only one interface.
	NetworkInterfaces []*NetworkInterface `protobuf:"bytes,9,rep,name=network_interfaces,json=networkInterfaces,proto3" json:"network_interfaces,omitempty"`
	// Optional. If true, no external IP will be assigned to this VM instance.
	DisablePublicIp bool `protobuf:"varint,10,opt,name=disable_public_ip,json=disablePublicIp,proto3" json:"disable_public_ip,omitempty"`
	// Optional. The Compute Engine tags to add to runtime (see [Tagging
	// instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
	Tags []string `protobuf:"bytes,11,rep,name=tags,proto3" json:"tags,omitempty"`
	// Optional. Custom metadata to apply to this instance.
	Metadata map[string]string `protobuf:"bytes,12,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// Optional. Flag to enable ip forwarding or not, default false/off.
	// https://cloud.google.com/vpc/docs/using-routes#canipforward
	EnableIpForwarding bool `protobuf:"varint,13,opt,name=enable_ip_forwarding,json=enableIpForwarding,proto3" json:"enable_ip_forwarding,omitempty"`
	// Optional. Configuration for GPU drivers.
	GpuDriverConfig *GPUDriverConfig `protobuf:"bytes,14,opt,name=gpu_driver_config,json=gpuDriverConfig,proto3" json:"gpu_driver_config,omitempty"`
	// contains filtered or unexported fields
}

The definition of how to configure a VM instance outside of Resources and Identity.

func (*GceSetup) Descriptor

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

Deprecated: Use GceSetup.ProtoReflect.Descriptor instead.

func (*GceSetup) GetAcceleratorConfigs

func (x *GceSetup) GetAcceleratorConfigs() []*AcceleratorConfig

func (*GceSetup) GetBootDisk

func (x *GceSetup) GetBootDisk() *BootDisk

func (*GceSetup) GetContainerImage

func (x *GceSetup) GetContainerImage() *ContainerImage

func (*GceSetup) GetDataDisks

func (x *GceSetup) GetDataDisks() []*DataDisk

func (*GceSetup) GetDisablePublicIp

func (x *GceSetup) GetDisablePublicIp() bool

func (*GceSetup) GetEnableIpForwarding

func (x *GceSetup) GetEnableIpForwarding() bool

func (*GceSetup) GetGpuDriverConfig

func (x *GceSetup) GetGpuDriverConfig() *GPUDriverConfig

func (*GceSetup) GetImage

func (m *GceSetup) GetImage() isGceSetup_Image

func (*GceSetup) GetMachineType

func (x *GceSetup) GetMachineType() string

func (*GceSetup) GetMetadata

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

func (*GceSetup) GetNetworkInterfaces

func (x *GceSetup) GetNetworkInterfaces() []*NetworkInterface

func (*GceSetup) GetServiceAccounts

func (x *GceSetup) GetServiceAccounts() []*ServiceAccount

func (*GceSetup) GetShieldedInstanceConfig

func (x *GceSetup) GetShieldedInstanceConfig() *ShieldedInstanceConfig

func (*GceSetup) GetTags

func (x *GceSetup) GetTags() []string

func (*GceSetup) GetVmImage

func (x *GceSetup) GetVmImage() *VmImage

func (*GceSetup) ProtoMessage

func (*GceSetup) ProtoMessage()

func (*GceSetup) ProtoReflect

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

func (*GceSetup) Reset

func (x *GceSetup) Reset()

func (*GceSetup) String

func (x *GceSetup) String() string

GceSetup_ContainerImage

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

GceSetup_VmImage

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

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

HealthState

type HealthState int32

The instance health state.

HealthState_HEALTH_STATE_UNSPECIFIED, HealthState_HEALTHY, HealthState_UNHEALTHY, HealthState_AGENT_NOT_INSTALLED, HealthState_AGENT_NOT_RUNNING

const (
	// The instance substate is unknown.
	HealthState_HEALTH_STATE_UNSPECIFIED HealthState = 0
	// The instance is known to be in an healthy state
	// (for example, critical daemons are running)
	// Applies to ACTIVE state.
	HealthState_HEALTHY HealthState = 1
	// The instance is known to be in an unhealthy state
	// (for example, critical daemons are not running)
	// Applies to ACTIVE state.
	HealthState_UNHEALTHY HealthState = 2
	// The instance has not installed health monitoring agent.
	// Applies to ACTIVE state.
	HealthState_AGENT_NOT_INSTALLED HealthState = 3
	// The instance health monitoring agent is not running.
	// Applies to ACTIVE state.
	HealthState_AGENT_NOT_RUNNING HealthState = 4
)

func (HealthState) Descriptor

func (HealthState) Descriptor() protoreflect.EnumDescriptor

func (HealthState) Enum

func (x HealthState) Enum() *HealthState

func (HealthState) EnumDescriptor

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

Deprecated: Use HealthState.Descriptor instead.

func (HealthState) Number

func (x HealthState) Number() protoreflect.EnumNumber

func (HealthState) String

func (x HealthState) String() string

func (HealthState) Type

func (HealthState) Type() protoreflect.EnumType

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"`
	// Setup for the Notebook instance.
	//
	// Types that are assignable to Infrastructure:
	//
	//	*Instance_GceSetup
	Infrastructure isInstance_Infrastructure `protobuf_oneof:"infrastructure"`
	// Output only. The proxy endpoint that is used to access the Jupyter
	// notebook.
	ProxyUri string `protobuf:"bytes,3,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
	// Optional. 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,4,rep,name=instance_owners,json=instanceOwners,proto3" json:"instance_owners,omitempty"`
	// Output only. Email address of entity that sent original CreateInstance
	// request.
	Creator string `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`
	// Output only. The state of this instance.
	State State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.notebooks.v2.State" json:"state,omitempty"`
	// Output only. The upgrade history of this instance.
	UpgradeHistory []*UpgradeHistoryEntry `protobuf:"bytes,7,rep,name=upgrade_history,json=upgradeHistory,proto3" json:"upgrade_history,omitempty"`
	// Output only. Unique ID of the resource.
	Id string `protobuf:"bytes,8,opt,name=id,proto3" json:"id,omitempty"`
	// Output only. Instance health_state.
	HealthState HealthState `protobuf:"varint,9,opt,name=health_state,json=healthState,proto3,enum=google.cloud.notebooks.v2.HealthState" json:"health_state,omitempty"`
	// Output only. Additional information about instance health.
	// Example:
	//
	//	healthInfo": {
	//	  "docker_proxy_agent_status": "1",
	//	  "docker_status": "1",
	//	  "jupyterlab_api_status": "-1",
	//	  "jupyterlab_status": "-1",
	//	  "updated": "2020-10-18 09:40:03.573409"
	//	}
	HealthInfo map[string]string `protobuf:"bytes,10,rep,name=health_info,json=healthInfo,proto3" json:"health_info,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// Output only. Instance creation time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Instance update time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. If true, the notebook instance will not register with the proxy.
	DisableProxyAccess bool `protobuf:"varint,13,opt,name=disable_proxy_access,json=disableProxyAccess,proto3" json:"disable_proxy_access,omitempty"`
	// Optional. Labels to apply to this instance.
	// These can be later modified by the UpdateInstance method.
	Labels map[string]string `protobuf:"bytes,14,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// 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) GetCreateTime

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

func (*Instance) GetCreator

func (x *Instance) GetCreator() string

func (*Instance) GetDisableProxyAccess

func (x *Instance) GetDisableProxyAccess() bool

func (*Instance) GetGceSetup

func (x *Instance) GetGceSetup() *GceSetup

func (*Instance) GetHealthInfo

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

func (*Instance) GetHealthState

func (x *Instance) GetHealthState() HealthState

func (*Instance) GetId

func (x *Instance) GetId() string

func (*Instance) GetInfrastructure

func (m *Instance) GetInfrastructure() isInstance_Infrastructure

func (*Instance) GetInstanceOwners

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

func (*Instance) GetLabels

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

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetProxyUri

func (x *Instance) GetProxyUri() string

func (*Instance) GetState

func (x *Instance) GetState() State

func (*Instance) GetUpdateTime

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

func (*Instance) GetUpgradeHistory

func (x *Instance) GetUpgradeHistory() []*UpgradeHistoryEntry

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

Instance_GceSetup

type Instance_GceSetup struct {
	// Optional. Compute Engine setup for the notebook. Uses notebook-defined
	// fields.
	GceSetup *GceSetup `protobuf:"bytes,2,opt,name=gce_setup,json=gceSetup,proto3,oneof"`
}

ListInstancesRequest

type ListInstancesRequest struct {

	// Required. Format:
	// `parent=projects/{project_id}/locations/{location}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum return size of the list call.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. 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"`
	// Optional. Sort results. Supported values are "name", "name desc" or ""
	// (unsorted).
	OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Optional. List filter.
	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,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) GetFilter

func (x *ListInstancesRequest) GetFilter() string

func (*ListInstancesRequest) GetOrderBy

func (x *ListInstancesRequest) GetOrderBy() string

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

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

NetworkInterface

type NetworkInterface struct {

	// Optional. The name of the VPC that this VM instance is in.
	// Format:
	// `projects/{project_id}/global/networks/{network_id}`
	Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
	// Optional. The name of the subnet that this VM instance is in.
	// Format:
	// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
	Subnet string `protobuf:"bytes,2,opt,name=subnet,proto3" json:"subnet,omitempty"`
	// Optional. The type of vNIC to be used on this interface. This may be gVNIC
	// or VirtioNet.
	NicType NetworkInterface_NicType `protobuf:"varint,3,opt,name=nic_type,json=nicType,proto3,enum=google.cloud.notebooks.v2.NetworkInterface_NicType" json:"nic_type,omitempty"`
	// contains filtered or unexported fields
}

The definition of a network interface resource attached to a VM.

func (*NetworkInterface) Descriptor

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

Deprecated: Use NetworkInterface.ProtoReflect.Descriptor instead.

func (*NetworkInterface) GetNetwork

func (x *NetworkInterface) GetNetwork() string

func (*NetworkInterface) GetNicType

func (x *NetworkInterface) GetNicType() NetworkInterface_NicType

func (*NetworkInterface) GetSubnet

func (x *NetworkInterface) GetSubnet() string

func (*NetworkInterface) ProtoMessage

func (*NetworkInterface) ProtoMessage()

func (*NetworkInterface) ProtoReflect

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

func (*NetworkInterface) Reset

func (x *NetworkInterface) Reset()

func (*NetworkInterface) String

func (x *NetworkInterface) String() string

NetworkInterface_NicType

type NetworkInterface_NicType int32

The type of vNIC driver. Default should be NIC_TYPE_UNSPECIFIED.

NetworkInterface_NIC_TYPE_UNSPECIFIED, NetworkInterface_VIRTIO_NET, NetworkInterface_GVNIC

const (
	// No type specified.
	NetworkInterface_NIC_TYPE_UNSPECIFIED NetworkInterface_NicType = 0
	// VIRTIO
	NetworkInterface_VIRTIO_NET NetworkInterface_NicType = 1
	// GVNIC
	NetworkInterface_GVNIC NetworkInterface_NicType = 2
)

func (NetworkInterface_NicType) Descriptor

func (NetworkInterface_NicType) Descriptor() protoreflect.EnumDescriptor

func (NetworkInterface_NicType) Enum

func (x NetworkInterface_NicType) Enum() *NetworkInterface_NicType

func (NetworkInterface_NicType) EnumDescriptor

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

Deprecated: Use NetworkInterface_NicType.Descriptor instead.

func (NetworkInterface_NicType) Number

func (x NetworkInterface_NicType) Number() protoreflect.EnumNumber

func (NetworkInterface_NicType) String

func (x NetworkInterface_NicType) String() string

func (NetworkInterface_NicType) Type

func (NetworkInterface_NicType) Type() protoreflect.EnumType

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) (*longrunningpb.Operation, error)
	// UpdateInstance updates an Instance.
	UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Starts a notebook instance.
	StartInstance(ctx context.Context, in *StartInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Stops a notebook instance.
	StopInstance(ctx context.Context, in *StopInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Resets a notebook instance.
	ResetInstance(ctx context.Context, in *ResetInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Checks whether a notebook instance is upgradable.
	CheckInstanceUpgradability(ctx context.Context, in *CheckInstanceUpgradabilityRequest, opts ...grpc.CallOption) (*CheckInstanceUpgradabilityResponse, error)
	// Upgrades a notebook instance to the latest version.
	UpgradeInstance(ctx context.Context, in *UpgradeInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Rollbacks a notebook instance to the previous version.
	RollbackInstance(ctx context.Context, in *RollbackInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
	DiagnoseInstance(ctx context.Context, in *DiagnoseInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.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.

func NewNotebookServiceClient

func NewNotebookServiceClient(cc grpc.ClientConnInterface) NotebookServiceClient

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) (*longrunningpb.Operation, error)
	// UpdateInstance updates an Instance.
	UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)
	// Starts a notebook instance.
	StartInstance(context.Context, *StartInstanceRequest) (*longrunningpb.Operation, error)
	// Stops a notebook instance.
	StopInstance(context.Context, *StopInstanceRequest) (*longrunningpb.Operation, error)
	// Resets a notebook instance.
	ResetInstance(context.Context, *ResetInstanceRequest) (*longrunningpb.Operation, error)
	// Checks whether a notebook instance is upgradable.
	CheckInstanceUpgradability(context.Context, *CheckInstanceUpgradabilityRequest) (*CheckInstanceUpgradabilityResponse, error)
	// Upgrades a notebook instance to the latest version.
	UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunningpb.Operation, error)
	// Rollbacks a notebook instance to the previous version.
	RollbackInstance(context.Context, *RollbackInstanceRequest) (*longrunningpb.Operation, error)
	// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
	DiagnoseInstance(context.Context, *DiagnoseInstanceRequest) (*longrunningpb.Operation, error)
}

NotebookServiceServer is the server API for NotebookService service.

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

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 resetting 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

RollbackInstanceRequest

type RollbackInstanceRequest 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 snapshot for rollback.
	// Example: "projects/test-project/global/snapshots/krwlzipynril".
	TargetSnapshot string `protobuf:"bytes,2,opt,name=target_snapshot,json=targetSnapshot,proto3" json:"target_snapshot,omitempty"`
	// Required. Output only. Revision Id
	RevisionId string `protobuf:"bytes,3,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// contains filtered or unexported fields
}

Request for rollbacking a notebook instance

func (*RollbackInstanceRequest) Descriptor

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

Deprecated: Use RollbackInstanceRequest.ProtoReflect.Descriptor instead.

func (*RollbackInstanceRequest) GetName

func (x *RollbackInstanceRequest) GetName() string

func (*RollbackInstanceRequest) GetRevisionId

func (x *RollbackInstanceRequest) GetRevisionId() string

func (*RollbackInstanceRequest) GetTargetSnapshot

func (x *RollbackInstanceRequest) GetTargetSnapshot() string

func (*RollbackInstanceRequest) ProtoMessage

func (*RollbackInstanceRequest) ProtoMessage()

func (*RollbackInstanceRequest) ProtoReflect

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

func (*RollbackInstanceRequest) Reset

func (x *RollbackInstanceRequest) Reset()

func (*RollbackInstanceRequest) String

func (x *RollbackInstanceRequest) String() string

ServiceAccount

type ServiceAccount struct {

	// Optional. Email address of the service account.
	Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	// Output only. The list of scopes to be made available for this service
	// account. Set by the CLH to https://www.googleapis.com/auth/cloud-platform
	Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// contains filtered or unexported fields
}

A service account that acts as an identity.

func (*ServiceAccount) Descriptor

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

Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.

func (*ServiceAccount) GetEmail

func (x *ServiceAccount) GetEmail() string

func (*ServiceAccount) GetScopes

func (x *ServiceAccount) GetScopes() []string

func (*ServiceAccount) ProtoMessage

func (*ServiceAccount) ProtoMessage()

func (*ServiceAccount) ProtoReflect

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

func (*ServiceAccount) Reset

func (x *ServiceAccount) Reset()

func (*ServiceAccount) String

func (x *ServiceAccount) String() string

ShieldedInstanceConfig

type ShieldedInstanceConfig struct {

	// Optional. Defines whether the VM instance has Secure Boot enabled.
	//
	// Secure Boot helps ensure that the system only runs authentic software by
	// verifying the digital signature of all boot components, and halting the
	// boot process if signature verification fails. Disabled by default.
	EnableSecureBoot bool `protobuf:"varint,1,opt,name=enable_secure_boot,json=enableSecureBoot,proto3" json:"enable_secure_boot,omitempty"`
	// Optional. Defines whether the VM instance has the vTPM enabled. Enabled by
	// default.
	EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
	// Optional. Defines whether the VM instance has integrity monitoring enabled.
	//
	// Enables monitoring and attestation of the boot integrity of the VM
	// instance. The attestation is performed against the integrity policy
	// baseline. This baseline is initially derived from the implicitly trusted
	// boot image when the VM instance is created. Enabled by default.
	EnableIntegrityMonitoring bool `protobuf:"varint,3,opt,name=enable_integrity_monitoring,json=enableIntegrityMonitoring,proto3" json:"enable_integrity_monitoring,omitempty"`
	// contains filtered or unexported fields
}

A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.

func (*ShieldedInstanceConfig) Descriptor

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

Deprecated: Use ShieldedInstanceConfig.ProtoReflect.Descriptor instead.

func (*ShieldedInstanceConfig) GetEnableIntegrityMonitoring

func (x *ShieldedInstanceConfig) GetEnableIntegrityMonitoring() bool

func (*ShieldedInstanceConfig) GetEnableSecureBoot

func (x *ShieldedInstanceConfig) GetEnableSecureBoot() bool

func (*ShieldedInstanceConfig) GetEnableVtpm

func (x *ShieldedInstanceConfig) GetEnableVtpm() bool

func (*ShieldedInstanceConfig) ProtoMessage

func (*ShieldedInstanceConfig) ProtoMessage()

func (*ShieldedInstanceConfig) ProtoReflect

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

func (*ShieldedInstanceConfig) Reset

func (x *ShieldedInstanceConfig) Reset()

func (*ShieldedInstanceConfig) String

func (x *ShieldedInstanceConfig) String() string

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

State

type State int32

The definition of the states of this instance.

State_STATE_UNSPECIFIED, State_STARTING, State_PROVISIONING, State_ACTIVE, State_STOPPING, State_STOPPED, State_DELETED, State_UPGRADING, State_INITIALIZING, State_SUSPENDING, State_SUSPENDED

const (
	// State is not specified.
	State_STATE_UNSPECIFIED State = 0
	// The control logic is starting the instance.
	State_STARTING State = 1
	// The control logic is installing required frameworks and registering the
	// instance with notebook proxy
	State_PROVISIONING State = 2
	// The instance is running.
	State_ACTIVE State = 3
	// The control logic is stopping the instance.
	State_STOPPING State = 4
	// The instance is stopped.
	State_STOPPED State = 5
	// The instance is deleted.
	State_DELETED State = 6
	// The instance is upgrading.
	State_UPGRADING State = 7
	// The instance is being created.
	State_INITIALIZING State = 8
	// The instance is suspending.
	State_SUSPENDING State = 9
	// The instance is suspended.
	State_SUSPENDED State = 10
)

func (State) Descriptor

func (State) Descriptor() protoreflect.EnumDescriptor

func (State) Enum

func (x State) Enum() *State

func (State) EnumDescriptor

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

Deprecated: Use State.Descriptor instead.

func (State) Number

func (x State) Number() protoreflect.EnumNumber

func (State) String

func (x State) String() string

func (State) Type

func (State) Type() protoreflect.EnumType

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

UnimplementedNotebookServiceServer

type UnimplementedNotebookServiceServer struct {
}

UnimplementedNotebookServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNotebookServiceServer) CheckInstanceUpgradability

func (*UnimplementedNotebookServiceServer) CheckInstanceUpgradability(context.Context, *CheckInstanceUpgradabilityRequest) (*CheckInstanceUpgradabilityResponse, error)

func (*UnimplementedNotebookServiceServer) CreateInstance

func (*UnimplementedNotebookServiceServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) DeleteInstance

func (*UnimplementedNotebookServiceServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) DiagnoseInstance

func (*UnimplementedNotebookServiceServer) DiagnoseInstance(context.Context, *DiagnoseInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) GetInstance

func (*UnimplementedNotebookServiceServer) GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)

func (*UnimplementedNotebookServiceServer) ListInstances

func (*UnimplementedNotebookServiceServer) ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)

func (*UnimplementedNotebookServiceServer) ResetInstance

func (*UnimplementedNotebookServiceServer) ResetInstance(context.Context, *ResetInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) RollbackInstance

func (*UnimplementedNotebookServiceServer) RollbackInstance(context.Context, *RollbackInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) StartInstance

func (*UnimplementedNotebookServiceServer) StartInstance(context.Context, *StartInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) StopInstance

func (*UnimplementedNotebookServiceServer) StopInstance(context.Context, *StopInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) UpdateInstance

func (*UnimplementedNotebookServiceServer) UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedNotebookServiceServer) UpgradeInstance

func (*UnimplementedNotebookServiceServer) UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunningpb.Operation, error)

UpdateInstanceRequest

type UpdateInstanceRequest struct {

	// Required. A representation of an instance.
	Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// Required. Mask used to update an instance
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Optional. Idempotent request UUID.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request for updating a notebook instance.

func (*UpdateInstanceRequest) Descriptor

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

Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.

func (*UpdateInstanceRequest) GetInstance

func (x *UpdateInstanceRequest) GetInstance() *Instance

func (*UpdateInstanceRequest) GetRequestId

func (x *UpdateInstanceRequest) GetRequestId() string

func (*UpdateInstanceRequest) GetUpdateMask

func (x *UpdateInstanceRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateInstanceRequest) ProtoMessage

func (*UpdateInstanceRequest) ProtoMessage()

func (*UpdateInstanceRequest) ProtoReflect

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

func (*UpdateInstanceRequest) Reset

func (x *UpdateInstanceRequest) Reset()

func (*UpdateInstanceRequest) String

func (x *UpdateInstanceRequest) String() string

UpgradeHistoryEntry

type UpgradeHistoryEntry struct {

	// Optional. The snapshot of the boot disk of this notebook instance before
	// upgrade.
	Snapshot string `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
	// Optional. The VM image before this instance upgrade.
	VmImage string `protobuf:"bytes,2,opt,name=vm_image,json=vmImage,proto3" json:"vm_image,omitempty"`
	// Optional. The container image before this instance upgrade.
	ContainerImage string `protobuf:"bytes,3,opt,name=container_image,json=containerImage,proto3" json:"container_image,omitempty"`
	// Optional. The framework of this notebook instance.
	Framework string `protobuf:"bytes,4,opt,name=framework,proto3" json:"framework,omitempty"`
	// Optional. The version of the notebook instance before this upgrade.
	Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
	// Output only. The state of this instance upgrade history entry.
	State UpgradeHistoryEntry_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.notebooks.v2.UpgradeHistoryEntry_State" json:"state,omitempty"`
	// Immutable. The time that this instance upgrade history entry is created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Optional. Action. Rolloback or Upgrade.
	Action UpgradeHistoryEntry_Action `protobuf:"varint,8,opt,name=action,proto3,enum=google.cloud.notebooks.v2.UpgradeHistoryEntry_Action" json:"action,omitempty"`
	// Optional. Target VM Version, like m63.
	TargetVersion string `protobuf:"bytes,9,opt,name=target_version,json=targetVersion,proto3" json:"target_version,omitempty"`
	// contains filtered or unexported fields
}

The entry of VM image upgrade history.

func (*UpgradeHistoryEntry) Descriptor

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

Deprecated: Use UpgradeHistoryEntry.ProtoReflect.Descriptor instead.

func (*UpgradeHistoryEntry) GetAction

func (x *UpgradeHistoryEntry) GetAction() UpgradeHistoryEntry_Action

func (*UpgradeHistoryEntry) GetContainerImage

func (x *UpgradeHistoryEntry) GetContainerImage() string

func (*UpgradeHistoryEntry) GetCreateTime

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

func (*UpgradeHistoryEntry) GetFramework

func (x *UpgradeHistoryEntry) GetFramework() string

func (*UpgradeHistoryEntry) GetSnapshot

func (x *UpgradeHistoryEntry) GetSnapshot() string

func (*UpgradeHistoryEntry) GetState

func (x *UpgradeHistoryEntry) GetState() UpgradeHistoryEntry_State

func (*UpgradeHistoryEntry) GetTargetVersion

func (x *UpgradeHistoryEntry) GetTargetVersion() string

func (*UpgradeHistoryEntry) GetVersion

func (x *UpgradeHistoryEntry) GetVersion() string

func (*UpgradeHistoryEntry) GetVmImage

func (x *UpgradeHistoryEntry) GetVmImage() string

func (*UpgradeHistoryEntry) ProtoMessage

func (*UpgradeHistoryEntry) ProtoMessage()

func (*UpgradeHistoryEntry) ProtoReflect

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

func (*UpgradeHistoryEntry) Reset

func (x *UpgradeHistoryEntry) Reset()

func (*UpgradeHistoryEntry) String

func (x *UpgradeHistoryEntry) String() string

UpgradeHistoryEntry_Action

type UpgradeHistoryEntry_Action int32

The definition of operations of this upgrade history entry.

UpgradeHistoryEntry_ACTION_UNSPECIFIED, UpgradeHistoryEntry_UPGRADE, UpgradeHistoryEntry_ROLLBACK

const (
	// Operation is not specified.
	UpgradeHistoryEntry_ACTION_UNSPECIFIED UpgradeHistoryEntry_Action = 0
	// Upgrade.
	UpgradeHistoryEntry_UPGRADE UpgradeHistoryEntry_Action = 1
	// Rollback.
	UpgradeHistoryEntry_ROLLBACK UpgradeHistoryEntry_Action = 2
)

func (UpgradeHistoryEntry_Action) Descriptor

func (UpgradeHistoryEntry_Action) Descriptor() protoreflect.EnumDescriptor

func (UpgradeHistoryEntry_Action) Enum

func (x UpgradeHistoryEntry_Action) Enum() *UpgradeHistoryEntry_Action

func (UpgradeHistoryEntry_Action) EnumDescriptor

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

Deprecated: Use UpgradeHistoryEntry_Action.Descriptor instead.

func (UpgradeHistoryEntry_Action) Number

func (x UpgradeHistoryEntry_Action) Number() protoreflect.EnumNumber

func (UpgradeHistoryEntry_Action) String

func (x UpgradeHistoryEntry_Action) String() string

func (UpgradeHistoryEntry_Action) Type

func (UpgradeHistoryEntry_Action) Type() protoreflect.EnumType

UpgradeHistoryEntry_State

type UpgradeHistoryEntry_State int32

The definition of the states of this upgrade history entry.

UpgradeHistoryEntry_STATE_UNSPECIFIED, UpgradeHistoryEntry_STARTED, UpgradeHistoryEntry_SUCCEEDED, UpgradeHistoryEntry_FAILED

const (
	// State is not specified.
	UpgradeHistoryEntry_STATE_UNSPECIFIED UpgradeHistoryEntry_State = 0
	// The instance upgrade is started.
	UpgradeHistoryEntry_STARTED UpgradeHistoryEntry_State = 1
	// The instance upgrade is succeeded.
	UpgradeHistoryEntry_SUCCEEDED UpgradeHistoryEntry_State = 2
	// The instance upgrade is failed.
	UpgradeHistoryEntry_FAILED UpgradeHistoryEntry_State = 3
)

func (UpgradeHistoryEntry_State) Descriptor

func (UpgradeHistoryEntry_State) Descriptor() protoreflect.EnumDescriptor

func (UpgradeHistoryEntry_State) Enum

func (x UpgradeHistoryEntry_State) Enum() *UpgradeHistoryEntry_State

func (UpgradeHistoryEntry_State) EnumDescriptor

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

Deprecated: Use UpgradeHistoryEntry_State.Descriptor instead.

func (UpgradeHistoryEntry_State) Number

func (x UpgradeHistoryEntry_State) Number() protoreflect.EnumNumber

func (UpgradeHistoryEntry_State) String

func (x UpgradeHistoryEntry_State) String() string

func (UpgradeHistoryEntry_State) Type

func (UpgradeHistoryEntry_State) Type() protoreflect.EnumType

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

VmImage

type VmImage struct {

	// Required. The name of the Google Cloud project that this VM image belongs
	// to. Format: `{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_Name
	//	*VmImage_Family
	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) GetFamily

func (x *VmImage) GetFamily() string

func (*VmImage) GetImage

func (m *VmImage) GetImage() isVmImage_Image

func (*VmImage) GetName

func (x *VmImage) GetName() 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

VmImage_Family

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

VmImage_Name

type VmImage_Name struct {
	// Optional. Use VM image name to find the image.
	Name string `protobuf:"bytes,2,opt,name=name,proto3,oneof"`
}