notebooksv1

package
v1.36.11-2024050211440... Latest Latest
Warning

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

Go to latest
Published: unknown License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const Environment_ContainerImage_case case_Environment_ImageType = 7
View Source
const Environment_ImageType_not_set_case case_Environment_ImageType = 0
View Source
const Environment_VmImage_case case_Environment_ImageType = 6
View Source
const ExecutionTemplate_DataprocParameters_case case_ExecutionTemplate_JobParameters = 12
View Source
const ExecutionTemplate_JobParameters_not_set_case case_ExecutionTemplate_JobParameters = 0
View Source
const ExecutionTemplate_VertexAiParameters_case case_ExecutionTemplate_JobParameters = 13
View Source
const Instance_ContainerImage_case case_Instance_Environment = 3
View Source
const Instance_Environment_not_set_case case_Instance_Environment = 0
View Source
const Instance_VmImage_case case_Instance_Environment = 2
View Source
const Runtime_RuntimeType_not_set_case case_Runtime_RuntimeType = 0
View Source
const Runtime_VirtualMachine_case case_Runtime_RuntimeType = 2
View Source
const VmImage_ImageFamily_case case_VmImage_Image = 3
View Source
const VmImage_ImageName_case case_VmImage_Image = 2
View Source
const VmImage_Image_not_set_case case_VmImage_Image = 0

Variables

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

Enum value maps for Runtime_State.

View Source
var (
	Runtime_HealthState_name = map[int32]string{
		0: "HEALTH_STATE_UNSPECIFIED",
		1: "HEALTHY",
		2: "UNHEALTHY",
		3: "AGENT_NOT_INSTALLED",
		4: "AGENT_NOT_RUNNING",
	}
	Runtime_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 Runtime_HealthState.

View Source
var (
	RuntimeAcceleratorConfig_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",
		6:  "NVIDIA_TESLA_A100",
		7:  "TPU_V2",
		8:  "TPU_V3",
		9:  "NVIDIA_TESLA_T4_VWS",
		10: "NVIDIA_TESLA_P100_VWS",
		11: "NVIDIA_TESLA_P4_VWS",
	}
	RuntimeAcceleratorConfig_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_A100":            6,
		"TPU_V2":                       7,
		"TPU_V3":                       8,
		"NVIDIA_TESLA_T4_VWS":          9,
		"NVIDIA_TESLA_P100_VWS":        10,
		"NVIDIA_TESLA_P4_VWS":          11,
	}
)

Enum value maps for RuntimeAcceleratorConfig_AcceleratorType.

View Source
var (
	LocalDiskInitializeParams_DiskType_name = map[int32]string{
		0: "DISK_TYPE_UNSPECIFIED",
		1: "PD_STANDARD",
		2: "PD_SSD",
		3: "PD_BALANCED",
		4: "PD_EXTREME",
	}
	LocalDiskInitializeParams_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 LocalDiskInitializeParams_DiskType.

View Source
var (
	RuntimeAccessConfig_RuntimeAccessType_name = map[int32]string{
		0: "RUNTIME_ACCESS_TYPE_UNSPECIFIED",
		1: "SINGLE_USER",
		2: "SERVICE_ACCOUNT",
	}
	RuntimeAccessConfig_RuntimeAccessType_value = map[string]int32{
		"RUNTIME_ACCESS_TYPE_UNSPECIFIED": 0,
		"SINGLE_USER":                     1,
		"SERVICE_ACCOUNT":                 2,
	}
)

Enum value maps for RuntimeAccessConfig_RuntimeAccessType.

View Source
var (
	RuntimeSoftwareConfig_PostStartupScriptBehavior_name = map[int32]string{
		0: "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED",
		1: "RUN_EVERY_START",
		2: "DOWNLOAD_AND_RUN_EVERY_START",
	}
	RuntimeSoftwareConfig_PostStartupScriptBehavior_value = map[string]int32{
		"POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED": 0,
		"RUN_EVERY_START":                          1,
		"DOWNLOAD_AND_RUN_EVERY_START":             2,
	}
)

Enum value maps for RuntimeSoftwareConfig_PostStartupScriptBehavior.

View Source
var (
	VirtualMachineConfig_NicType_name = map[int32]string{
		0: "UNSPECIFIED_NIC_TYPE",
		1: "VIRTIO_NET",
		2: "GVNIC",
	}
	VirtualMachineConfig_NicType_value = map[string]int32{
		"UNSPECIFIED_NIC_TYPE": 0,
		"VIRTIO_NET":           1,
		"GVNIC":                2,
	}
)

Enum value maps for VirtualMachineConfig_NicType.

View Source
var (
	ExecutionTemplate_ScaleTier_name = map[int32]string{
		0: "SCALE_TIER_UNSPECIFIED",
		1: "BASIC",
		2: "STANDARD_1",
		3: "PREMIUM_1",
		4: "BASIC_GPU",
		5: "BASIC_TPU",
		6: "CUSTOM",
	}
	ExecutionTemplate_ScaleTier_value = map[string]int32{
		"SCALE_TIER_UNSPECIFIED": 0,
		"BASIC":                  1,
		"STANDARD_1":             2,
		"PREMIUM_1":              3,
		"BASIC_GPU":              4,
		"BASIC_TPU":              5,
		"CUSTOM":                 6,
	}
)

Enum value maps for ExecutionTemplate_ScaleTier.

View Source
var (
	ExecutionTemplate_SchedulerAcceleratorType_name = map[int32]string{
		0:  "SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED",
		1:  "NVIDIA_TESLA_K80",
		2:  "NVIDIA_TESLA_P100",
		3:  "NVIDIA_TESLA_V100",
		4:  "NVIDIA_TESLA_P4",
		5:  "NVIDIA_TESLA_T4",
		10: "NVIDIA_TESLA_A100",
		6:  "TPU_V2",
		7:  "TPU_V3",
	}
	ExecutionTemplate_SchedulerAcceleratorType_value = map[string]int32{
		"SCHEDULER_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_A100":                      10,
		"TPU_V2":                                 6,
		"TPU_V3":                                 7,
	}
)

Enum value maps for ExecutionTemplate_SchedulerAcceleratorType.

View Source
var (
	ExecutionTemplate_JobType_name = map[int32]string{
		0: "JOB_TYPE_UNSPECIFIED",
		1: "VERTEX_AI",
		2: "DATAPROC",
	}
	ExecutionTemplate_JobType_value = map[string]int32{
		"JOB_TYPE_UNSPECIFIED": 0,
		"VERTEX_AI":            1,
		"DATAPROC":             2,
	}
)

Enum value maps for ExecutionTemplate_JobType.

View Source
var (
	Execution_State_name = map[int32]string{
		0:  "STATE_UNSPECIFIED",
		1:  "QUEUED",
		2:  "PREPARING",
		3:  "RUNNING",
		4:  "SUCCEEDED",
		5:  "FAILED",
		6:  "CANCELLING",
		7:  "CANCELLED",
		9:  "EXPIRED",
		10: "INITIALIZING",
	}
	Execution_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"QUEUED":            1,
		"PREPARING":         2,
		"RUNNING":           3,
		"SUCCEEDED":         4,
		"FAILED":            5,
		"CANCELLING":        6,
		"CANCELLED":         7,
		"EXPIRED":           9,
		"INITIALIZING":      10,
	}
)

Enum value maps for Execution_State.

View Source
var (
	ReservationAffinity_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "NO_RESERVATION",
		2: "ANY_RESERVATION",
		3: "SPECIFIC_RESERVATION",
	}
	ReservationAffinity_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":     0,
		"NO_RESERVATION":       1,
		"ANY_RESERVATION":      2,
		"SPECIFIC_RESERVATION": 3,
	}
)

Enum value maps for ReservationAffinity_Type.

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",
		11: "NVIDIA_TESLA_A100",
		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_A100":            11,
		"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",
		10: "SUSPENDING",
		11: "SUSPENDED",
	}
	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,
		"SUSPENDING":        10,
		"SUSPENDED":         11,
	}
)

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",
		4: "PD_EXTREME",
	}
	Instance_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 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 (
	Instance_NicType_name = map[int32]string{
		0: "UNSPECIFIED_NIC_TYPE",
		1: "VIRTIO_NET",
		2: "GVNIC",
	}
	Instance_NicType_value = map[string]int32{
		"UNSPECIFIED_NIC_TYPE": 0,
		"VIRTIO_NET":           1,
		"GVNIC":                2,
	}
)

Enum value maps for Instance_NicType.

View Source
var (
	Instance_UpgradeHistoryEntry_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STARTED",
		2: "SUCCEEDED",
		3: "FAILED",
	}
	Instance_UpgradeHistoryEntry_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STARTED":           1,
		"SUCCEEDED":         2,
		"FAILED":            3,
	}
)

Enum value maps for Instance_UpgradeHistoryEntry_State.

View Source
var (
	Instance_UpgradeHistoryEntry_Action_name = map[int32]string{
		0: "ACTION_UNSPECIFIED",
		1: "UPGRADE",
		2: "ROLLBACK",
	}
	Instance_UpgradeHistoryEntry_Action_value = map[string]int32{
		"ACTION_UNSPECIFIED": 0,
		"UPGRADE":            1,
		"ROLLBACK":           2,
	}
)

Enum value maps for Instance_UpgradeHistoryEntry_Action.

View Source
var (
	Schedule_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ENABLED",
		2: "PAUSED",
		3: "DISABLED",
		4: "UPDATE_FAILED",
		5: "INITIALIZING",
		6: "DELETING",
	}
	Schedule_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ENABLED":           1,
		"PAUSED":            2,
		"DISABLED":          3,
		"UPDATE_FAILED":     4,
		"INITIALIZING":      5,
		"DELETING":          6,
	}
)

Enum value maps for Schedule_State.

View Source
var File_google_events_cloud_notebooks_v1_data_proto protoreflect.FileDescriptor
View Source
var File_google_events_cloud_notebooks_v1_events_proto protoreflect.FileDescriptor

Functions

This section is empty.

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

func (x *ContainerImage) SetRepository(v string)

func (*ContainerImage) SetTag

func (x *ContainerImage) SetTag(v string)

func (*ContainerImage) String

func (x *ContainerImage) String() string

type ContainerImage_builder

type ContainerImage_builder struct {

	// Required. The path to the container image repository. For example:
	// `gcr.io/{project_id}/{image_name}`
	Repository string
	// The tag of the container image. If not specified, this defaults
	// to the latest tag.
	Tag string
	// contains filtered or unexported fields
}

func (ContainerImage_builder) Build

type EncryptionConfig

type EncryptionConfig struct {

	// The Cloud KMS resource identifier of the customer-managed encryption key
	// used to protect a resource, such as a disks. It has the following
	// format:
	// `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`
	KmsKey string `protobuf:"bytes,1,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// contains filtered or unexported fields
}

Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.

func (*EncryptionConfig) GetKmsKey

func (x *EncryptionConfig) GetKmsKey() string

func (*EncryptionConfig) ProtoMessage

func (*EncryptionConfig) ProtoMessage()

func (*EncryptionConfig) ProtoReflect

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

func (*EncryptionConfig) Reset

func (x *EncryptionConfig) Reset()

func (*EncryptionConfig) SetKmsKey

func (x *EncryptionConfig) SetKmsKey(v string)

func (*EncryptionConfig) String

func (x *EncryptionConfig) String() string

type EncryptionConfig_builder

type EncryptionConfig_builder struct {

	// The Cloud KMS resource identifier of the customer-managed encryption key
	// used to protect a resource, such as a disks. It has the following
	// format:
	// `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}`
	KmsKey string
	// contains filtered or unexported fields
}

func (EncryptionConfig_builder) Build

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 valid to be assigned 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) ClearContainerImage

func (x *Environment) ClearContainerImage()

func (*Environment) ClearCreateTime

func (x *Environment) ClearCreateTime()

func (*Environment) ClearImageType

func (x *Environment) ClearImageType()

func (*Environment) ClearVmImage

func (x *Environment) ClearVmImage()

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 (x *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) HasContainerImage

func (x *Environment) HasContainerImage() bool

func (*Environment) HasCreateTime

func (x *Environment) HasCreateTime() bool

func (*Environment) HasImageType

func (x *Environment) HasImageType() bool

func (*Environment) HasVmImage

func (x *Environment) HasVmImage() bool

func (*Environment) ProtoMessage

func (*Environment) ProtoMessage()

func (*Environment) ProtoReflect

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

func (*Environment) Reset

func (x *Environment) Reset()

func (*Environment) SetContainerImage

func (x *Environment) SetContainerImage(v *ContainerImage)

func (*Environment) SetCreateTime

func (x *Environment) SetCreateTime(v *timestamppb.Timestamp)

func (*Environment) SetDescription

func (x *Environment) SetDescription(v string)

func (*Environment) SetDisplayName

func (x *Environment) SetDisplayName(v string)

func (*Environment) SetName

func (x *Environment) SetName(v string)

func (*Environment) SetPostStartupScript

func (x *Environment) SetPostStartupScript(v string)

func (*Environment) SetVmImage

func (x *Environment) SetVmImage(v *VmImage)

func (*Environment) String

func (x *Environment) String() string

func (*Environment) WhichImageType

func (x *Environment) WhichImageType() case_Environment_ImageType

type EnvironmentCreatedEvent

type EnvironmentCreatedEvent struct {

	// The data associated with the event.
	Data *EnvironmentEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Environment is created.

func (*EnvironmentCreatedEvent) ClearData

func (x *EnvironmentCreatedEvent) ClearData()

func (*EnvironmentCreatedEvent) GetData

func (*EnvironmentCreatedEvent) HasData

func (x *EnvironmentCreatedEvent) HasData() bool

func (*EnvironmentCreatedEvent) ProtoMessage

func (*EnvironmentCreatedEvent) ProtoMessage()

func (*EnvironmentCreatedEvent) ProtoReflect

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

func (*EnvironmentCreatedEvent) Reset

func (x *EnvironmentCreatedEvent) Reset()

func (*EnvironmentCreatedEvent) SetData

func (*EnvironmentCreatedEvent) String

func (x *EnvironmentCreatedEvent) String() string

type EnvironmentCreatedEvent_builder

type EnvironmentCreatedEvent_builder struct {

	// The data associated with the event.
	Data *EnvironmentEventData
	// contains filtered or unexported fields
}

func (EnvironmentCreatedEvent_builder) Build

type EnvironmentDeletedEvent

type EnvironmentDeletedEvent struct {

	// The data associated with the event.
	Data *EnvironmentEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Environment is deleted.

func (*EnvironmentDeletedEvent) ClearData

func (x *EnvironmentDeletedEvent) ClearData()

func (*EnvironmentDeletedEvent) GetData

func (*EnvironmentDeletedEvent) HasData

func (x *EnvironmentDeletedEvent) HasData() bool

func (*EnvironmentDeletedEvent) ProtoMessage

func (*EnvironmentDeletedEvent) ProtoMessage()

func (*EnvironmentDeletedEvent) ProtoReflect

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

func (*EnvironmentDeletedEvent) Reset

func (x *EnvironmentDeletedEvent) Reset()

func (*EnvironmentDeletedEvent) SetData

func (*EnvironmentDeletedEvent) String

func (x *EnvironmentDeletedEvent) String() string

type EnvironmentDeletedEvent_builder

type EnvironmentDeletedEvent_builder struct {

	// The data associated with the event.
	Data *EnvironmentEventData
	// contains filtered or unexported fields
}

func (EnvironmentDeletedEvent_builder) Build

type EnvironmentEventData

type EnvironmentEventData struct {

	// Optional. The Environment event payload. Unset for deletion events.
	Payload *Environment `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Environment events.

func (*EnvironmentEventData) ClearPayload

func (x *EnvironmentEventData) ClearPayload()

func (*EnvironmentEventData) GetPayload

func (x *EnvironmentEventData) GetPayload() *Environment

func (*EnvironmentEventData) HasPayload

func (x *EnvironmentEventData) HasPayload() bool

func (*EnvironmentEventData) ProtoMessage

func (*EnvironmentEventData) ProtoMessage()

func (*EnvironmentEventData) ProtoReflect

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

func (*EnvironmentEventData) Reset

func (x *EnvironmentEventData) Reset()

func (*EnvironmentEventData) SetPayload

func (x *EnvironmentEventData) SetPayload(v *Environment)

func (*EnvironmentEventData) String

func (x *EnvironmentEventData) String() string

type EnvironmentEventData_builder

type EnvironmentEventData_builder struct {

	// Optional. The Environment event payload. Unset for deletion events.
	Payload *Environment
	// contains filtered or unexported fields
}

func (EnvironmentEventData_builder) Build

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 Environment_builder

type Environment_builder struct {

	// Output only. Name of this environment.
	// Format:
	// `projects/{project_id}/locations/{location}/environments/{environment_id}`
	Name string
	// Display name of this environment for the UI.
	DisplayName string
	// A brief description of this environment.
	Description string

	// Fields of oneof ImageType:
	// Use a Compute Engine VM image to start the notebook instance.
	VmImage *VmImage
	// Use a container image to start the notebook instance.
	ContainerImage *ContainerImage
	// -- end of ImageType
	// 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
	// Output only. The time at which this environment was created.
	CreateTime *timestamppb.Timestamp
	// contains filtered or unexported fields
}

func (Environment_builder) Build

func (b0 Environment_builder) Build() *Environment

type Execution

type Execution struct {

	// execute metadata including name, hardware spec, region, labels, etc.
	ExecutionTemplate *ExecutionTemplate `protobuf:"bytes,1,opt,name=execution_template,json=executionTemplate,proto3" json:"execution_template,omitempty"`
	// Output only. The resource name of the execute. Format:
	// `projects/{project_id}/locations/{location}/executions/{execution_id}`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Name used for UI purposes.
	// Name can only contain alphanumeric characters and underscores '_'.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A brief description of this execution.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Time the Execution was instantiated.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time the Execution was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. State of the underlying AI Platform job.
	State Execution_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.events.cloud.notebooks.v1.Execution_State" json:"state,omitempty"`
	// Output notebook file generated by this execution
	OutputNotebookFile string `protobuf:"bytes,8,opt,name=output_notebook_file,json=outputNotebookFile,proto3" json:"output_notebook_file,omitempty"`
	// Output only. The URI of the external job used to execute the notebook.
	JobUri string `protobuf:"bytes,9,opt,name=job_uri,json=jobUri,proto3" json:"job_uri,omitempty"`
	// contains filtered or unexported fields
}

The definition of a single executed notebook.

func (*Execution) ClearCreateTime

func (x *Execution) ClearCreateTime()

func (*Execution) ClearExecutionTemplate

func (x *Execution) ClearExecutionTemplate()

func (*Execution) ClearUpdateTime

func (x *Execution) ClearUpdateTime()

func (*Execution) GetCreateTime

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

func (*Execution) GetDescription

func (x *Execution) GetDescription() string

func (*Execution) GetDisplayName

func (x *Execution) GetDisplayName() string

func (*Execution) GetExecutionTemplate

func (x *Execution) GetExecutionTemplate() *ExecutionTemplate

func (*Execution) GetJobUri

func (x *Execution) GetJobUri() string

func (*Execution) GetName

func (x *Execution) GetName() string

func (*Execution) GetOutputNotebookFile

func (x *Execution) GetOutputNotebookFile() string

func (*Execution) GetState

func (x *Execution) GetState() Execution_State

func (*Execution) GetUpdateTime

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

func (*Execution) HasCreateTime

func (x *Execution) HasCreateTime() bool

func (*Execution) HasExecutionTemplate

func (x *Execution) HasExecutionTemplate() bool

func (*Execution) HasUpdateTime

func (x *Execution) HasUpdateTime() bool

func (*Execution) ProtoMessage

func (*Execution) ProtoMessage()

func (*Execution) ProtoReflect

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

func (*Execution) Reset

func (x *Execution) Reset()

func (*Execution) SetCreateTime

func (x *Execution) SetCreateTime(v *timestamppb.Timestamp)

func (*Execution) SetDescription

func (x *Execution) SetDescription(v string)

func (*Execution) SetDisplayName

func (x *Execution) SetDisplayName(v string)

func (*Execution) SetExecutionTemplate

func (x *Execution) SetExecutionTemplate(v *ExecutionTemplate)

func (*Execution) SetJobUri

func (x *Execution) SetJobUri(v string)

func (*Execution) SetName

func (x *Execution) SetName(v string)

func (*Execution) SetOutputNotebookFile

func (x *Execution) SetOutputNotebookFile(v string)

func (*Execution) SetState

func (x *Execution) SetState(v Execution_State)

func (*Execution) SetUpdateTime

func (x *Execution) SetUpdateTime(v *timestamppb.Timestamp)

func (*Execution) String

func (x *Execution) String() string

type ExecutionCreatedEvent

type ExecutionCreatedEvent struct {

	// The data associated with the event.
	Data *ExecutionEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Execution is created.

func (*ExecutionCreatedEvent) ClearData

func (x *ExecutionCreatedEvent) ClearData()

func (*ExecutionCreatedEvent) GetData

func (*ExecutionCreatedEvent) HasData

func (x *ExecutionCreatedEvent) HasData() bool

func (*ExecutionCreatedEvent) ProtoMessage

func (*ExecutionCreatedEvent) ProtoMessage()

func (*ExecutionCreatedEvent) ProtoReflect

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

func (*ExecutionCreatedEvent) Reset

func (x *ExecutionCreatedEvent) Reset()

func (*ExecutionCreatedEvent) SetData

func (*ExecutionCreatedEvent) String

func (x *ExecutionCreatedEvent) String() string

type ExecutionCreatedEvent_builder

type ExecutionCreatedEvent_builder struct {

	// The data associated with the event.
	Data *ExecutionEventData
	// contains filtered or unexported fields
}

func (ExecutionCreatedEvent_builder) Build

type ExecutionDeletedEvent

type ExecutionDeletedEvent struct {

	// The data associated with the event.
	Data *ExecutionEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Execution is deleted.

func (*ExecutionDeletedEvent) ClearData

func (x *ExecutionDeletedEvent) ClearData()

func (*ExecutionDeletedEvent) GetData

func (*ExecutionDeletedEvent) HasData

func (x *ExecutionDeletedEvent) HasData() bool

func (*ExecutionDeletedEvent) ProtoMessage

func (*ExecutionDeletedEvent) ProtoMessage()

func (*ExecutionDeletedEvent) ProtoReflect

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

func (*ExecutionDeletedEvent) Reset

func (x *ExecutionDeletedEvent) Reset()

func (*ExecutionDeletedEvent) SetData

func (*ExecutionDeletedEvent) String

func (x *ExecutionDeletedEvent) String() string

type ExecutionDeletedEvent_builder

type ExecutionDeletedEvent_builder struct {

	// The data associated with the event.
	Data *ExecutionEventData
	// contains filtered or unexported fields
}

func (ExecutionDeletedEvent_builder) Build

type ExecutionEventData

type ExecutionEventData struct {

	// Optional. The Execution event payload. Unset for deletion events.
	Payload *Execution `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Execution events.

func (*ExecutionEventData) ClearPayload

func (x *ExecutionEventData) ClearPayload()

func (*ExecutionEventData) GetPayload

func (x *ExecutionEventData) GetPayload() *Execution

func (*ExecutionEventData) HasPayload

func (x *ExecutionEventData) HasPayload() bool

func (*ExecutionEventData) ProtoMessage

func (*ExecutionEventData) ProtoMessage()

func (*ExecutionEventData) ProtoReflect

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

func (*ExecutionEventData) Reset

func (x *ExecutionEventData) Reset()

func (*ExecutionEventData) SetPayload

func (x *ExecutionEventData) SetPayload(v *Execution)

func (*ExecutionEventData) String

func (x *ExecutionEventData) String() string

type ExecutionEventData_builder

type ExecutionEventData_builder struct {

	// Optional. The Execution event payload. Unset for deletion events.
	Payload *Execution
	// contains filtered or unexported fields
}

func (ExecutionEventData_builder) Build

type ExecutionTemplate

type ExecutionTemplate struct {

	// Required. Scale tier of the hardware used for notebook execution.
	// DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
	ScaleTier ExecutionTemplate_ScaleTier `` /* 155-byte string literal not displayed */
	// Specifies the type of virtual machine to use for your training
	// job's master worker. You must specify this field when `scaleTier` is set to
	// `CUSTOM`.
	//
	// You can use certain Compute Engine machine types directly in this field.
	// The following types are supported:
	//
	// - `n1-standard-4`
	// - `n1-standard-8`
	// - `n1-standard-16`
	// - `n1-standard-32`
	// - `n1-standard-64`
	// - `n1-standard-96`
	// - `n1-highmem-2`
	// - `n1-highmem-4`
	// - `n1-highmem-8`
	// - `n1-highmem-16`
	// - `n1-highmem-32`
	// - `n1-highmem-64`
	// - `n1-highmem-96`
	// - `n1-highcpu-16`
	// - `n1-highcpu-32`
	// - `n1-highcpu-64`
	// - `n1-highcpu-96`
	//
	// Alternatively, you can use the following legacy machine types:
	//
	// - `standard`
	// - `large_model`
	// - `complex_model_s`
	// - `complex_model_m`
	// - `complex_model_l`
	// - `standard_gpu`
	// - `complex_model_m_gpu`
	// - `complex_model_l_gpu`
	// - `standard_p100`
	// - `complex_model_m_p100`
	// - `standard_v100`
	// - `large_model_v100`
	// - `complex_model_m_v100`
	// - `complex_model_l_v100`
	//
	// Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
	// field. Learn more about the [special configuration options for training
	// with
	// TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
	MasterType string `protobuf:"bytes,2,opt,name=master_type,json=masterType,proto3" json:"master_type,omitempty"`
	// Configuration (count and accelerator type) for hardware running notebook
	// execution.
	AcceleratorConfig *ExecutionTemplate_SchedulerAcceleratorConfig `protobuf:"bytes,3,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
	// Labels for execution.
	// If execution is scheduled, a field included will be 'nbs-scheduled'.
	// Otherwise, it is an immediate execution, and an included field will be
	// 'nbs-immediate'. Use fields to efficiently index between various types of
	// executions.
	Labels map[string]string `` /* 139-byte string literal not displayed */
	// Path to the notebook file to execute.
	// Must be in a Google Cloud Storage bucket.
	// Format: `gs://{bucket_name}/{folder}/{notebook_file_name}`
	// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
	InputNotebookFile string `protobuf:"bytes,5,opt,name=input_notebook_file,json=inputNotebookFile,proto3" json:"input_notebook_file,omitempty"`
	// Container Image URI to a DLVM
	// Example: 'gcr.io/deeplearning-platform-release/base-cu100'
	// More examples can be found at:
	// https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
	ContainerImageUri string `protobuf:"bytes,6,opt,name=container_image_uri,json=containerImageUri,proto3" json:"container_image_uri,omitempty"`
	// Path to the notebook folder to write to.
	// Must be in a Google Cloud Storage bucket path.
	// Format: `gs://{bucket_name}/{folder}`
	// Ex: `gs://notebook_user/scheduled_notebooks`
	OutputNotebookFolder string `protobuf:"bytes,7,opt,name=output_notebook_folder,json=outputNotebookFolder,proto3" json:"output_notebook_folder,omitempty"`
	// Parameters to be overridden in the notebook during execution.
	// Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
	// how to specifying parameters in the input notebook and pass them here
	// in an YAML file.
	// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
	ParamsYamlFile string `protobuf:"bytes,8,opt,name=params_yaml_file,json=paramsYamlFile,proto3" json:"params_yaml_file,omitempty"`
	// Parameters used within the 'input_notebook_file' notebook.
	Parameters string `protobuf:"bytes,9,opt,name=parameters,proto3" json:"parameters,omitempty"`
	// The email address of a service account to use when running the execution.
	// You must have the `iam.serviceAccounts.actAs` permission for the specified
	// service account.
	ServiceAccount string `protobuf:"bytes,10,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// The type of Job to be used on this execution.
	JobType ExecutionTemplate_JobType `` /* 148-byte string literal not displayed */
	// Parameters for an execution type.
	// NOTE: There are currently no extra parameters for VertexAI jobs.
	//
	// Types that are valid to be assigned to JobParameters:
	//
	//	*ExecutionTemplate_DataprocParameters_
	//	*ExecutionTemplate_VertexAiParameters
	JobParameters isExecutionTemplate_JobParameters `protobuf_oneof:"job_parameters"`
	// Name of the kernel spec to use. This must be specified if the
	// kernel spec name on the execution target does not match the name in the
	// input notebook file.
	KernelSpec string `protobuf:"bytes,14,opt,name=kernel_spec,json=kernelSpec,proto3" json:"kernel_spec,omitempty"`
	// The name of a Vertex AI [Tensorboard] resource to which this execution
	// will upload Tensorboard logs.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard string `protobuf:"bytes,15,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
	// contains filtered or unexported fields
}

The description a notebook execution workload.

func (*ExecutionTemplate) ClearAcceleratorConfig

func (x *ExecutionTemplate) ClearAcceleratorConfig()

func (*ExecutionTemplate) ClearDataprocParameters

func (x *ExecutionTemplate) ClearDataprocParameters()

func (*ExecutionTemplate) ClearJobParameters

func (x *ExecutionTemplate) ClearJobParameters()

func (*ExecutionTemplate) ClearVertexAiParameters

func (x *ExecutionTemplate) ClearVertexAiParameters()

func (*ExecutionTemplate) GetAcceleratorConfig

func (*ExecutionTemplate) GetContainerImageUri

func (x *ExecutionTemplate) GetContainerImageUri() string

func (*ExecutionTemplate) GetDataprocParameters

func (x *ExecutionTemplate) GetDataprocParameters() *ExecutionTemplate_DataprocParameters

func (*ExecutionTemplate) GetInputNotebookFile

func (x *ExecutionTemplate) GetInputNotebookFile() string

func (*ExecutionTemplate) GetJobParameters

func (x *ExecutionTemplate) GetJobParameters() isExecutionTemplate_JobParameters

func (*ExecutionTemplate) GetJobType

func (*ExecutionTemplate) GetKernelSpec

func (x *ExecutionTemplate) GetKernelSpec() string

func (*ExecutionTemplate) GetLabels

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

func (*ExecutionTemplate) GetMasterType

func (x *ExecutionTemplate) GetMasterType() string

func (*ExecutionTemplate) GetOutputNotebookFolder

func (x *ExecutionTemplate) GetOutputNotebookFolder() string

func (*ExecutionTemplate) GetParameters

func (x *ExecutionTemplate) GetParameters() string

func (*ExecutionTemplate) GetParamsYamlFile

func (x *ExecutionTemplate) GetParamsYamlFile() string

func (*ExecutionTemplate) GetScaleTier

func (*ExecutionTemplate) GetServiceAccount

func (x *ExecutionTemplate) GetServiceAccount() string

func (*ExecutionTemplate) GetTensorboard

func (x *ExecutionTemplate) GetTensorboard() string

func (*ExecutionTemplate) GetVertexAiParameters

func (x *ExecutionTemplate) GetVertexAiParameters() *ExecutionTemplate_VertexAIParameters

func (*ExecutionTemplate) HasAcceleratorConfig

func (x *ExecutionTemplate) HasAcceleratorConfig() bool

func (*ExecutionTemplate) HasDataprocParameters

func (x *ExecutionTemplate) HasDataprocParameters() bool

func (*ExecutionTemplate) HasJobParameters

func (x *ExecutionTemplate) HasJobParameters() bool

func (*ExecutionTemplate) HasVertexAiParameters

func (x *ExecutionTemplate) HasVertexAiParameters() bool

func (*ExecutionTemplate) ProtoMessage

func (*ExecutionTemplate) ProtoMessage()

func (*ExecutionTemplate) ProtoReflect

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

func (*ExecutionTemplate) Reset

func (x *ExecutionTemplate) Reset()

func (*ExecutionTemplate) SetAcceleratorConfig

func (*ExecutionTemplate) SetContainerImageUri

func (x *ExecutionTemplate) SetContainerImageUri(v string)

func (*ExecutionTemplate) SetDataprocParameters

func (x *ExecutionTemplate) SetDataprocParameters(v *ExecutionTemplate_DataprocParameters)

func (*ExecutionTemplate) SetInputNotebookFile

func (x *ExecutionTemplate) SetInputNotebookFile(v string)

func (*ExecutionTemplate) SetJobType

func (*ExecutionTemplate) SetKernelSpec

func (x *ExecutionTemplate) SetKernelSpec(v string)

func (*ExecutionTemplate) SetLabels

func (x *ExecutionTemplate) SetLabels(v map[string]string)

func (*ExecutionTemplate) SetMasterType

func (x *ExecutionTemplate) SetMasterType(v string)

func (*ExecutionTemplate) SetOutputNotebookFolder

func (x *ExecutionTemplate) SetOutputNotebookFolder(v string)

func (*ExecutionTemplate) SetParameters

func (x *ExecutionTemplate) SetParameters(v string)

func (*ExecutionTemplate) SetParamsYamlFile

func (x *ExecutionTemplate) SetParamsYamlFile(v string)

func (*ExecutionTemplate) SetScaleTier

func (*ExecutionTemplate) SetServiceAccount

func (x *ExecutionTemplate) SetServiceAccount(v string)

func (*ExecutionTemplate) SetTensorboard

func (x *ExecutionTemplate) SetTensorboard(v string)

func (*ExecutionTemplate) SetVertexAiParameters

func (x *ExecutionTemplate) SetVertexAiParameters(v *ExecutionTemplate_VertexAIParameters)

func (*ExecutionTemplate) String

func (x *ExecutionTemplate) String() string

func (*ExecutionTemplate) WhichJobParameters

func (x *ExecutionTemplate) WhichJobParameters() case_ExecutionTemplate_JobParameters

type ExecutionTemplate_DataprocParameters

type ExecutionTemplate_DataprocParameters struct {

	// URI for cluster used to run Dataproc execution.
	// Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// contains filtered or unexported fields
}

Parameters used in Dataproc JobType executions.

func (*ExecutionTemplate_DataprocParameters) GetCluster

func (*ExecutionTemplate_DataprocParameters) ProtoMessage

func (*ExecutionTemplate_DataprocParameters) ProtoMessage()

func (*ExecutionTemplate_DataprocParameters) ProtoReflect

func (*ExecutionTemplate_DataprocParameters) Reset

func (*ExecutionTemplate_DataprocParameters) SetCluster

func (*ExecutionTemplate_DataprocParameters) String

type ExecutionTemplate_DataprocParameters_

type ExecutionTemplate_DataprocParameters_ struct {
	// Parameters used in Dataproc JobType executions.
	DataprocParameters *ExecutionTemplate_DataprocParameters `protobuf:"bytes,12,opt,name=dataproc_parameters,json=dataprocParameters,proto3,oneof"`
}

type ExecutionTemplate_DataprocParameters_builder

type ExecutionTemplate_DataprocParameters_builder struct {

	// URI for cluster used to run Dataproc execution.
	// Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
	Cluster string
	// contains filtered or unexported fields
}

func (ExecutionTemplate_DataprocParameters_builder) Build

type ExecutionTemplate_JobType

type ExecutionTemplate_JobType int32

The backend used for this execution.

const (
	// No type specified.
	ExecutionTemplate_JOB_TYPE_UNSPECIFIED ExecutionTemplate_JobType = 0
	// Custom Job in `aiplatform.googleapis.com`.
	// Default value for an execution.
	ExecutionTemplate_VERTEX_AI ExecutionTemplate_JobType = 1
	// Run execution on a cluster with Dataproc as a job.
	// https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs
	ExecutionTemplate_DATAPROC ExecutionTemplate_JobType = 2
)

func (ExecutionTemplate_JobType) Descriptor

func (ExecutionTemplate_JobType) Enum

func (ExecutionTemplate_JobType) Number

func (ExecutionTemplate_JobType) String

func (x ExecutionTemplate_JobType) String() string

func (ExecutionTemplate_JobType) Type

type ExecutionTemplate_ScaleTier

type ExecutionTemplate_ScaleTier int32

Required. Specifies the machine types, the number of replicas for workers and parameter servers.

const (
	// Unspecified Scale Tier.
	ExecutionTemplate_SCALE_TIER_UNSPECIFIED ExecutionTemplate_ScaleTier = 0
	// A single worker instance. This tier is suitable for learning how to use
	// Cloud ML, and for experimenting with new models using small datasets.
	ExecutionTemplate_BASIC ExecutionTemplate_ScaleTier = 1
	// Many workers and a few parameter servers.
	ExecutionTemplate_STANDARD_1 ExecutionTemplate_ScaleTier = 2
	// A large number of workers with many parameter servers.
	ExecutionTemplate_PREMIUM_1 ExecutionTemplate_ScaleTier = 3
	// A single worker instance with a K80 GPU.
	ExecutionTemplate_BASIC_GPU ExecutionTemplate_ScaleTier = 4
	// A single worker instance with a Cloud TPU.
	ExecutionTemplate_BASIC_TPU ExecutionTemplate_ScaleTier = 5
	// The CUSTOM tier is not a set tier, but rather enables you to use your
	// own cluster specification. When you use this tier, set values to
	// configure your processing cluster according to these guidelines:
	//
	//   - You _must_ set `ExecutionTemplate.masterType` to specify the type
	//     of machine to use for your master node. This is the only required
	//     setting.
	ExecutionTemplate_CUSTOM ExecutionTemplate_ScaleTier = 6
)

func (ExecutionTemplate_ScaleTier) Descriptor

func (ExecutionTemplate_ScaleTier) Enum

func (ExecutionTemplate_ScaleTier) Number

func (ExecutionTemplate_ScaleTier) String

func (ExecutionTemplate_ScaleTier) Type

type ExecutionTemplate_SchedulerAcceleratorConfig

type ExecutionTemplate_SchedulerAcceleratorConfig struct {

	// Type of this accelerator.
	Type ExecutionTemplate_SchedulerAcceleratorType `` /* 143-byte string literal not displayed */
	// 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. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported.

func (*ExecutionTemplate_SchedulerAcceleratorConfig) GetCoreCount

func (*ExecutionTemplate_SchedulerAcceleratorConfig) GetType

func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoMessage

func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoReflect

func (*ExecutionTemplate_SchedulerAcceleratorConfig) Reset

func (*ExecutionTemplate_SchedulerAcceleratorConfig) SetCoreCount

func (*ExecutionTemplate_SchedulerAcceleratorConfig) SetType

func (*ExecutionTemplate_SchedulerAcceleratorConfig) String

type ExecutionTemplate_SchedulerAcceleratorConfig_builder

type ExecutionTemplate_SchedulerAcceleratorConfig_builder struct {

	// Type of this accelerator.
	Type ExecutionTemplate_SchedulerAcceleratorType
	// Count of cores of this accelerator.
	CoreCount int64
	// contains filtered or unexported fields
}

func (ExecutionTemplate_SchedulerAcceleratorConfig_builder) Build

type ExecutionTemplate_SchedulerAcceleratorType

type ExecutionTemplate_SchedulerAcceleratorType int32

Hardware accelerator types for AI Platform Training jobs.

const (
	// Unspecified accelerator type. Default to no GPU.
	ExecutionTemplate_SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED ExecutionTemplate_SchedulerAcceleratorType = 0
	// Nvidia Tesla K80 GPU.
	ExecutionTemplate_NVIDIA_TESLA_K80 ExecutionTemplate_SchedulerAcceleratorType = 1
	// Nvidia Tesla P100 GPU.
	ExecutionTemplate_NVIDIA_TESLA_P100 ExecutionTemplate_SchedulerAcceleratorType = 2
	// Nvidia Tesla V100 GPU.
	ExecutionTemplate_NVIDIA_TESLA_V100 ExecutionTemplate_SchedulerAcceleratorType = 3
	// Nvidia Tesla P4 GPU.
	ExecutionTemplate_NVIDIA_TESLA_P4 ExecutionTemplate_SchedulerAcceleratorType = 4
	// Nvidia Tesla T4 GPU.
	ExecutionTemplate_NVIDIA_TESLA_T4 ExecutionTemplate_SchedulerAcceleratorType = 5
	// Nvidia Tesla A100 GPU.
	ExecutionTemplate_NVIDIA_TESLA_A100 ExecutionTemplate_SchedulerAcceleratorType = 10
	// TPU v2.
	ExecutionTemplate_TPU_V2 ExecutionTemplate_SchedulerAcceleratorType = 6
	// TPU v3.
	ExecutionTemplate_TPU_V3 ExecutionTemplate_SchedulerAcceleratorType = 7
)

func (ExecutionTemplate_SchedulerAcceleratorType) Descriptor

func (ExecutionTemplate_SchedulerAcceleratorType) Enum

func (ExecutionTemplate_SchedulerAcceleratorType) Number

func (ExecutionTemplate_SchedulerAcceleratorType) String

func (ExecutionTemplate_SchedulerAcceleratorType) Type

type ExecutionTemplate_VertexAIParameters

type ExecutionTemplate_VertexAIParameters struct {

	// The full name of the Compute Engine
	// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
	// to which the Job should be peered. For example,
	// `projects/12345/global/networks/myVPC`.
	// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert)
	// is of the form `projects/{project}/global/networks/{network}`.
	// Where `{project}` is a project number, as in `12345`, and `{network}` is
	// a network name.
	//
	// Private services access must already be configured for the network. If
	// left unspecified, the job is not peered with any network.
	Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
	// Environment variables.
	// At most 100 environment variables can be specified and unique.
	// Example: `GCP_BUCKET=gs://my-bucket/samples/`
	Env map[string]string `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Parameters used in Vertex AI JobType executions.

func (*ExecutionTemplate_VertexAIParameters) GetEnv

func (*ExecutionTemplate_VertexAIParameters) GetNetwork

func (*ExecutionTemplate_VertexAIParameters) ProtoMessage

func (*ExecutionTemplate_VertexAIParameters) ProtoMessage()

func (*ExecutionTemplate_VertexAIParameters) ProtoReflect

func (*ExecutionTemplate_VertexAIParameters) Reset

func (*ExecutionTemplate_VertexAIParameters) SetEnv

func (*ExecutionTemplate_VertexAIParameters) SetNetwork

func (*ExecutionTemplate_VertexAIParameters) String

type ExecutionTemplate_VertexAIParameters_builder

type ExecutionTemplate_VertexAIParameters_builder struct {

	// The full name of the Compute Engine
	// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
	// to which the Job should be peered. For example,
	// `projects/12345/global/networks/myVPC`.
	// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert)
	// is of the form `projects/{project}/global/networks/{network}`.
	// Where `{project}` is a project number, as in `12345`, and `{network}` is
	// a network name.
	//
	// Private services access must already be configured for the network. If
	// left unspecified, the job is not peered with any network.
	Network string
	// Environment variables.
	// At most 100 environment variables can be specified and unique.
	// Example: `GCP_BUCKET=gs://my-bucket/samples/`
	Env map[string]string
	// contains filtered or unexported fields
}

func (ExecutionTemplate_VertexAIParameters_builder) Build

type ExecutionTemplate_VertexAiParameters

type ExecutionTemplate_VertexAiParameters struct {
	// Parameters used in Vertex AI JobType executions.
	VertexAiParameters *ExecutionTemplate_VertexAIParameters `protobuf:"bytes,13,opt,name=vertex_ai_parameters,json=vertexAiParameters,proto3,oneof"`
}

type ExecutionTemplate_builder

type ExecutionTemplate_builder struct {

	// Required. Scale tier of the hardware used for notebook execution.
	// DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
	ScaleTier ExecutionTemplate_ScaleTier
	// Specifies the type of virtual machine to use for your training
	// job's master worker. You must specify this field when `scaleTier` is set to
	// `CUSTOM`.
	//
	// You can use certain Compute Engine machine types directly in this field.
	// The following types are supported:
	//
	// - `n1-standard-4`
	// - `n1-standard-8`
	// - `n1-standard-16`
	// - `n1-standard-32`
	// - `n1-standard-64`
	// - `n1-standard-96`
	// - `n1-highmem-2`
	// - `n1-highmem-4`
	// - `n1-highmem-8`
	// - `n1-highmem-16`
	// - `n1-highmem-32`
	// - `n1-highmem-64`
	// - `n1-highmem-96`
	// - `n1-highcpu-16`
	// - `n1-highcpu-32`
	// - `n1-highcpu-64`
	// - `n1-highcpu-96`
	//
	// Alternatively, you can use the following legacy machine types:
	//
	// - `standard`
	// - `large_model`
	// - `complex_model_s`
	// - `complex_model_m`
	// - `complex_model_l`
	// - `standard_gpu`
	// - `complex_model_m_gpu`
	// - `complex_model_l_gpu`
	// - `standard_p100`
	// - `complex_model_m_p100`
	// - `standard_v100`
	// - `large_model_v100`
	// - `complex_model_m_v100`
	// - `complex_model_l_v100`
	//
	// Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
	// field. Learn more about the [special configuration options for training
	// with
	// TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
	MasterType string
	// Configuration (count and accelerator type) for hardware running notebook
	// execution.
	AcceleratorConfig *ExecutionTemplate_SchedulerAcceleratorConfig
	// Labels for execution.
	// If execution is scheduled, a field included will be 'nbs-scheduled'.
	// Otherwise, it is an immediate execution, and an included field will be
	// 'nbs-immediate'. Use fields to efficiently index between various types of
	// executions.
	Labels map[string]string
	// Path to the notebook file to execute.
	// Must be in a Google Cloud Storage bucket.
	// Format: `gs://{bucket_name}/{folder}/{notebook_file_name}`
	// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
	InputNotebookFile string
	// Container Image URI to a DLVM
	// Example: 'gcr.io/deeplearning-platform-release/base-cu100'
	// More examples can be found at:
	// https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
	ContainerImageUri string
	// Path to the notebook folder to write to.
	// Must be in a Google Cloud Storage bucket path.
	// Format: `gs://{bucket_name}/{folder}`
	// Ex: `gs://notebook_user/scheduled_notebooks`
	OutputNotebookFolder string
	// Parameters to be overridden in the notebook during execution.
	// Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
	// how to specifying parameters in the input notebook and pass them here
	// in an YAML file.
	// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
	ParamsYamlFile string
	// Parameters used within the 'input_notebook_file' notebook.
	Parameters string
	// The email address of a service account to use when running the execution.
	// You must have the `iam.serviceAccounts.actAs` permission for the specified
	// service account.
	ServiceAccount string
	// The type of Job to be used on this execution.
	JobType ExecutionTemplate_JobType

	// Fields of oneof JobParameters:
	// Parameters used in Dataproc JobType executions.
	DataprocParameters *ExecutionTemplate_DataprocParameters
	// Parameters used in Vertex AI JobType executions.
	VertexAiParameters *ExecutionTemplate_VertexAIParameters
	// -- end of JobParameters
	// Name of the kernel spec to use. This must be specified if the
	// kernel spec name on the execution target does not match the name in the
	// input notebook file.
	KernelSpec string
	// The name of a Vertex AI [Tensorboard] resource to which this execution
	// will upload Tensorboard logs.
	// Format:
	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
	Tensorboard string
	// contains filtered or unexported fields
}

func (ExecutionTemplate_builder) Build

type Execution_State

type Execution_State int32

Enum description of the state of the underlying AIP job.

const (
	// The job state is unspecified.
	Execution_STATE_UNSPECIFIED Execution_State = 0
	// The job has been just created and processing has not yet begun.
	Execution_QUEUED Execution_State = 1
	// The service is preparing to execution the job.
	Execution_PREPARING Execution_State = 2
	// The job is in progress.
	Execution_RUNNING Execution_State = 3
	// The job completed successfully.
	Execution_SUCCEEDED Execution_State = 4
	// The job failed.
	// `error_message` should contain the details of the failure.
	Execution_FAILED Execution_State = 5
	// The job is being cancelled.
	// `error_message` should describe the reason for the cancellation.
	Execution_CANCELLING Execution_State = 6
	// The job has been cancelled.
	// `error_message` should describe the reason for the cancellation.
	Execution_CANCELLED Execution_State = 7
	// The job has become expired (relevant to Vertex AI jobs)
	// https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
	Execution_EXPIRED Execution_State = 9
	// The Execution is being created.
	Execution_INITIALIZING Execution_State = 10
)

func (Execution_State) Descriptor

func (Execution_State) Enum

func (x Execution_State) Enum() *Execution_State

func (Execution_State) Number

func (Execution_State) String

func (x Execution_State) String() string

func (Execution_State) Type

type Execution_builder

type Execution_builder struct {

	// execute metadata including name, hardware spec, region, labels, etc.
	ExecutionTemplate *ExecutionTemplate
	// Output only. The resource name of the execute. Format:
	// `projects/{project_id}/locations/{location}/executions/{execution_id}`
	Name string
	// Output only. Name used for UI purposes.
	// Name can only contain alphanumeric characters and underscores '_'.
	DisplayName string
	// A brief description of this execution.
	Description string
	// Output only. Time the Execution was instantiated.
	CreateTime *timestamppb.Timestamp
	// Output only. Time the Execution was last updated.
	UpdateTime *timestamppb.Timestamp
	// Output only. State of the underlying AI Platform job.
	State Execution_State
	// Output notebook file generated by this execution
	OutputNotebookFile string
	// Output only. The URI of the external job used to execute the notebook.
	JobUri string
	// contains filtered or unexported fields
}

func (Execution_builder) Build

func (b0 Execution_builder) Build() *Execution

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 valid to be assigned 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"`
	// 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"`
	// Optional. The URIs of service account scopes to be included in
	// Compute Engine instances.
	//
	// If not specified, the following
	// [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
	// are defined:
	//   - https://www.googleapis.com/auth/cloud-platform
	//   - https://www.googleapis.com/auth/userinfo.email
	//
	// If not using default scopes, you need at least:
	//
	//	https://www.googleapis.com/auth/compute
	ServiceAccountScopes []string `protobuf:"bytes,31,rep,name=service_account_scopes,json=serviceAccountScopes,proto3" json:"service_account_scopes,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.events.cloud.notebooks.v1.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"`
	// Output only. Attached disks to notebook instance.
	Disks []*Instance_Disk `protobuf:"bytes,28,rep,name=disks,proto3" json:"disks,omitempty"`
	// Optional. Shielded VM configuration.
	// [Images using supported Shielded VM
	// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
	ShieldedInstanceConfig *Instance_ShieldedInstanceConfig `` /* 130-byte string literal not displayed */
	// If true, no external 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 `` /* 140-byte string literal not displayed */
	// Custom metadata to apply to this instance.
	Metadata map[string]string `` /* 144-byte string literal not displayed */
	// 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,32,rep,name=tags,proto3" json:"tags,omitempty"`
	// The upgrade history of this instance.
	UpgradeHistory []*Instance_UpgradeHistoryEntry `protobuf:"bytes,29,rep,name=upgrade_history,json=upgradeHistory,proto3" json:"upgrade_history,omitempty"`
	// Optional. The type of vNIC to be used on this interface. This may be gVNIC
	// or VirtioNet.
	NicType Instance_NicType `` /* 139-byte string literal not displayed */
	// Optional. The optional reservation affinity. Setting this field will apply
	// the specified [Zonal Compute
	// Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
	// to this notebook instance.
	ReservationAffinity *ReservationAffinity `protobuf:"bytes,34,opt,name=reservation_affinity,json=reservationAffinity,proto3" json:"reservation_affinity,omitempty"`
	// Output only. Email address of entity that sent original CreateInstance
	// request.
	Creator string `protobuf:"bytes,36,opt,name=creator,proto3" json:"creator,omitempty"`
	// Optional. Flag to enable ip forwarding or not, default false/off.
	// https://cloud.google.com/vpc/docs/using-routes#canipforward
	CanIpForward bool `protobuf:"varint,39,opt,name=can_ip_forward,json=canIpForward,proto3" json:"can_ip_forward,omitempty"`
	// 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) ClearAcceleratorConfig

func (x *Instance) ClearAcceleratorConfig()

func (*Instance) ClearContainerImage

func (x *Instance) ClearContainerImage()

func (*Instance) ClearCreateTime

func (x *Instance) ClearCreateTime()

func (*Instance) ClearEnvironment

func (x *Instance) ClearEnvironment()

func (*Instance) ClearReservationAffinity

func (x *Instance) ClearReservationAffinity()

func (*Instance) ClearShieldedInstanceConfig

func (x *Instance) ClearShieldedInstanceConfig()

func (*Instance) ClearUpdateTime

func (x *Instance) ClearUpdateTime()

func (*Instance) ClearVmImage

func (x *Instance) ClearVmImage()

func (*Instance) GetAcceleratorConfig

func (x *Instance) GetAcceleratorConfig() *Instance_AcceleratorConfig

func (*Instance) GetCanIpForward

func (x *Instance) GetCanIpForward() bool

func (*Instance) GetContainerImage

func (x *Instance) GetContainerImage() *ContainerImage

func (*Instance) GetCreateTime

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

func (*Instance) GetCreator

func (x *Instance) GetCreator() string

func (*Instance) GetCustomGpuDriverPath

func (x *Instance) GetCustomGpuDriverPath() string

func (*Instance) GetDisks

func (x *Instance) GetDisks() []*Instance_Disk

func (*Instance) GetEnvironment

func (x *Instance) GetEnvironment() isInstance_Environment

func (*Instance) GetInstallGpuDriver

func (x *Instance) GetInstallGpuDriver() bool

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

func (x *Instance) GetNicType() Instance_NicType

func (*Instance) GetNoProxyAccess

func (x *Instance) GetNoProxyAccess() bool

func (*Instance) GetNoPublicIp

func (x *Instance) GetNoPublicIp() bool

func (*Instance) GetPostStartupScript

func (x *Instance) GetPostStartupScript() string

func (*Instance) GetProxyUri

func (x *Instance) GetProxyUri() string

func (*Instance) GetReservationAffinity

func (x *Instance) GetReservationAffinity() *ReservationAffinity

func (*Instance) GetServiceAccount

func (x *Instance) GetServiceAccount() string

func (*Instance) GetServiceAccountScopes

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

func (*Instance) GetShieldedInstanceConfig

func (x *Instance) GetShieldedInstanceConfig() *Instance_ShieldedInstanceConfig

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetSubnet

func (x *Instance) GetSubnet() string

func (*Instance) GetTags

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

func (*Instance) GetUpdateTime

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

func (*Instance) GetUpgradeHistory

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

func (*Instance) GetVmImage

func (x *Instance) GetVmImage() *VmImage

func (*Instance) HasAcceleratorConfig

func (x *Instance) HasAcceleratorConfig() bool

func (*Instance) HasContainerImage

func (x *Instance) HasContainerImage() bool

func (*Instance) HasCreateTime

func (x *Instance) HasCreateTime() bool

func (*Instance) HasEnvironment

func (x *Instance) HasEnvironment() bool

func (*Instance) HasReservationAffinity

func (x *Instance) HasReservationAffinity() bool

func (*Instance) HasShieldedInstanceConfig

func (x *Instance) HasShieldedInstanceConfig() bool

func (*Instance) HasUpdateTime

func (x *Instance) HasUpdateTime() bool

func (*Instance) HasVmImage

func (x *Instance) HasVmImage() bool

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) SetAcceleratorConfig

func (x *Instance) SetAcceleratorConfig(v *Instance_AcceleratorConfig)

func (*Instance) SetCanIpForward

func (x *Instance) SetCanIpForward(v bool)

func (*Instance) SetContainerImage

func (x *Instance) SetContainerImage(v *ContainerImage)

func (*Instance) SetCreateTime

func (x *Instance) SetCreateTime(v *timestamppb.Timestamp)

func (*Instance) SetCreator

func (x *Instance) SetCreator(v string)

func (*Instance) SetCustomGpuDriverPath

func (x *Instance) SetCustomGpuDriverPath(v string)

func (*Instance) SetDisks

func (x *Instance) SetDisks(v []*Instance_Disk)

func (*Instance) SetInstallGpuDriver

func (x *Instance) SetInstallGpuDriver(v bool)

func (*Instance) SetLabels

func (x *Instance) SetLabels(v map[string]string)

func (*Instance) SetMachineType

func (x *Instance) SetMachineType(v string)

func (*Instance) SetMetadata

func (x *Instance) SetMetadata(v map[string]string)

func (*Instance) SetName

func (x *Instance) SetName(v string)

func (*Instance) SetNetwork

func (x *Instance) SetNetwork(v string)

func (*Instance) SetNicType

func (x *Instance) SetNicType(v Instance_NicType)

func (*Instance) SetNoProxyAccess

func (x *Instance) SetNoProxyAccess(v bool)

func (*Instance) SetNoPublicIp

func (x *Instance) SetNoPublicIp(v bool)

func (*Instance) SetPostStartupScript

func (x *Instance) SetPostStartupScript(v string)

func (*Instance) SetProxyUri

func (x *Instance) SetProxyUri(v string)

func (*Instance) SetReservationAffinity

func (x *Instance) SetReservationAffinity(v *ReservationAffinity)

func (*Instance) SetServiceAccount

func (x *Instance) SetServiceAccount(v string)

func (*Instance) SetServiceAccountScopes

func (x *Instance) SetServiceAccountScopes(v []string)

func (*Instance) SetShieldedInstanceConfig

func (x *Instance) SetShieldedInstanceConfig(v *Instance_ShieldedInstanceConfig)

func (*Instance) SetState

func (x *Instance) SetState(v Instance_State)

func (*Instance) SetSubnet

func (x *Instance) SetSubnet(v string)

func (*Instance) SetTags

func (x *Instance) SetTags(v []string)

func (*Instance) SetUpdateTime

func (x *Instance) SetUpdateTime(v *timestamppb.Timestamp)

func (*Instance) SetUpgradeHistory

func (x *Instance) SetUpgradeHistory(v []*Instance_UpgradeHistoryEntry)

func (*Instance) SetVmImage

func (x *Instance) SetVmImage(v *VmImage)

func (*Instance) String

func (x *Instance) String() string

func (*Instance) WhichEnvironment

func (x *Instance) WhichEnvironment() case_Instance_Environment

type InstanceCreatedEvent

type InstanceCreatedEvent struct {

	// The data associated with the event.
	Data *InstanceEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Instance is created.

func (*InstanceCreatedEvent) ClearData

func (x *InstanceCreatedEvent) ClearData()

func (*InstanceCreatedEvent) GetData

func (*InstanceCreatedEvent) HasData

func (x *InstanceCreatedEvent) HasData() bool

func (*InstanceCreatedEvent) ProtoMessage

func (*InstanceCreatedEvent) ProtoMessage()

func (*InstanceCreatedEvent) ProtoReflect

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

func (*InstanceCreatedEvent) Reset

func (x *InstanceCreatedEvent) Reset()

func (*InstanceCreatedEvent) SetData

func (x *InstanceCreatedEvent) SetData(v *InstanceEventData)

func (*InstanceCreatedEvent) String

func (x *InstanceCreatedEvent) String() string

type InstanceCreatedEvent_builder

type InstanceCreatedEvent_builder struct {

	// The data associated with the event.
	Data *InstanceEventData
	// contains filtered or unexported fields
}

func (InstanceCreatedEvent_builder) Build

type InstanceDeletedEvent

type InstanceDeletedEvent struct {

	// The data associated with the event.
	Data *InstanceEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when an Instance is deleted.

func (*InstanceDeletedEvent) ClearData

func (x *InstanceDeletedEvent) ClearData()

func (*InstanceDeletedEvent) GetData

func (*InstanceDeletedEvent) HasData

func (x *InstanceDeletedEvent) HasData() bool

func (*InstanceDeletedEvent) ProtoMessage

func (*InstanceDeletedEvent) ProtoMessage()

func (*InstanceDeletedEvent) ProtoReflect

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

func (*InstanceDeletedEvent) Reset

func (x *InstanceDeletedEvent) Reset()

func (*InstanceDeletedEvent) SetData

func (x *InstanceDeletedEvent) SetData(v *InstanceEventData)

func (*InstanceDeletedEvent) String

func (x *InstanceDeletedEvent) String() string

type InstanceDeletedEvent_builder

type InstanceDeletedEvent_builder struct {

	// The data associated with the event.
	Data *InstanceEventData
	// contains filtered or unexported fields
}

func (InstanceDeletedEvent_builder) Build

type InstanceEventData

type InstanceEventData struct {

	// Optional. The Instance event payload. Unset for deletion events.
	Payload *Instance `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Instance events.

func (*InstanceEventData) ClearPayload

func (x *InstanceEventData) ClearPayload()

func (*InstanceEventData) GetPayload

func (x *InstanceEventData) GetPayload() *Instance

func (*InstanceEventData) HasPayload

func (x *InstanceEventData) HasPayload() bool

func (*InstanceEventData) ProtoMessage

func (*InstanceEventData) ProtoMessage()

func (*InstanceEventData) ProtoReflect

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

func (*InstanceEventData) Reset

func (x *InstanceEventData) Reset()

func (*InstanceEventData) SetPayload

func (x *InstanceEventData) SetPayload(v *Instance)

func (*InstanceEventData) String

func (x *InstanceEventData) String() string

type InstanceEventData_builder

type InstanceEventData_builder struct {

	// Optional. The Instance event payload. Unset for deletion events.
	Payload *Instance
	// contains filtered or unexported fields
}

func (InstanceEventData_builder) Build

type Instance_AcceleratorConfig

type Instance_AcceleratorConfig struct {

	// Type of this accelerator.
	Type Instance_AcceleratorType `protobuf:"varint,1,opt,name=type,proto3,enum=google.events.cloud.notebooks.v1.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. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.

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

func (x *Instance_AcceleratorConfig) SetCoreCount(v int64)

func (*Instance_AcceleratorConfig) SetType

func (*Instance_AcceleratorConfig) String

func (x *Instance_AcceleratorConfig) String() string

type Instance_AcceleratorConfig_builder

type Instance_AcceleratorConfig_builder struct {

	// Type of this accelerator.
	Type Instance_AcceleratorType
	// Count of cores of this accelerator.
	CoreCount int64
	// contains filtered or unexported fields
}

func (Instance_AcceleratorConfig_builder) Build

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 P4.
	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 A100.
	Instance_NVIDIA_TESLA_A100 Instance_AcceleratorType = 11
	// 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 P4 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) 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_Disk

type Instance_Disk struct {

	// Indicates whether the disk will be auto-deleted when the instance is
	// deleted (but not when the disk is detached from the instance).
	AutoDelete bool `protobuf:"varint,1,opt,name=auto_delete,json=autoDelete,proto3" json:"auto_delete,omitempty"`
	// Indicates that this is a boot disk. The virtual machine will use the
	// first partition of the disk for its root filesystem.
	Boot bool `protobuf:"varint,2,opt,name=boot,proto3" json:"boot,omitempty"`
	// Indicates a unique device name of your choice that is reflected into the
	// `/dev/disk/by-id/google-*` tree of a Linux operating system running
	// within the instance. This name can be used to reference the device for
	// mounting, resizing, and so on, from within the instance.
	//
	// If not specified, the server chooses a default device name to apply to
	// this disk, in the form persistent-disk-x, where x is a number assigned by
	// Google Compute Engine.This field is only applicable for persistent disks.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Indicates the size of the disk in base-2 GB.
	DiskSizeGb int64 `protobuf:"varint,4,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
	// Indicates a list of features to enable on the guest operating system.
	// Applicable only for bootable images. Read  Enabling guest operating
	// system features to see a list of available options.
	GuestOsFeatures []*Instance_Disk_GuestOsFeature `protobuf:"bytes,5,rep,name=guest_os_features,json=guestOsFeatures,proto3" json:"guest_os_features,omitempty"`
	// A zero-based index to this disk, where 0 is reserved for the
	// boot disk. If you have many disks attached to an instance, each disk
	// would have a unique index number.
	Index int64 `protobuf:"varint,6,opt,name=index,proto3" json:"index,omitempty"`
	// Indicates the disk interface to use for attaching this disk, which is
	// either SCSI or NVME. The default is SCSI. Persistent disks must always
	// use SCSI and the request will fail if you attempt to attach a persistent
	// disk in any other format than SCSI. Local SSDs can use either NVME or
	// SCSI. For performance characteristics of SCSI over NVMe, see Local SSD
	// performance.
	// Valid values:
	//
	// * `NVME`
	// * `SCSI`
	Interface string `protobuf:"bytes,7,opt,name=interface,proto3" json:"interface,omitempty"`
	// Type of the resource. Always compute#attachedDisk for attached
	// disks.
	Kind string `protobuf:"bytes,8,opt,name=kind,proto3" json:"kind,omitempty"`
	// A list of publicly visible licenses. Reserved for Google's use.
	// A License represents billing and aggregate usage data for public
	// and marketplace images.
	Licenses []string `protobuf:"bytes,9,rep,name=licenses,proto3" json:"licenses,omitempty"`
	// The mode in which to attach this disk, either `READ_WRITE` or
	// `READ_ONLY`. If not specified, the default is to attach the disk in
	// `READ_WRITE` mode. Valid values:
	//
	// * `READ_ONLY`
	// * `READ_WRITE`
	Mode string `protobuf:"bytes,10,opt,name=mode,proto3" json:"mode,omitempty"`
	// Indicates a valid partial or full URL to an existing Persistent Disk
	// resource.
	Source string `protobuf:"bytes,11,opt,name=source,proto3" json:"source,omitempty"`
	// Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
	// Valid values:
	//
	// * `PERSISTENT`
	// * `SCRATCH`
	Type string `protobuf:"bytes,12,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

An instance-attached disk resource.

func (*Instance_Disk) GetAutoDelete

func (x *Instance_Disk) GetAutoDelete() bool

func (*Instance_Disk) GetBoot

func (x *Instance_Disk) GetBoot() bool

func (*Instance_Disk) GetDeviceName

func (x *Instance_Disk) GetDeviceName() string

func (*Instance_Disk) GetDiskSizeGb

func (x *Instance_Disk) GetDiskSizeGb() int64

func (*Instance_Disk) GetGuestOsFeatures

func (x *Instance_Disk) GetGuestOsFeatures() []*Instance_Disk_GuestOsFeature

func (*Instance_Disk) GetIndex

func (x *Instance_Disk) GetIndex() int64

func (*Instance_Disk) GetInterface

func (x *Instance_Disk) GetInterface() string

func (*Instance_Disk) GetKind

func (x *Instance_Disk) GetKind() string

func (*Instance_Disk) GetLicenses

func (x *Instance_Disk) GetLicenses() []string

func (*Instance_Disk) GetMode

func (x *Instance_Disk) GetMode() string

func (*Instance_Disk) GetSource

func (x *Instance_Disk) GetSource() string

func (*Instance_Disk) GetType

func (x *Instance_Disk) GetType() string

func (*Instance_Disk) ProtoMessage

func (*Instance_Disk) ProtoMessage()

func (*Instance_Disk) ProtoReflect

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

func (*Instance_Disk) Reset

func (x *Instance_Disk) Reset()

func (*Instance_Disk) SetAutoDelete

func (x *Instance_Disk) SetAutoDelete(v bool)

func (*Instance_Disk) SetBoot

func (x *Instance_Disk) SetBoot(v bool)

func (*Instance_Disk) SetDeviceName

func (x *Instance_Disk) SetDeviceName(v string)

func (*Instance_Disk) SetDiskSizeGb

func (x *Instance_Disk) SetDiskSizeGb(v int64)

func (*Instance_Disk) SetGuestOsFeatures

func (x *Instance_Disk) SetGuestOsFeatures(v []*Instance_Disk_GuestOsFeature)

func (*Instance_Disk) SetIndex

func (x *Instance_Disk) SetIndex(v int64)

func (*Instance_Disk) SetInterface

func (x *Instance_Disk) SetInterface(v string)

func (*Instance_Disk) SetKind

func (x *Instance_Disk) SetKind(v string)

func (*Instance_Disk) SetLicenses

func (x *Instance_Disk) SetLicenses(v []string)

func (*Instance_Disk) SetMode

func (x *Instance_Disk) SetMode(v string)

func (*Instance_Disk) SetSource

func (x *Instance_Disk) SetSource(v string)

func (*Instance_Disk) SetType

func (x *Instance_Disk) SetType(v string)

func (*Instance_Disk) String

func (x *Instance_Disk) String() string

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) 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
	// Extreme persistent disk type.
	Instance_PD_EXTREME Instance_DiskType = 4
)

func (Instance_DiskType) Descriptor

func (Instance_DiskType) Enum

func (Instance_DiskType) Number

func (Instance_DiskType) String

func (x Instance_DiskType) String() string

func (Instance_DiskType) Type

type Instance_Disk_GuestOsFeature

type Instance_Disk_GuestOsFeature struct {

	// The ID of a supported feature. Read  Enabling guest operating system
	// features to see a list of available options.
	// Valid values:
	//
	// * `FEATURE_TYPE_UNSPECIFIED`
	// * `MULTI_IP_SUBNET`
	// * `SECURE_BOOT`
	// * `UEFI_COMPATIBLE`
	// * `VIRTIO_SCSI_MULTIQUEUE`
	// * `WINDOWS`
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Guest OS features for boot disk.

func (*Instance_Disk_GuestOsFeature) GetType

func (x *Instance_Disk_GuestOsFeature) GetType() string

func (*Instance_Disk_GuestOsFeature) ProtoMessage

func (*Instance_Disk_GuestOsFeature) ProtoMessage()

func (*Instance_Disk_GuestOsFeature) ProtoReflect

func (*Instance_Disk_GuestOsFeature) Reset

func (x *Instance_Disk_GuestOsFeature) Reset()

func (*Instance_Disk_GuestOsFeature) SetType

func (x *Instance_Disk_GuestOsFeature) SetType(v string)

func (*Instance_Disk_GuestOsFeature) String

type Instance_Disk_GuestOsFeature_builder

type Instance_Disk_GuestOsFeature_builder struct {

	// The ID of a supported feature. Read  Enabling guest operating system
	// features to see a list of available options.
	// Valid values:
	//
	// * `FEATURE_TYPE_UNSPECIFIED`
	// * `MULTI_IP_SUBNET`
	// * `SECURE_BOOT`
	// * `UEFI_COMPATIBLE`
	// * `VIRTIO_SCSI_MULTIQUEUE`
	// * `WINDOWS`
	Type string
	// contains filtered or unexported fields
}

func (Instance_Disk_GuestOsFeature_builder) Build

type Instance_Disk_builder

type Instance_Disk_builder struct {

	// Indicates whether the disk will be auto-deleted when the instance is
	// deleted (but not when the disk is detached from the instance).
	AutoDelete bool
	// Indicates that this is a boot disk. The virtual machine will use the
	// first partition of the disk for its root filesystem.
	Boot bool
	// Indicates a unique device name of your choice that is reflected into the
	// `/dev/disk/by-id/google-*` tree of a Linux operating system running
	// within the instance. This name can be used to reference the device for
	// mounting, resizing, and so on, from within the instance.
	//
	// If not specified, the server chooses a default device name to apply to
	// this disk, in the form persistent-disk-x, where x is a number assigned by
	// Google Compute Engine.This field is only applicable for persistent disks.
	DeviceName string
	// Indicates the size of the disk in base-2 GB.
	DiskSizeGb int64
	// Indicates a list of features to enable on the guest operating system.
	// Applicable only for bootable images. Read  Enabling guest operating
	// system features to see a list of available options.
	GuestOsFeatures []*Instance_Disk_GuestOsFeature
	// A zero-based index to this disk, where 0 is reserved for the
	// boot disk. If you have many disks attached to an instance, each disk
	// would have a unique index number.
	Index int64
	// Indicates the disk interface to use for attaching this disk, which is
	// either SCSI or NVME. The default is SCSI. Persistent disks must always
	// use SCSI and the request will fail if you attempt to attach a persistent
	// disk in any other format than SCSI. Local SSDs can use either NVME or
	// SCSI. For performance characteristics of SCSI over NVMe, see Local SSD
	// performance.
	// Valid values:
	//
	// * `NVME`
	// * `SCSI`
	Interface string
	// Type of the resource. Always compute#attachedDisk for attached
	// disks.
	Kind string
	// A list of publicly visible licenses. Reserved for Google's use.
	// A License represents billing and aggregate usage data for public
	// and marketplace images.
	Licenses []string
	// The mode in which to attach this disk, either `READ_WRITE` or
	// `READ_ONLY`. If not specified, the default is to attach the disk in
	// `READ_WRITE` mode. Valid values:
	//
	// * `READ_ONLY`
	// * `READ_WRITE`
	Mode string
	// Indicates a valid partial or full URL to an existing Persistent Disk
	// resource.
	Source string
	// Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
	// Valid values:
	//
	// * `PERSISTENT`
	// * `SCRATCH`
	Type string
	// contains filtered or unexported fields
}

func (Instance_Disk_builder) Build

type Instance_NicType

type Instance_NicType int32

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

const (
	// No type specified.
	Instance_UNSPECIFIED_NIC_TYPE Instance_NicType = 0
	// VIRTIO
	Instance_VIRTIO_NET Instance_NicType = 1
	// GVNIC
	Instance_GVNIC Instance_NicType = 2
)

func (Instance_NicType) Descriptor

func (Instance_NicType) Enum

func (Instance_NicType) Number

func (Instance_NicType) String

func (x Instance_NicType) String() string

func (Instance_NicType) Type

type Instance_ShieldedInstanceConfig

type Instance_ShieldedInstanceConfig struct {

	// Defines whether the 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"`
	// Defines whether the instance has the vTPM enabled. Enabled by default.
	EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
	// Defines whether the instance has integrity monitoring enabled.
	//
	// Enables monitoring and attestation of the boot integrity of the instance.
	// The attestation is performed against the integrity policy baseline. This
	// baseline is initially derived from the implicitly trusted boot image when
	// the instance is created. Enabled by default.
	EnableIntegrityMonitoring bool `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid.

func (*Instance_ShieldedInstanceConfig) GetEnableIntegrityMonitoring

func (x *Instance_ShieldedInstanceConfig) GetEnableIntegrityMonitoring() bool

func (*Instance_ShieldedInstanceConfig) GetEnableSecureBoot

func (x *Instance_ShieldedInstanceConfig) GetEnableSecureBoot() bool

func (*Instance_ShieldedInstanceConfig) GetEnableVtpm

func (x *Instance_ShieldedInstanceConfig) GetEnableVtpm() bool

func (*Instance_ShieldedInstanceConfig) ProtoMessage

func (*Instance_ShieldedInstanceConfig) ProtoMessage()

func (*Instance_ShieldedInstanceConfig) ProtoReflect

func (*Instance_ShieldedInstanceConfig) Reset

func (*Instance_ShieldedInstanceConfig) SetEnableIntegrityMonitoring

func (x *Instance_ShieldedInstanceConfig) SetEnableIntegrityMonitoring(v bool)

func (*Instance_ShieldedInstanceConfig) SetEnableSecureBoot

func (x *Instance_ShieldedInstanceConfig) SetEnableSecureBoot(v bool)

func (*Instance_ShieldedInstanceConfig) SetEnableVtpm

func (x *Instance_ShieldedInstanceConfig) SetEnableVtpm(v bool)

func (*Instance_ShieldedInstanceConfig) String

type Instance_ShieldedInstanceConfig_builder

type Instance_ShieldedInstanceConfig_builder struct {

	// Defines whether the 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
	// Defines whether the instance has the vTPM enabled. Enabled by default.
	EnableVtpm bool
	// Defines whether the instance has integrity monitoring enabled.
	//
	// Enables monitoring and attestation of the boot integrity of the instance.
	// The attestation is performed against the integrity policy baseline. This
	// baseline is initially derived from the implicitly trusted boot image when
	// the instance is created. Enabled by default.
	EnableIntegrityMonitoring bool
	// contains filtered or unexported fields
}

func (Instance_ShieldedInstanceConfig_builder) Build

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
	// The instance is suspending.
	Instance_SUSPENDING Instance_State = 10
	// The instance is suspended.
	Instance_SUSPENDED Instance_State = 11
)

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

type Instance_UpgradeHistoryEntry

type Instance_UpgradeHistoryEntry struct {

	// The snapshot of the boot disk of this notebook instance before upgrade.
	Snapshot string `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
	// The VM image before this instance upgrade.
	VmImage string `protobuf:"bytes,2,opt,name=vm_image,json=vmImage,proto3" json:"vm_image,omitempty"`
	// The container image before this instance upgrade.
	ContainerImage string `protobuf:"bytes,3,opt,name=container_image,json=containerImage,proto3" json:"container_image,omitempty"`
	// The framework of this notebook instance.
	Framework string `protobuf:"bytes,4,opt,name=framework,proto3" json:"framework,omitempty"`
	// The version of the notebook instance before this upgrade.
	Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
	// The state of this instance upgrade history entry.
	State Instance_UpgradeHistoryEntry_State `` /* 137-byte string literal not displayed */
	// 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"`
	// Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
	TargetImage string `protobuf:"bytes,8,opt,name=target_image,json=targetImage,proto3" json:"target_image,omitempty"`
	// Action. Rolloback or Upgrade.
	Action Instance_UpgradeHistoryEntry_Action `` /* 140-byte string literal not displayed */
	// Target VM Version, like m63.
	TargetVersion string `protobuf:"bytes,10,opt,name=target_version,json=targetVersion,proto3" json:"target_version,omitempty"`
	// contains filtered or unexported fields
}

The entry of VM image upgrade history.

func (*Instance_UpgradeHistoryEntry) ClearCreateTime

func (x *Instance_UpgradeHistoryEntry) ClearCreateTime()

func (*Instance_UpgradeHistoryEntry) GetAction

func (*Instance_UpgradeHistoryEntry) GetContainerImage

func (x *Instance_UpgradeHistoryEntry) GetContainerImage() string

func (*Instance_UpgradeHistoryEntry) GetCreateTime

func (*Instance_UpgradeHistoryEntry) GetFramework

func (x *Instance_UpgradeHistoryEntry) GetFramework() string

func (*Instance_UpgradeHistoryEntry) GetSnapshot

func (x *Instance_UpgradeHistoryEntry) GetSnapshot() string

func (*Instance_UpgradeHistoryEntry) GetState

func (*Instance_UpgradeHistoryEntry) GetTargetImage

func (x *Instance_UpgradeHistoryEntry) GetTargetImage() string

func (*Instance_UpgradeHistoryEntry) GetTargetVersion

func (x *Instance_UpgradeHistoryEntry) GetTargetVersion() string

func (*Instance_UpgradeHistoryEntry) GetVersion

func (x *Instance_UpgradeHistoryEntry) GetVersion() string

func (*Instance_UpgradeHistoryEntry) GetVmImage

func (x *Instance_UpgradeHistoryEntry) GetVmImage() string

func (*Instance_UpgradeHistoryEntry) HasCreateTime

func (x *Instance_UpgradeHistoryEntry) HasCreateTime() bool

func (*Instance_UpgradeHistoryEntry) ProtoMessage

func (*Instance_UpgradeHistoryEntry) ProtoMessage()

func (*Instance_UpgradeHistoryEntry) ProtoReflect

func (*Instance_UpgradeHistoryEntry) Reset

func (x *Instance_UpgradeHistoryEntry) Reset()

func (*Instance_UpgradeHistoryEntry) SetAction

func (*Instance_UpgradeHistoryEntry) SetContainerImage

func (x *Instance_UpgradeHistoryEntry) SetContainerImage(v string)

func (*Instance_UpgradeHistoryEntry) SetCreateTime

func (x *Instance_UpgradeHistoryEntry) SetCreateTime(v *timestamppb.Timestamp)

func (*Instance_UpgradeHistoryEntry) SetFramework

func (x *Instance_UpgradeHistoryEntry) SetFramework(v string)

func (*Instance_UpgradeHistoryEntry) SetSnapshot

func (x *Instance_UpgradeHistoryEntry) SetSnapshot(v string)

func (*Instance_UpgradeHistoryEntry) SetState

func (*Instance_UpgradeHistoryEntry) SetTargetImage

func (x *Instance_UpgradeHistoryEntry) SetTargetImage(v string)

func (*Instance_UpgradeHistoryEntry) SetTargetVersion

func (x *Instance_UpgradeHistoryEntry) SetTargetVersion(v string)

func (*Instance_UpgradeHistoryEntry) SetVersion

func (x *Instance_UpgradeHistoryEntry) SetVersion(v string)

func (*Instance_UpgradeHistoryEntry) SetVmImage

func (x *Instance_UpgradeHistoryEntry) SetVmImage(v string)

func (*Instance_UpgradeHistoryEntry) String

type Instance_UpgradeHistoryEntry_Action

type Instance_UpgradeHistoryEntry_Action int32

The definition of operations of this upgrade history entry.

const (
	// Operation is not specified.
	Instance_UpgradeHistoryEntry_ACTION_UNSPECIFIED Instance_UpgradeHistoryEntry_Action = 0
	// Upgrade.
	Instance_UpgradeHistoryEntry_UPGRADE Instance_UpgradeHistoryEntry_Action = 1
	// Rollback.
	Instance_UpgradeHistoryEntry_ROLLBACK Instance_UpgradeHistoryEntry_Action = 2
)

func (Instance_UpgradeHistoryEntry_Action) Descriptor

func (Instance_UpgradeHistoryEntry_Action) Enum

func (Instance_UpgradeHistoryEntry_Action) Number

func (Instance_UpgradeHistoryEntry_Action) String

func (Instance_UpgradeHistoryEntry_Action) Type

type Instance_UpgradeHistoryEntry_State

type Instance_UpgradeHistoryEntry_State int32

The definition of the states of this upgrade history entry.

const (
	// State is not specified.
	Instance_UpgradeHistoryEntry_STATE_UNSPECIFIED Instance_UpgradeHistoryEntry_State = 0
	// The instance upgrade is started.
	Instance_UpgradeHistoryEntry_STARTED Instance_UpgradeHistoryEntry_State = 1
	// The instance upgrade is succeeded.
	Instance_UpgradeHistoryEntry_SUCCEEDED Instance_UpgradeHistoryEntry_State = 2
	// The instance upgrade is failed.
	Instance_UpgradeHistoryEntry_FAILED Instance_UpgradeHistoryEntry_State = 3
)

func (Instance_UpgradeHistoryEntry_State) Descriptor

func (Instance_UpgradeHistoryEntry_State) Enum

func (Instance_UpgradeHistoryEntry_State) Number

func (Instance_UpgradeHistoryEntry_State) String

func (Instance_UpgradeHistoryEntry_State) Type

type Instance_UpgradeHistoryEntry_builder

type Instance_UpgradeHistoryEntry_builder struct {

	// The snapshot of the boot disk of this notebook instance before upgrade.
	Snapshot string
	// The VM image before this instance upgrade.
	VmImage string
	// The container image before this instance upgrade.
	ContainerImage string
	// The framework of this notebook instance.
	Framework string
	// The version of the notebook instance before this upgrade.
	Version string
	// The state of this instance upgrade history entry.
	State Instance_UpgradeHistoryEntry_State
	// The time that this instance upgrade history entry is created.
	CreateTime *timestamppb.Timestamp
	// Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
	TargetImage string
	// Action. Rolloback or Upgrade.
	Action Instance_UpgradeHistoryEntry_Action
	// Target VM Version, like m63.
	TargetVersion string
	// contains filtered or unexported fields
}

func (Instance_UpgradeHistoryEntry_builder) Build

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 Instance_builder

type Instance_builder struct {

	// Output only. The name of this notebook instance. Format:
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`
	Name string

	// Fields of oneof Environment:
	// Use a Compute Engine VM image to start the notebook instance.
	VmImage *VmImage
	// Use a container image to start the notebook instance.
	ContainerImage *ContainerImage
	// -- end of 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
	// Output only. The proxy endpoint that is used to access the Jupyter
	// notebook.
	ProxyUri string
	// 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
	// Optional. The URIs of service account scopes to be included in
	// Compute Engine instances.
	//
	// If not specified, the following
	// [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
	// are defined:
	//   - https://www.googleapis.com/auth/cloud-platform
	//   - https://www.googleapis.com/auth/userinfo.email
	//
	// If not using default scopes, you need at least:
	//
	//	https://www.googleapis.com/auth/compute
	ServiceAccountScopes []string
	// Required. The [Compute Engine machine
	// type](https://cloud.google.com/compute/docs/machine-types) of this
	// instance.
	MachineType string
	// 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
	// Output only. The state of this instance.
	State Instance_State
	// 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
	// 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
	// Output only. Attached disks to notebook instance.
	Disks []*Instance_Disk
	// Optional. Shielded VM configuration.
	// [Images using supported Shielded VM
	// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
	ShieldedInstanceConfig *Instance_ShieldedInstanceConfig
	// If true, no external IP will be assigned to this instance.
	NoPublicIp bool
	// If true, the notebook instance will not register with the proxy.
	NoProxyAccess bool
	// The name of the VPC that this instance is in.
	// Format:
	// `projects/{project_id}/global/networks/{network_id}`
	Network string
	// The name of the subnet that this instance is in.
	// Format:
	// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
	Subnet string
	// Labels to apply to this instance.
	// These can be later modified by the setLabels method.
	Labels map[string]string
	// Custom metadata to apply to this instance.
	Metadata map[string]string
	// 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
	// The upgrade history of this instance.
	UpgradeHistory []*Instance_UpgradeHistoryEntry
	// Optional. The type of vNIC to be used on this interface. This may be gVNIC
	// or VirtioNet.
	NicType Instance_NicType
	// Optional. The optional reservation affinity. Setting this field will apply
	// the specified [Zonal Compute
	// Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
	// to this notebook instance.
	ReservationAffinity *ReservationAffinity
	// Output only. Email address of entity that sent original CreateInstance
	// request.
	Creator string
	// Optional. Flag to enable ip forwarding or not, default false/off.
	// https://cloud.google.com/vpc/docs/using-routes#canipforward
	CanIpForward bool
	// Output only. Instance creation time.
	CreateTime *timestamppb.Timestamp
	// Output only. Instance update time.
	UpdateTime *timestamppb.Timestamp
	// contains filtered or unexported fields
}

func (Instance_builder) Build

func (b0 Instance_builder) Build() *Instance

type LocalDisk

type LocalDisk struct {

	// Optional. Output only. Specifies whether the disk will be auto-deleted when
	// the instance is deleted (but not when the disk is detached from the
	// instance).
	AutoDelete bool `protobuf:"varint,1,opt,name=auto_delete,json=autoDelete,proto3" json:"auto_delete,omitempty"`
	// Optional. Output only. Indicates that this is a boot disk. The virtual
	// machine will use the first partition of the disk for its root filesystem.
	Boot bool `protobuf:"varint,2,opt,name=boot,proto3" json:"boot,omitempty"`
	// Optional. Output only. Specifies a unique device name
	// of your choice that is reflected into the
	// `/dev/disk/by-id/google-*` tree of a Linux operating system running within
	// the instance. This name can be used to reference the device for mounting,
	// resizing, and so on, from within the instance.
	//
	// If not specified, the server chooses a default device name to apply to this
	// disk, in the form persistent-disk-x, where x is a number assigned by Google
	// Compute Engine. This field is only applicable for persistent disks.
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// Output only. Indicates a list of features to enable on the guest operating
	// system. Applicable only for bootable images. Read  Enabling guest operating
	// system features to see a list of available options.
	GuestOsFeatures []*LocalDisk_RuntimeGuestOsFeature `protobuf:"bytes,4,rep,name=guest_os_features,json=guestOsFeatures,proto3" json:"guest_os_features,omitempty"`
	// Output only. A zero-based index to this disk, where 0 is reserved for the
	// boot disk. If you have many disks attached to an instance, each disk would
	// have a unique index number.
	Index int32 `protobuf:"varint,5,opt,name=index,proto3" json:"index,omitempty"`
	// Specifies the disk interface to use for attaching this disk, which is
	// either SCSI or NVME. The default is SCSI. Persistent disks must always use
	// SCSI and the request will fail if you attempt to attach a persistent disk
	// in any other format than SCSI. Local SSDs can use either NVME or SCSI. For
	// performance characteristics of SCSI over NVMe, see Local SSD performance.
	// Valid values:
	//
	// * `NVME`
	// * `SCSI`
	Interface string `protobuf:"bytes,7,opt,name=interface,proto3" json:"interface,omitempty"`
	// Output only. Type of the resource. Always compute#attachedDisk for attached
	// disks.
	Kind string `protobuf:"bytes,8,opt,name=kind,proto3" json:"kind,omitempty"`
	// Output only. Any valid publicly visible licenses.
	Licenses []string `protobuf:"bytes,9,rep,name=licenses,proto3" json:"licenses,omitempty"`
	// The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
	// If not specified, the default is to attach the disk in `READ_WRITE` mode.
	// Valid values:
	//
	// * `READ_ONLY`
	// * `READ_WRITE`
	Mode string `protobuf:"bytes,10,opt,name=mode,proto3" json:"mode,omitempty"`
	// Specifies a valid partial or full URL to an existing Persistent Disk
	// resource.
	Source string `protobuf:"bytes,11,opt,name=source,proto3" json:"source,omitempty"`
	// Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
	// specified, the default is `PERSISTENT`.
	// Valid values:
	//
	// * `PERSISTENT`
	// * `SCRATCH`
	Type string `protobuf:"bytes,12,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

A Local attached disk resource.

func (*LocalDisk) GetAutoDelete

func (x *LocalDisk) GetAutoDelete() bool

func (*LocalDisk) GetBoot

func (x *LocalDisk) GetBoot() bool

func (*LocalDisk) GetDeviceName

func (x *LocalDisk) GetDeviceName() string

func (*LocalDisk) GetGuestOsFeatures

func (x *LocalDisk) GetGuestOsFeatures() []*LocalDisk_RuntimeGuestOsFeature

func (*LocalDisk) GetIndex

func (x *LocalDisk) GetIndex() int32

func (*LocalDisk) GetInterface

func (x *LocalDisk) GetInterface() string

func (*LocalDisk) GetKind

func (x *LocalDisk) GetKind() string

func (*LocalDisk) GetLicenses

func (x *LocalDisk) GetLicenses() []string

func (*LocalDisk) GetMode

func (x *LocalDisk) GetMode() string

func (*LocalDisk) GetSource

func (x *LocalDisk) GetSource() string

func (*LocalDisk) GetType

func (x *LocalDisk) GetType() string

func (*LocalDisk) ProtoMessage

func (*LocalDisk) ProtoMessage()

func (*LocalDisk) ProtoReflect

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

func (*LocalDisk) Reset

func (x *LocalDisk) Reset()

func (*LocalDisk) SetAutoDelete

func (x *LocalDisk) SetAutoDelete(v bool)

func (*LocalDisk) SetBoot

func (x *LocalDisk) SetBoot(v bool)

func (*LocalDisk) SetDeviceName

func (x *LocalDisk) SetDeviceName(v string)

func (*LocalDisk) SetGuestOsFeatures

func (x *LocalDisk) SetGuestOsFeatures(v []*LocalDisk_RuntimeGuestOsFeature)

func (*LocalDisk) SetIndex

func (x *LocalDisk) SetIndex(v int32)

func (*LocalDisk) SetInterface

func (x *LocalDisk) SetInterface(v string)

func (*LocalDisk) SetKind

func (x *LocalDisk) SetKind(v string)

func (*LocalDisk) SetLicenses

func (x *LocalDisk) SetLicenses(v []string)

func (*LocalDisk) SetMode

func (x *LocalDisk) SetMode(v string)

func (*LocalDisk) SetSource

func (x *LocalDisk) SetSource(v string)

func (*LocalDisk) SetType

func (x *LocalDisk) SetType(v string)

func (*LocalDisk) String

func (x *LocalDisk) String() string

type LocalDiskInitializeParams

type LocalDiskInitializeParams struct {

	// Optional. Provide this property when creating the disk.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Specifies the disk name. If not specified, the default is to use
	// the name of the instance. If the disk with the instance name exists already
	// in the given zone/region, a new name will be automatically generated.
	DiskName string `protobuf:"bytes,2,opt,name=disk_name,json=diskName,proto3" json:"disk_name,omitempty"`
	// Optional. Specifies the size of the disk in base-2 GB. If not specified,
	// the disk will be the same size as the image (usually 10GB). If specified,
	// the size must be equal to or larger than 10GB. Default 100 GB.
	DiskSizeGb int64 `protobuf:"varint,3,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
	// Optional. Labels to apply to this disk. These can be later modified by the
	// disks.setLabels method. This field is only applicable for persistent disks.
	Labels map[string]string `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

func (*LocalDiskInitializeParams) GetDescription

func (x *LocalDiskInitializeParams) GetDescription() string

func (*LocalDiskInitializeParams) GetDiskName

func (x *LocalDiskInitializeParams) GetDiskName() string

func (*LocalDiskInitializeParams) GetDiskSizeGb

func (x *LocalDiskInitializeParams) GetDiskSizeGb() int64

func (*LocalDiskInitializeParams) GetLabels

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

func (*LocalDiskInitializeParams) ProtoMessage

func (*LocalDiskInitializeParams) ProtoMessage()

func (*LocalDiskInitializeParams) ProtoReflect

func (*LocalDiskInitializeParams) Reset

func (x *LocalDiskInitializeParams) Reset()

func (*LocalDiskInitializeParams) SetDescription

func (x *LocalDiskInitializeParams) SetDescription(v string)

func (*LocalDiskInitializeParams) SetDiskName

func (x *LocalDiskInitializeParams) SetDiskName(v string)

func (*LocalDiskInitializeParams) SetDiskSizeGb

func (x *LocalDiskInitializeParams) SetDiskSizeGb(v int64)

func (*LocalDiskInitializeParams) SetLabels

func (x *LocalDiskInitializeParams) SetLabels(v map[string]string)

func (*LocalDiskInitializeParams) String

func (x *LocalDiskInitializeParams) String() string

type LocalDiskInitializeParams_DiskType

type LocalDiskInitializeParams_DiskType int32

Possible disk types.

const (
	// Disk type not set.
	LocalDiskInitializeParams_DISK_TYPE_UNSPECIFIED LocalDiskInitializeParams_DiskType = 0
	// Standard persistent disk type.
	LocalDiskInitializeParams_PD_STANDARD LocalDiskInitializeParams_DiskType = 1
	// SSD persistent disk type.
	LocalDiskInitializeParams_PD_SSD LocalDiskInitializeParams_DiskType = 2
	// Balanced persistent disk type.
	LocalDiskInitializeParams_PD_BALANCED LocalDiskInitializeParams_DiskType = 3
	// Extreme persistent disk type.
	LocalDiskInitializeParams_PD_EXTREME LocalDiskInitializeParams_DiskType = 4
)

func (LocalDiskInitializeParams_DiskType) Descriptor

func (LocalDiskInitializeParams_DiskType) Enum

func (LocalDiskInitializeParams_DiskType) Number

func (LocalDiskInitializeParams_DiskType) String

func (LocalDiskInitializeParams_DiskType) Type

type LocalDiskInitializeParams_builder

type LocalDiskInitializeParams_builder struct {

	// Optional. Provide this property when creating the disk.
	Description string
	// Optional. Specifies the disk name. If not specified, the default is to use
	// the name of the instance. If the disk with the instance name exists already
	// in the given zone/region, a new name will be automatically generated.
	DiskName string
	// Optional. Specifies the size of the disk in base-2 GB. If not specified,
	// the disk will be the same size as the image (usually 10GB). If specified,
	// the size must be equal to or larger than 10GB. Default 100 GB.
	DiskSizeGb int64
	// Optional. Labels to apply to this disk. These can be later modified by the
	// disks.setLabels method. This field is only applicable for persistent disks.
	Labels map[string]string
	// contains filtered or unexported fields
}

func (LocalDiskInitializeParams_builder) Build

type LocalDisk_RuntimeGuestOsFeature

type LocalDisk_RuntimeGuestOsFeature struct {

	// The ID of a supported feature. Read [Enabling guest operating system
	// features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
	// to see a list of available options.
	//
	// Valid values:
	//
	// * `FEATURE_TYPE_UNSPECIFIED`
	// * `MULTI_IP_SUBNET`
	// * `SECURE_BOOT`
	// * `UEFI_COMPATIBLE`
	// * `VIRTIO_SCSI_MULTIQUEUE`
	// * `WINDOWS`
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features for boot disk.

func (*LocalDisk_RuntimeGuestOsFeature) GetType

func (*LocalDisk_RuntimeGuestOsFeature) ProtoMessage

func (*LocalDisk_RuntimeGuestOsFeature) ProtoMessage()

func (*LocalDisk_RuntimeGuestOsFeature) ProtoReflect

func (*LocalDisk_RuntimeGuestOsFeature) Reset

func (*LocalDisk_RuntimeGuestOsFeature) SetType

func (*LocalDisk_RuntimeGuestOsFeature) String

type LocalDisk_RuntimeGuestOsFeature_builder

type LocalDisk_RuntimeGuestOsFeature_builder struct {

	// The ID of a supported feature. Read [Enabling guest operating system
	// features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
	// to see a list of available options.
	//
	// Valid values:
	//
	// * `FEATURE_TYPE_UNSPECIFIED`
	// * `MULTI_IP_SUBNET`
	// * `SECURE_BOOT`
	// * `UEFI_COMPATIBLE`
	// * `VIRTIO_SCSI_MULTIQUEUE`
	// * `WINDOWS`
	Type string
	// contains filtered or unexported fields
}

func (LocalDisk_RuntimeGuestOsFeature_builder) Build

type LocalDisk_builder

type LocalDisk_builder struct {

	// Optional. Output only. Specifies whether the disk will be auto-deleted when
	// the instance is deleted (but not when the disk is detached from the
	// instance).
	AutoDelete bool
	// Optional. Output only. Indicates that this is a boot disk. The virtual
	// machine will use the first partition of the disk for its root filesystem.
	Boot bool
	// Optional. Output only. Specifies a unique device name
	// of your choice that is reflected into the
	// `/dev/disk/by-id/google-*` tree of a Linux operating system running within
	// the instance. This name can be used to reference the device for mounting,
	// resizing, and so on, from within the instance.
	//
	// If not specified, the server chooses a default device name to apply to this
	// disk, in the form persistent-disk-x, where x is a number assigned by Google
	// Compute Engine. This field is only applicable for persistent disks.
	DeviceName string
	// Output only. Indicates a list of features to enable on the guest operating
	// system. Applicable only for bootable images. Read  Enabling guest operating
	// system features to see a list of available options.
	GuestOsFeatures []*LocalDisk_RuntimeGuestOsFeature
	// Output only. A zero-based index to this disk, where 0 is reserved for the
	// boot disk. If you have many disks attached to an instance, each disk would
	// have a unique index number.
	Index int32
	// Specifies the disk interface to use for attaching this disk, which is
	// either SCSI or NVME. The default is SCSI. Persistent disks must always use
	// SCSI and the request will fail if you attempt to attach a persistent disk
	// in any other format than SCSI. Local SSDs can use either NVME or SCSI. For
	// performance characteristics of SCSI over NVMe, see Local SSD performance.
	// Valid values:
	//
	// * `NVME`
	// * `SCSI`
	Interface string
	// Output only. Type of the resource. Always compute#attachedDisk for attached
	// disks.
	Kind string
	// Output only. Any valid publicly visible licenses.
	Licenses []string
	// The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
	// If not specified, the default is to attach the disk in `READ_WRITE` mode.
	// Valid values:
	//
	// * `READ_ONLY`
	// * `READ_WRITE`
	Mode string
	// Specifies a valid partial or full URL to an existing Persistent Disk
	// resource.
	Source string
	// Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
	// specified, the default is `PERSISTENT`.
	// Valid values:
	//
	// * `PERSISTENT`
	// * `SCRATCH`
	Type string
	// contains filtered or unexported fields
}

func (LocalDisk_builder) Build

func (b0 LocalDisk_builder) Build() *LocalDisk

type ReservationAffinity

type ReservationAffinity struct {

	// Optional. Type of reservation to consume
	ConsumeReservationType ReservationAffinity_Type `` /* 193-byte string literal not displayed */
	// Optional. Corresponds to the label key of reservation resource.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Optional. Corresponds to the label values of reservation resource.
	Values []string `protobuf:"bytes,3,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Reservation Affinity for consuming Zonal reservation.

func (*ReservationAffinity) GetConsumeReservationType

func (x *ReservationAffinity) GetConsumeReservationType() ReservationAffinity_Type

func (*ReservationAffinity) GetKey

func (x *ReservationAffinity) GetKey() string

func (*ReservationAffinity) GetValues

func (x *ReservationAffinity) GetValues() []string

func (*ReservationAffinity) ProtoMessage

func (*ReservationAffinity) ProtoMessage()

func (*ReservationAffinity) ProtoReflect

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

func (*ReservationAffinity) Reset

func (x *ReservationAffinity) Reset()

func (*ReservationAffinity) SetConsumeReservationType

func (x *ReservationAffinity) SetConsumeReservationType(v ReservationAffinity_Type)

func (*ReservationAffinity) SetKey

func (x *ReservationAffinity) SetKey(v string)

func (*ReservationAffinity) SetValues

func (x *ReservationAffinity) SetValues(v []string)

func (*ReservationAffinity) String

func (x *ReservationAffinity) String() string

type ReservationAffinity_Type

type ReservationAffinity_Type int32

Indicates whether to consume capacity from an reservation or not.

const (
	// Default type.
	ReservationAffinity_TYPE_UNSPECIFIED ReservationAffinity_Type = 0
	// Do not consume from any allocated capacity.
	ReservationAffinity_NO_RESERVATION ReservationAffinity_Type = 1
	// Consume any reservation available.
	ReservationAffinity_ANY_RESERVATION ReservationAffinity_Type = 2
	// Must consume from a specific reservation. Must specify key value fields
	// for specifying the reservations.
	ReservationAffinity_SPECIFIC_RESERVATION ReservationAffinity_Type = 3
)

func (ReservationAffinity_Type) Descriptor

func (ReservationAffinity_Type) Enum

func (ReservationAffinity_Type) Number

func (ReservationAffinity_Type) String

func (x ReservationAffinity_Type) String() string

func (ReservationAffinity_Type) Type

type ReservationAffinity_builder

type ReservationAffinity_builder struct {

	// Optional. Type of reservation to consume
	ConsumeReservationType ReservationAffinity_Type
	// Optional. Corresponds to the label key of reservation resource.
	Key string
	// Optional. Corresponds to the label values of reservation resource.
	Values []string
	// contains filtered or unexported fields
}

func (ReservationAffinity_builder) Build

type Runtime

type Runtime struct {

	// Output only. The resource name of the runtime.
	// Format:
	// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of the runtime; currently only supports Compute Engine VM.
	//
	// Types that are valid to be assigned to RuntimeType:
	//
	//	*Runtime_VirtualMachine
	RuntimeType isRuntime_RuntimeType `protobuf_oneof:"runtime_type"`
	// Output only. Runtime state.
	State Runtime_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.events.cloud.notebooks.v1.Runtime_State" json:"state,omitempty"`
	// Output only. Runtime health_state.
	HealthState Runtime_HealthState `` /* 153-byte string literal not displayed */
	// The config settings for accessing runtime.
	AccessConfig *RuntimeAccessConfig `protobuf:"bytes,5,opt,name=access_config,json=accessConfig,proto3" json:"access_config,omitempty"`
	// The config settings for software inside the runtime.
	SoftwareConfig *RuntimeSoftwareConfig `protobuf:"bytes,6,opt,name=software_config,json=softwareConfig,proto3" json:"software_config,omitempty"`
	// Output only. Contains Runtime daemon metrics such as Service status and
	// JupyterLab stats.
	Metrics *RuntimeMetrics `protobuf:"bytes,7,opt,name=metrics,proto3" json:"metrics,omitempty"`
	// Output only. Runtime creation time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Runtime update time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. The labels to associate with this Managed Notebook or Runtime.
	// Label **keys** must contain 1 to 63 characters, and must conform to
	// [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Label **values** may be empty, but, if present, must contain 1 to 63
	// characters, and must conform to [RFC
	// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
	// associated with a cluster.
	Labels map[string]string `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

The definition of a Runtime for a managed notebook instance.

func (*Runtime) ClearAccessConfig

func (x *Runtime) ClearAccessConfig()

func (*Runtime) ClearCreateTime

func (x *Runtime) ClearCreateTime()

func (*Runtime) ClearMetrics

func (x *Runtime) ClearMetrics()

func (*Runtime) ClearRuntimeType

func (x *Runtime) ClearRuntimeType()

func (*Runtime) ClearSoftwareConfig

func (x *Runtime) ClearSoftwareConfig()

func (*Runtime) ClearUpdateTime

func (x *Runtime) ClearUpdateTime()

func (*Runtime) ClearVirtualMachine

func (x *Runtime) ClearVirtualMachine()

func (*Runtime) GetAccessConfig

func (x *Runtime) GetAccessConfig() *RuntimeAccessConfig

func (*Runtime) GetCreateTime

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

func (*Runtime) GetHealthState

func (x *Runtime) GetHealthState() Runtime_HealthState

func (*Runtime) GetLabels

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

func (*Runtime) GetMetrics

func (x *Runtime) GetMetrics() *RuntimeMetrics

func (*Runtime) GetName

func (x *Runtime) GetName() string

func (*Runtime) GetRuntimeType

func (x *Runtime) GetRuntimeType() isRuntime_RuntimeType

func (*Runtime) GetSoftwareConfig

func (x *Runtime) GetSoftwareConfig() *RuntimeSoftwareConfig

func (*Runtime) GetState

func (x *Runtime) GetState() Runtime_State

func (*Runtime) GetUpdateTime

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

func (*Runtime) GetVirtualMachine

func (x *Runtime) GetVirtualMachine() *VirtualMachine

func (*Runtime) HasAccessConfig

func (x *Runtime) HasAccessConfig() bool

func (*Runtime) HasCreateTime

func (x *Runtime) HasCreateTime() bool

func (*Runtime) HasMetrics

func (x *Runtime) HasMetrics() bool

func (*Runtime) HasRuntimeType

func (x *Runtime) HasRuntimeType() bool

func (*Runtime) HasSoftwareConfig

func (x *Runtime) HasSoftwareConfig() bool

func (*Runtime) HasUpdateTime

func (x *Runtime) HasUpdateTime() bool

func (*Runtime) HasVirtualMachine

func (x *Runtime) HasVirtualMachine() bool

func (*Runtime) ProtoMessage

func (*Runtime) ProtoMessage()

func (*Runtime) ProtoReflect

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

func (*Runtime) Reset

func (x *Runtime) Reset()

func (*Runtime) SetAccessConfig

func (x *Runtime) SetAccessConfig(v *RuntimeAccessConfig)

func (*Runtime) SetCreateTime

func (x *Runtime) SetCreateTime(v *timestamppb.Timestamp)

func (*Runtime) SetHealthState

func (x *Runtime) SetHealthState(v Runtime_HealthState)

func (*Runtime) SetLabels

func (x *Runtime) SetLabels(v map[string]string)

func (*Runtime) SetMetrics

func (x *Runtime) SetMetrics(v *RuntimeMetrics)

func (*Runtime) SetName

func (x *Runtime) SetName(v string)

func (*Runtime) SetSoftwareConfig

func (x *Runtime) SetSoftwareConfig(v *RuntimeSoftwareConfig)

func (*Runtime) SetState

func (x *Runtime) SetState(v Runtime_State)

func (*Runtime) SetUpdateTime

func (x *Runtime) SetUpdateTime(v *timestamppb.Timestamp)

func (*Runtime) SetVirtualMachine

func (x *Runtime) SetVirtualMachine(v *VirtualMachine)

func (*Runtime) String

func (x *Runtime) String() string

func (*Runtime) WhichRuntimeType

func (x *Runtime) WhichRuntimeType() case_Runtime_RuntimeType

type RuntimeAcceleratorConfig

type RuntimeAcceleratorConfig struct {

	// Accelerator model.
	Type RuntimeAcceleratorConfig_AcceleratorType `` /* 141-byte string literal not displayed */
	// 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 the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See [Compute Engine AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes). Examples:

* `nvidia-tesla-k80` * `nvidia-tesla-p100` * `nvidia-tesla-v100` * `nvidia-tesla-p4` * `nvidia-tesla-t4` * `nvidia-tesla-a100`

func (*RuntimeAcceleratorConfig) GetCoreCount

func (x *RuntimeAcceleratorConfig) GetCoreCount() int64

func (*RuntimeAcceleratorConfig) GetType

func (*RuntimeAcceleratorConfig) ProtoMessage

func (*RuntimeAcceleratorConfig) ProtoMessage()

func (*RuntimeAcceleratorConfig) ProtoReflect

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

func (*RuntimeAcceleratorConfig) Reset

func (x *RuntimeAcceleratorConfig) Reset()

func (*RuntimeAcceleratorConfig) SetCoreCount

func (x *RuntimeAcceleratorConfig) SetCoreCount(v int64)

func (*RuntimeAcceleratorConfig) SetType

func (*RuntimeAcceleratorConfig) String

func (x *RuntimeAcceleratorConfig) String() string

type RuntimeAcceleratorConfig_AcceleratorType

type RuntimeAcceleratorConfig_AcceleratorType int32

Type of this accelerator.

const (
	// Accelerator type is not specified.
	RuntimeAcceleratorConfig_ACCELERATOR_TYPE_UNSPECIFIED RuntimeAcceleratorConfig_AcceleratorType = 0
	// Accelerator type is Nvidia Tesla K80.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_K80 RuntimeAcceleratorConfig_AcceleratorType = 1
	// Accelerator type is Nvidia Tesla P100.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_P100 RuntimeAcceleratorConfig_AcceleratorType = 2
	// Accelerator type is Nvidia Tesla V100.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_V100 RuntimeAcceleratorConfig_AcceleratorType = 3
	// Accelerator type is Nvidia Tesla P4.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_P4 RuntimeAcceleratorConfig_AcceleratorType = 4
	// Accelerator type is Nvidia Tesla T4.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_T4 RuntimeAcceleratorConfig_AcceleratorType = 5
	// Accelerator type is Nvidia Tesla A100 - 40GB.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_A100 RuntimeAcceleratorConfig_AcceleratorType = 6
	// (Coming soon) Accelerator type is TPU V2.
	RuntimeAcceleratorConfig_TPU_V2 RuntimeAcceleratorConfig_AcceleratorType = 7
	// (Coming soon) Accelerator type is TPU V3.
	RuntimeAcceleratorConfig_TPU_V3 RuntimeAcceleratorConfig_AcceleratorType = 8
	// Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_T4_VWS RuntimeAcceleratorConfig_AcceleratorType = 9
	// Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_P100_VWS RuntimeAcceleratorConfig_AcceleratorType = 10
	// Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
	RuntimeAcceleratorConfig_NVIDIA_TESLA_P4_VWS RuntimeAcceleratorConfig_AcceleratorType = 11
)

func (RuntimeAcceleratorConfig_AcceleratorType) Descriptor

func (RuntimeAcceleratorConfig_AcceleratorType) Enum

func (RuntimeAcceleratorConfig_AcceleratorType) Number

func (RuntimeAcceleratorConfig_AcceleratorType) String

func (RuntimeAcceleratorConfig_AcceleratorType) Type

type RuntimeAcceleratorConfig_builder

type RuntimeAcceleratorConfig_builder struct {

	// Accelerator model.
	Type RuntimeAcceleratorConfig_AcceleratorType
	// Count of cores of this accelerator.
	CoreCount int64
	// contains filtered or unexported fields
}

func (RuntimeAcceleratorConfig_builder) Build

type RuntimeAccessConfig

type RuntimeAccessConfig struct {

	// The type of access mode this instance.
	AccessType RuntimeAccessConfig_RuntimeAccessType `` /* 168-byte string literal not displayed */
	// The owner of this runtime after creation. Format: `alias@example.com`
	// Currently supports one owner only.
	RuntimeOwner string `protobuf:"bytes,2,opt,name=runtime_owner,json=runtimeOwner,proto3" json:"runtime_owner,omitempty"`
	// Output only. The proxy endpoint that is used to access the runtime.
	ProxyUri string `protobuf:"bytes,3,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
	// contains filtered or unexported fields
}

Specifies the login configuration for Runtime

func (*RuntimeAccessConfig) GetAccessType

func (*RuntimeAccessConfig) GetProxyUri

func (x *RuntimeAccessConfig) GetProxyUri() string

func (*RuntimeAccessConfig) GetRuntimeOwner

func (x *RuntimeAccessConfig) GetRuntimeOwner() string

func (*RuntimeAccessConfig) ProtoMessage

func (*RuntimeAccessConfig) ProtoMessage()

func (*RuntimeAccessConfig) ProtoReflect

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

func (*RuntimeAccessConfig) Reset

func (x *RuntimeAccessConfig) Reset()

func (*RuntimeAccessConfig) SetAccessType

func (*RuntimeAccessConfig) SetProxyUri

func (x *RuntimeAccessConfig) SetProxyUri(v string)

func (*RuntimeAccessConfig) SetRuntimeOwner

func (x *RuntimeAccessConfig) SetRuntimeOwner(v string)

func (*RuntimeAccessConfig) String

func (x *RuntimeAccessConfig) String() string

type RuntimeAccessConfig_RuntimeAccessType

type RuntimeAccessConfig_RuntimeAccessType int32

Possible ways to access runtime. Authentication mode. Currently supports: Single User only.

const (
	// Unspecified access.
	RuntimeAccessConfig_RUNTIME_ACCESS_TYPE_UNSPECIFIED RuntimeAccessConfig_RuntimeAccessType = 0
	// Single user login.
	RuntimeAccessConfig_SINGLE_USER RuntimeAccessConfig_RuntimeAccessType = 1
	// Service Account mode.
	// In Service Account mode, Runtime creator will specify a SA that exists
	// in the consumer project. Using Runtime Service Account field.
	// Users accessing the Runtime need ActAs (Service Account User) permission.
	RuntimeAccessConfig_SERVICE_ACCOUNT RuntimeAccessConfig_RuntimeAccessType = 2
)

func (RuntimeAccessConfig_RuntimeAccessType) Descriptor

func (RuntimeAccessConfig_RuntimeAccessType) Enum

func (RuntimeAccessConfig_RuntimeAccessType) Number

func (RuntimeAccessConfig_RuntimeAccessType) String

func (RuntimeAccessConfig_RuntimeAccessType) Type

type RuntimeAccessConfig_builder

type RuntimeAccessConfig_builder struct {

	// The type of access mode this instance.
	AccessType RuntimeAccessConfig_RuntimeAccessType
	// The owner of this runtime after creation. Format: `alias@example.com`
	// Currently supports one owner only.
	RuntimeOwner string
	// Output only. The proxy endpoint that is used to access the runtime.
	ProxyUri string
	// contains filtered or unexported fields
}

func (RuntimeAccessConfig_builder) Build

type RuntimeCreatedEvent

type RuntimeCreatedEvent struct {

	// The data associated with the event.
	Data *RuntimeEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when a Runtime is created.

func (*RuntimeCreatedEvent) ClearData

func (x *RuntimeCreatedEvent) ClearData()

func (*RuntimeCreatedEvent) GetData

func (x *RuntimeCreatedEvent) GetData() *RuntimeEventData

func (*RuntimeCreatedEvent) HasData

func (x *RuntimeCreatedEvent) HasData() bool

func (*RuntimeCreatedEvent) ProtoMessage

func (*RuntimeCreatedEvent) ProtoMessage()

func (*RuntimeCreatedEvent) ProtoReflect

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

func (*RuntimeCreatedEvent) Reset

func (x *RuntimeCreatedEvent) Reset()

func (*RuntimeCreatedEvent) SetData

func (x *RuntimeCreatedEvent) SetData(v *RuntimeEventData)

func (*RuntimeCreatedEvent) String

func (x *RuntimeCreatedEvent) String() string

type RuntimeCreatedEvent_builder

type RuntimeCreatedEvent_builder struct {

	// The data associated with the event.
	Data *RuntimeEventData
	// contains filtered or unexported fields
}

func (RuntimeCreatedEvent_builder) Build

type RuntimeDeletedEvent

type RuntimeDeletedEvent struct {

	// The data associated with the event.
	Data *RuntimeEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when a Runtime is deleted.

func (*RuntimeDeletedEvent) ClearData

func (x *RuntimeDeletedEvent) ClearData()

func (*RuntimeDeletedEvent) GetData

func (x *RuntimeDeletedEvent) GetData() *RuntimeEventData

func (*RuntimeDeletedEvent) HasData

func (x *RuntimeDeletedEvent) HasData() bool

func (*RuntimeDeletedEvent) ProtoMessage

func (*RuntimeDeletedEvent) ProtoMessage()

func (*RuntimeDeletedEvent) ProtoReflect

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

func (*RuntimeDeletedEvent) Reset

func (x *RuntimeDeletedEvent) Reset()

func (*RuntimeDeletedEvent) SetData

func (x *RuntimeDeletedEvent) SetData(v *RuntimeEventData)

func (*RuntimeDeletedEvent) String

func (x *RuntimeDeletedEvent) String() string

type RuntimeDeletedEvent_builder

type RuntimeDeletedEvent_builder struct {

	// The data associated with the event.
	Data *RuntimeEventData
	// contains filtered or unexported fields
}

func (RuntimeDeletedEvent_builder) Build

type RuntimeEventData

type RuntimeEventData struct {

	// Optional. The Runtime event payload. Unset for deletion events.
	Payload *Runtime `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Runtime events.

func (*RuntimeEventData) ClearPayload

func (x *RuntimeEventData) ClearPayload()

func (*RuntimeEventData) GetPayload

func (x *RuntimeEventData) GetPayload() *Runtime

func (*RuntimeEventData) HasPayload

func (x *RuntimeEventData) HasPayload() bool

func (*RuntimeEventData) ProtoMessage

func (*RuntimeEventData) ProtoMessage()

func (*RuntimeEventData) ProtoReflect

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

func (*RuntimeEventData) Reset

func (x *RuntimeEventData) Reset()

func (*RuntimeEventData) SetPayload

func (x *RuntimeEventData) SetPayload(v *Runtime)

func (*RuntimeEventData) String

func (x *RuntimeEventData) String() string

type RuntimeEventData_builder

type RuntimeEventData_builder struct {

	// Optional. The Runtime event payload. Unset for deletion events.
	Payload *Runtime
	// contains filtered or unexported fields
}

func (RuntimeEventData_builder) Build

type RuntimeMetrics

type RuntimeMetrics struct {

	// Output only. The system metrics.
	SystemMetrics map[string]string `` /* 174-byte string literal not displayed */
	// contains filtered or unexported fields
}

Contains runtime daemon metrics, such as OS and kernels and sessions stats.

func (*RuntimeMetrics) GetSystemMetrics

func (x *RuntimeMetrics) GetSystemMetrics() map[string]string

func (*RuntimeMetrics) ProtoMessage

func (*RuntimeMetrics) ProtoMessage()

func (*RuntimeMetrics) ProtoReflect

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

func (*RuntimeMetrics) Reset

func (x *RuntimeMetrics) Reset()

func (*RuntimeMetrics) SetSystemMetrics

func (x *RuntimeMetrics) SetSystemMetrics(v map[string]string)

func (*RuntimeMetrics) String

func (x *RuntimeMetrics) String() string

type RuntimeMetrics_builder

type RuntimeMetrics_builder struct {

	// Output only. The system metrics.
	SystemMetrics map[string]string
	// contains filtered or unexported fields
}

func (RuntimeMetrics_builder) Build

type RuntimeShieldedInstanceConfig

type RuntimeShieldedInstanceConfig struct {

	// Defines whether the 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"`
	// Defines whether the instance has the vTPM enabled. Enabled by default.
	EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
	// Defines whether the instance has integrity monitoring enabled.
	//
	// Enables monitoring and attestation of the boot integrity of the instance.
	// The attestation is performed against the integrity policy baseline. This
	// baseline is initially derived from the implicitly trusted boot image when
	// the instance is created. Enabled by default.
	EnableIntegrityMonitoring bool `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). Not all combinations are valid.

func (*RuntimeShieldedInstanceConfig) GetEnableIntegrityMonitoring

func (x *RuntimeShieldedInstanceConfig) GetEnableIntegrityMonitoring() bool

func (*RuntimeShieldedInstanceConfig) GetEnableSecureBoot

func (x *RuntimeShieldedInstanceConfig) GetEnableSecureBoot() bool

func (*RuntimeShieldedInstanceConfig) GetEnableVtpm

func (x *RuntimeShieldedInstanceConfig) GetEnableVtpm() bool

func (*RuntimeShieldedInstanceConfig) ProtoMessage

func (*RuntimeShieldedInstanceConfig) ProtoMessage()

func (*RuntimeShieldedInstanceConfig) ProtoReflect

func (*RuntimeShieldedInstanceConfig) Reset

func (x *RuntimeShieldedInstanceConfig) Reset()

func (*RuntimeShieldedInstanceConfig) SetEnableIntegrityMonitoring

func (x *RuntimeShieldedInstanceConfig) SetEnableIntegrityMonitoring(v bool)

func (*RuntimeShieldedInstanceConfig) SetEnableSecureBoot

func (x *RuntimeShieldedInstanceConfig) SetEnableSecureBoot(v bool)

func (*RuntimeShieldedInstanceConfig) SetEnableVtpm

func (x *RuntimeShieldedInstanceConfig) SetEnableVtpm(v bool)

func (*RuntimeShieldedInstanceConfig) String

type RuntimeShieldedInstanceConfig_builder

type RuntimeShieldedInstanceConfig_builder struct {

	// Defines whether the 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
	// Defines whether the instance has the vTPM enabled. Enabled by default.
	EnableVtpm bool
	// Defines whether the instance has integrity monitoring enabled.
	//
	// Enables monitoring and attestation of the boot integrity of the instance.
	// The attestation is performed against the integrity policy baseline. This
	// baseline is initially derived from the implicitly trusted boot image when
	// the instance is created. Enabled by default.
	EnableIntegrityMonitoring bool
	// contains filtered or unexported fields
}

func (RuntimeShieldedInstanceConfig_builder) Build

type RuntimeSoftwareConfig

type RuntimeSoftwareConfig struct {

	// Cron expression in UTC timezone, used to schedule instance auto upgrade.
	// Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
	NotebookUpgradeSchedule string `` /* 132-byte string literal not displayed */
	// Verifies core internal services are running.
	// Default: True
	EnableHealthMonitoring *bool `` /* 136-byte string literal not displayed */
	// Runtime will automatically shutdown after idle_shutdown_time.
	// Default: True
	IdleShutdown *bool `protobuf:"varint,3,opt,name=idle_shutdown,json=idleShutdown,proto3,oneof" json:"idle_shutdown,omitempty"`
	// Time in minutes to wait before shutting down runtime. Default: 180 minutes
	IdleShutdownTimeout int32 `protobuf:"varint,4,opt,name=idle_shutdown_timeout,json=idleShutdownTimeout,proto3" json:"idle_shutdown_timeout,omitempty"`
	// Install Nvidia Driver automatically.
	// Default: True
	InstallGpuDriver bool `protobuf:"varint,5,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,6,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
	// 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,7,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
	// Optional. Use a list of container images to use as Kernels in the notebook
	// instance.
	Kernels []*ContainerImage `protobuf:"bytes,8,rep,name=kernels,proto3" json:"kernels,omitempty"`
	// Output only. Bool indicating whether an newer image is available in an
	// image family.
	Upgradeable *bool `protobuf:"varint,9,opt,name=upgradeable,proto3,oneof" json:"upgradeable,omitempty"`
	// Behavior for the post startup script.
	PostStartupScriptBehavior RuntimeSoftwareConfig_PostStartupScriptBehavior `` /* 228-byte string literal not displayed */
	// Bool indicating whether JupyterLab terminal will be available or not.
	// Default: False
	DisableTerminal *bool `protobuf:"varint,11,opt,name=disable_terminal,json=disableTerminal,proto3,oneof" json:"disable_terminal,omitempty"`
	// Output only. version of boot image such as M100, from release label of the
	// image.
	Version *string `protobuf:"bytes,12,opt,name=version,proto3,oneof" json:"version,omitempty"`
	// Bool indicating whether mixer client should be disabled.
	// Default: False
	MixerDisabled *bool `protobuf:"varint,13,opt,name=mixer_disabled,json=mixerDisabled,proto3,oneof" json:"mixer_disabled,omitempty"`
	// contains filtered or unexported fields
}

Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example:

* `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `enable_health_monitoring: true`

func (*RuntimeSoftwareConfig) ClearDisableTerminal

func (x *RuntimeSoftwareConfig) ClearDisableTerminal()

func (*RuntimeSoftwareConfig) ClearEnableHealthMonitoring

func (x *RuntimeSoftwareConfig) ClearEnableHealthMonitoring()

func (*RuntimeSoftwareConfig) ClearIdleShutdown

func (x *RuntimeSoftwareConfig) ClearIdleShutdown()

func (*RuntimeSoftwareConfig) ClearMixerDisabled

func (x *RuntimeSoftwareConfig) ClearMixerDisabled()

func (*RuntimeSoftwareConfig) ClearUpgradeable

func (x *RuntimeSoftwareConfig) ClearUpgradeable()

func (*RuntimeSoftwareConfig) ClearVersion

func (x *RuntimeSoftwareConfig) ClearVersion()

func (*RuntimeSoftwareConfig) GetCustomGpuDriverPath

func (x *RuntimeSoftwareConfig) GetCustomGpuDriverPath() string

func (*RuntimeSoftwareConfig) GetDisableTerminal

func (x *RuntimeSoftwareConfig) GetDisableTerminal() bool

func (*RuntimeSoftwareConfig) GetEnableHealthMonitoring

func (x *RuntimeSoftwareConfig) GetEnableHealthMonitoring() bool

func (*RuntimeSoftwareConfig) GetIdleShutdown

func (x *RuntimeSoftwareConfig) GetIdleShutdown() bool

func (*RuntimeSoftwareConfig) GetIdleShutdownTimeout

func (x *RuntimeSoftwareConfig) GetIdleShutdownTimeout() int32

func (*RuntimeSoftwareConfig) GetInstallGpuDriver

func (x *RuntimeSoftwareConfig) GetInstallGpuDriver() bool

func (*RuntimeSoftwareConfig) GetKernels

func (x *RuntimeSoftwareConfig) GetKernels() []*ContainerImage

func (*RuntimeSoftwareConfig) GetMixerDisabled

func (x *RuntimeSoftwareConfig) GetMixerDisabled() bool

func (*RuntimeSoftwareConfig) GetNotebookUpgradeSchedule

func (x *RuntimeSoftwareConfig) GetNotebookUpgradeSchedule() string

func (*RuntimeSoftwareConfig) GetPostStartupScript

func (x *RuntimeSoftwareConfig) GetPostStartupScript() string

func (*RuntimeSoftwareConfig) GetPostStartupScriptBehavior

func (*RuntimeSoftwareConfig) GetUpgradeable

func (x *RuntimeSoftwareConfig) GetUpgradeable() bool

func (*RuntimeSoftwareConfig) GetVersion

func (x *RuntimeSoftwareConfig) GetVersion() string

func (*RuntimeSoftwareConfig) HasDisableTerminal

func (x *RuntimeSoftwareConfig) HasDisableTerminal() bool

func (*RuntimeSoftwareConfig) HasEnableHealthMonitoring

func (x *RuntimeSoftwareConfig) HasEnableHealthMonitoring() bool

func (*RuntimeSoftwareConfig) HasIdleShutdown

func (x *RuntimeSoftwareConfig) HasIdleShutdown() bool

func (*RuntimeSoftwareConfig) HasMixerDisabled

func (x *RuntimeSoftwareConfig) HasMixerDisabled() bool

func (*RuntimeSoftwareConfig) HasUpgradeable

func (x *RuntimeSoftwareConfig) HasUpgradeable() bool

func (*RuntimeSoftwareConfig) HasVersion

func (x *RuntimeSoftwareConfig) HasVersion() bool

func (*RuntimeSoftwareConfig) ProtoMessage

func (*RuntimeSoftwareConfig) ProtoMessage()

func (*RuntimeSoftwareConfig) ProtoReflect

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

func (*RuntimeSoftwareConfig) Reset

func (x *RuntimeSoftwareConfig) Reset()

func (*RuntimeSoftwareConfig) SetCustomGpuDriverPath

func (x *RuntimeSoftwareConfig) SetCustomGpuDriverPath(v string)

func (*RuntimeSoftwareConfig) SetDisableTerminal

func (x *RuntimeSoftwareConfig) SetDisableTerminal(v bool)

func (*RuntimeSoftwareConfig) SetEnableHealthMonitoring

func (x *RuntimeSoftwareConfig) SetEnableHealthMonitoring(v bool)

func (*RuntimeSoftwareConfig) SetIdleShutdown

func (x *RuntimeSoftwareConfig) SetIdleShutdown(v bool)

func (*RuntimeSoftwareConfig) SetIdleShutdownTimeout

func (x *RuntimeSoftwareConfig) SetIdleShutdownTimeout(v int32)

func (*RuntimeSoftwareConfig) SetInstallGpuDriver

func (x *RuntimeSoftwareConfig) SetInstallGpuDriver(v bool)

func (*RuntimeSoftwareConfig) SetKernels

func (x *RuntimeSoftwareConfig) SetKernels(v []*ContainerImage)

func (*RuntimeSoftwareConfig) SetMixerDisabled

func (x *RuntimeSoftwareConfig) SetMixerDisabled(v bool)

func (*RuntimeSoftwareConfig) SetNotebookUpgradeSchedule

func (x *RuntimeSoftwareConfig) SetNotebookUpgradeSchedule(v string)

func (*RuntimeSoftwareConfig) SetPostStartupScript

func (x *RuntimeSoftwareConfig) SetPostStartupScript(v string)

func (*RuntimeSoftwareConfig) SetPostStartupScriptBehavior

func (*RuntimeSoftwareConfig) SetUpgradeable

func (x *RuntimeSoftwareConfig) SetUpgradeable(v bool)

func (*RuntimeSoftwareConfig) SetVersion

func (x *RuntimeSoftwareConfig) SetVersion(v string)

func (*RuntimeSoftwareConfig) String

func (x *RuntimeSoftwareConfig) String() string

type RuntimeSoftwareConfig_PostStartupScriptBehavior

type RuntimeSoftwareConfig_PostStartupScriptBehavior int32

Behavior for the post startup script.

const (
	// Unspecified post startup script behavior. Will run only once at creation.
	RuntimeSoftwareConfig_POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED RuntimeSoftwareConfig_PostStartupScriptBehavior = 0
	// Runs the post startup script provided during creation at every start.
	RuntimeSoftwareConfig_RUN_EVERY_START RuntimeSoftwareConfig_PostStartupScriptBehavior = 1
	// Downloads and runs the provided post startup script at every start.
	RuntimeSoftwareConfig_DOWNLOAD_AND_RUN_EVERY_START RuntimeSoftwareConfig_PostStartupScriptBehavior = 2
)

func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Descriptor

func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Enum

func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Number

func (RuntimeSoftwareConfig_PostStartupScriptBehavior) String

func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Type

type RuntimeSoftwareConfig_builder

type RuntimeSoftwareConfig_builder struct {

	// Cron expression in UTC timezone, used to schedule instance auto upgrade.
	// Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
	NotebookUpgradeSchedule string
	// Verifies core internal services are running.
	// Default: True
	EnableHealthMonitoring *bool
	// Runtime will automatically shutdown after idle_shutdown_time.
	// Default: True
	IdleShutdown *bool
	// Time in minutes to wait before shutting down runtime. Default: 180 minutes
	IdleShutdownTimeout int32
	// Install Nvidia Driver automatically.
	// Default: True
	InstallGpuDriver bool
	// 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
	// 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
	// Optional. Use a list of container images to use as Kernels in the notebook
	// instance.
	Kernels []*ContainerImage
	// Output only. Bool indicating whether an newer image is available in an
	// image family.
	Upgradeable *bool
	// Behavior for the post startup script.
	PostStartupScriptBehavior RuntimeSoftwareConfig_PostStartupScriptBehavior
	// Bool indicating whether JupyterLab terminal will be available or not.
	// Default: False
	DisableTerminal *bool
	// Output only. version of boot image such as M100, from release label of the
	// image.
	Version *string
	// Bool indicating whether mixer client should be disabled.
	// Default: False
	MixerDisabled *bool
	// contains filtered or unexported fields
}

func (RuntimeSoftwareConfig_builder) Build

type RuntimeUpdatedEvent

type RuntimeUpdatedEvent struct {

	// The data associated with the event.
	Data *RuntimeEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when a Runtime is updated.

func (*RuntimeUpdatedEvent) ClearData

func (x *RuntimeUpdatedEvent) ClearData()

func (*RuntimeUpdatedEvent) GetData

func (x *RuntimeUpdatedEvent) GetData() *RuntimeEventData

func (*RuntimeUpdatedEvent) HasData

func (x *RuntimeUpdatedEvent) HasData() bool

func (*RuntimeUpdatedEvent) ProtoMessage

func (*RuntimeUpdatedEvent) ProtoMessage()

func (*RuntimeUpdatedEvent) ProtoReflect

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

func (*RuntimeUpdatedEvent) Reset

func (x *RuntimeUpdatedEvent) Reset()

func (*RuntimeUpdatedEvent) SetData

func (x *RuntimeUpdatedEvent) SetData(v *RuntimeEventData)

func (*RuntimeUpdatedEvent) String

func (x *RuntimeUpdatedEvent) String() string

type RuntimeUpdatedEvent_builder

type RuntimeUpdatedEvent_builder struct {

	// The data associated with the event.
	Data *RuntimeEventData
	// contains filtered or unexported fields
}

func (RuntimeUpdatedEvent_builder) Build

type Runtime_HealthState

type Runtime_HealthState int32

The runtime substate.

const (
	// The runtime substate is unknown.
	Runtime_HEALTH_STATE_UNSPECIFIED Runtime_HealthState = 0
	// The runtime is known to be in an healthy state
	// (for example, critical daemons are running)
	// Applies to ACTIVE state.
	Runtime_HEALTHY Runtime_HealthState = 1
	// The runtime is known to be in an unhealthy state
	// (for example, critical daemons are not running)
	// Applies to ACTIVE state.
	Runtime_UNHEALTHY Runtime_HealthState = 2
	// The runtime has not installed health monitoring agent.
	// Applies to ACTIVE state.
	Runtime_AGENT_NOT_INSTALLED Runtime_HealthState = 3
	// The runtime health monitoring agent is not running.
	// Applies to ACTIVE state.
	Runtime_AGENT_NOT_RUNNING Runtime_HealthState = 4
)

func (Runtime_HealthState) Descriptor

func (Runtime_HealthState) Enum

func (Runtime_HealthState) Number

func (Runtime_HealthState) String

func (x Runtime_HealthState) String() string

func (Runtime_HealthState) Type

type Runtime_State

type Runtime_State int32

The definition of the states of this runtime.

const (
	// State is not specified.
	Runtime_STATE_UNSPECIFIED Runtime_State = 0
	// The compute layer is starting the runtime. It is not ready for use.
	Runtime_STARTING Runtime_State = 1
	// The compute layer is installing required frameworks and registering the
	// runtime with notebook proxy. It cannot be used.
	Runtime_PROVISIONING Runtime_State = 2
	// The runtime is currently running. It is ready for use.
	Runtime_ACTIVE Runtime_State = 3
	// The control logic is stopping the runtime. It cannot be used.
	Runtime_STOPPING Runtime_State = 4
	// The runtime is stopped. It cannot be used.
	Runtime_STOPPED Runtime_State = 5
	// The runtime is being deleted. It cannot be used.
	Runtime_DELETING Runtime_State = 6
	// The runtime is upgrading. It cannot be used.
	Runtime_UPGRADING Runtime_State = 7
	// The runtime is being created and set up. It is not ready for use.
	Runtime_INITIALIZING Runtime_State = 8
)

func (Runtime_State) Descriptor

func (Runtime_State) Enum

func (x Runtime_State) Enum() *Runtime_State

func (Runtime_State) Number

func (Runtime_State) String

func (x Runtime_State) String() string

func (Runtime_State) Type

type Runtime_VirtualMachine

type Runtime_VirtualMachine struct {
	// Use a Compute Engine VM image to start the managed notebook instance.
	VirtualMachine *VirtualMachine `protobuf:"bytes,2,opt,name=virtual_machine,json=virtualMachine,proto3,oneof"`
}

type Runtime_builder

type Runtime_builder struct {

	// Output only. The resource name of the runtime.
	// Format:
	// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
	Name string

	// Fields of oneof RuntimeType:
	// Use a Compute Engine VM image to start the managed notebook instance.
	VirtualMachine *VirtualMachine
	// -- end of RuntimeType
	// Output only. Runtime state.
	State Runtime_State
	// Output only. Runtime health_state.
	HealthState Runtime_HealthState
	// The config settings for accessing runtime.
	AccessConfig *RuntimeAccessConfig
	// The config settings for software inside the runtime.
	SoftwareConfig *RuntimeSoftwareConfig
	// Output only. Contains Runtime daemon metrics such as Service status and
	// JupyterLab stats.
	Metrics *RuntimeMetrics
	// Output only. Runtime creation time.
	CreateTime *timestamppb.Timestamp
	// Output only. Runtime update time.
	UpdateTime *timestamppb.Timestamp
	// Optional. The labels to associate with this Managed Notebook or Runtime.
	// Label **keys** must contain 1 to 63 characters, and must conform to
	// [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Label **values** may be empty, but, if present, must contain 1 to 63
	// characters, and must conform to [RFC
	// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
	// associated with a cluster.
	Labels map[string]string
	// contains filtered or unexported fields
}

func (Runtime_builder) Build

func (b0 Runtime_builder) Build() *Runtime

type Schedule

type Schedule struct {

	// Output only. The name of this schedule. Format:
	// `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Display name used for UI purposes.
	// Name can only contain alphanumeric characters, hyphens `-`,
	// and underscores `_`.
	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"`
	State       Schedule_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.events.cloud.notebooks.v1.Schedule_State" json:"state,omitempty"`
	// Cron-tab formatted schedule by which the job will execute.
	// Format: minute, hour, day of month, month, day of week,
	// e.g. `0 0 * * WED` = every Wednesday
	// More examples: https://crontab.guru/examples.html
	CronSchedule string `protobuf:"bytes,5,opt,name=cron_schedule,json=cronSchedule,proto3" json:"cron_schedule,omitempty"`
	// Timezone on which the cron_schedule.
	// The value of this field must be a time zone name from the tz database.
	// TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	//
	// Note that some time zones include a provision for daylight savings time.
	// The rules for daylight saving time are determined by the chosen tz.
	// For UTC use the string "utc". If a time zone is not specified,
	// the default will be in UTC (also known as GMT).
	TimeZone string `protobuf:"bytes,6,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// Output only. Time the schedule was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Time the schedule was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Notebook Execution Template corresponding to this schedule.
	ExecutionTemplate *ExecutionTemplate `protobuf:"bytes,9,opt,name=execution_template,json=executionTemplate,proto3" json:"execution_template,omitempty"`
	// Output only. The most recent execution names triggered from this schedule
	// and their corresponding states.
	RecentExecutions []*Execution `protobuf:"bytes,10,rep,name=recent_executions,json=recentExecutions,proto3" json:"recent_executions,omitempty"`
	// contains filtered or unexported fields
}

The definition of a schedule.

func (*Schedule) ClearCreateTime

func (x *Schedule) ClearCreateTime()

func (*Schedule) ClearExecutionTemplate

func (x *Schedule) ClearExecutionTemplate()

func (*Schedule) ClearUpdateTime

func (x *Schedule) ClearUpdateTime()

func (*Schedule) GetCreateTime

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

func (*Schedule) GetCronSchedule

func (x *Schedule) GetCronSchedule() string

func (*Schedule) GetDescription

func (x *Schedule) GetDescription() string

func (*Schedule) GetDisplayName

func (x *Schedule) GetDisplayName() string

func (*Schedule) GetExecutionTemplate

func (x *Schedule) GetExecutionTemplate() *ExecutionTemplate

func (*Schedule) GetName

func (x *Schedule) GetName() string

func (*Schedule) GetRecentExecutions

func (x *Schedule) GetRecentExecutions() []*Execution

func (*Schedule) GetState

func (x *Schedule) GetState() Schedule_State

func (*Schedule) GetTimeZone

func (x *Schedule) GetTimeZone() string

func (*Schedule) GetUpdateTime

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

func (*Schedule) HasCreateTime

func (x *Schedule) HasCreateTime() bool

func (*Schedule) HasExecutionTemplate

func (x *Schedule) HasExecutionTemplate() bool

func (*Schedule) HasUpdateTime

func (x *Schedule) HasUpdateTime() bool

func (*Schedule) ProtoMessage

func (*Schedule) ProtoMessage()

func (*Schedule) ProtoReflect

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

func (*Schedule) Reset

func (x *Schedule) Reset()

func (*Schedule) SetCreateTime

func (x *Schedule) SetCreateTime(v *timestamppb.Timestamp)

func (*Schedule) SetCronSchedule

func (x *Schedule) SetCronSchedule(v string)

func (*Schedule) SetDescription

func (x *Schedule) SetDescription(v string)

func (*Schedule) SetDisplayName

func (x *Schedule) SetDisplayName(v string)

func (*Schedule) SetExecutionTemplate

func (x *Schedule) SetExecutionTemplate(v *ExecutionTemplate)

func (*Schedule) SetName

func (x *Schedule) SetName(v string)

func (*Schedule) SetRecentExecutions

func (x *Schedule) SetRecentExecutions(v []*Execution)

func (*Schedule) SetState

func (x *Schedule) SetState(v Schedule_State)

func (*Schedule) SetTimeZone

func (x *Schedule) SetTimeZone(v string)

func (*Schedule) SetUpdateTime

func (x *Schedule) SetUpdateTime(v *timestamppb.Timestamp)

func (*Schedule) String

func (x *Schedule) String() string

type ScheduleCreatedEvent

type ScheduleCreatedEvent struct {

	// The data associated with the event.
	Data *ScheduleEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when a Schedule is created.

func (*ScheduleCreatedEvent) ClearData

func (x *ScheduleCreatedEvent) ClearData()

func (*ScheduleCreatedEvent) GetData

func (*ScheduleCreatedEvent) HasData

func (x *ScheduleCreatedEvent) HasData() bool

func (*ScheduleCreatedEvent) ProtoMessage

func (*ScheduleCreatedEvent) ProtoMessage()

func (*ScheduleCreatedEvent) ProtoReflect

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

func (*ScheduleCreatedEvent) Reset

func (x *ScheduleCreatedEvent) Reset()

func (*ScheduleCreatedEvent) SetData

func (x *ScheduleCreatedEvent) SetData(v *ScheduleEventData)

func (*ScheduleCreatedEvent) String

func (x *ScheduleCreatedEvent) String() string

type ScheduleCreatedEvent_builder

type ScheduleCreatedEvent_builder struct {

	// The data associated with the event.
	Data *ScheduleEventData
	// contains filtered or unexported fields
}

func (ScheduleCreatedEvent_builder) Build

type ScheduleDeletedEvent

type ScheduleDeletedEvent struct {

	// The data associated with the event.
	Data *ScheduleEventData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

The CloudEvent raised when a Schedule is deleted.

func (*ScheduleDeletedEvent) ClearData

func (x *ScheduleDeletedEvent) ClearData()

func (*ScheduleDeletedEvent) GetData

func (*ScheduleDeletedEvent) HasData

func (x *ScheduleDeletedEvent) HasData() bool

func (*ScheduleDeletedEvent) ProtoMessage

func (*ScheduleDeletedEvent) ProtoMessage()

func (*ScheduleDeletedEvent) ProtoReflect

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

func (*ScheduleDeletedEvent) Reset

func (x *ScheduleDeletedEvent) Reset()

func (*ScheduleDeletedEvent) SetData

func (x *ScheduleDeletedEvent) SetData(v *ScheduleEventData)

func (*ScheduleDeletedEvent) String

func (x *ScheduleDeletedEvent) String() string

type ScheduleDeletedEvent_builder

type ScheduleDeletedEvent_builder struct {

	// The data associated with the event.
	Data *ScheduleEventData
	// contains filtered or unexported fields
}

func (ScheduleDeletedEvent_builder) Build

type ScheduleEventData

type ScheduleEventData struct {

	// Optional. The Schedule event payload. Unset for deletion events.
	Payload *Schedule `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Schedule events.

func (*ScheduleEventData) ClearPayload

func (x *ScheduleEventData) ClearPayload()

func (*ScheduleEventData) GetPayload

func (x *ScheduleEventData) GetPayload() *Schedule

func (*ScheduleEventData) HasPayload

func (x *ScheduleEventData) HasPayload() bool

func (*ScheduleEventData) ProtoMessage

func (*ScheduleEventData) ProtoMessage()

func (*ScheduleEventData) ProtoReflect

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

func (*ScheduleEventData) Reset

func (x *ScheduleEventData) Reset()

func (*ScheduleEventData) SetPayload

func (x *ScheduleEventData) SetPayload(v *Schedule)

func (*ScheduleEventData) String

func (x *ScheduleEventData) String() string

type ScheduleEventData_builder

type ScheduleEventData_builder struct {

	// Optional. The Schedule event payload. Unset for deletion events.
	Payload *Schedule
	// contains filtered or unexported fields
}

func (ScheduleEventData_builder) Build

type Schedule_State

type Schedule_State int32

State of the job.

const (
	// Unspecified state.
	Schedule_STATE_UNSPECIFIED Schedule_State = 0
	// The job is executing normally.
	Schedule_ENABLED Schedule_State = 1
	// The job is paused by the user. It will not execute. A user can
	// intentionally pause the job using
	// [PauseJobRequest][].
	Schedule_PAUSED Schedule_State = 2
	// The job is disabled by the system due to error. The user
	// cannot directly set a job to be disabled.
	Schedule_DISABLED Schedule_State = 3
	// The job state resulting from a failed [CloudScheduler.UpdateJob][]
	// operation. To recover a job from this state, retry
	// [CloudScheduler.UpdateJob][] until a successful response is received.
	Schedule_UPDATE_FAILED Schedule_State = 4
	// The schedule resource is being created.
	Schedule_INITIALIZING Schedule_State = 5
	// The schedule resource is being deleted.
	Schedule_DELETING Schedule_State = 6
)

func (Schedule_State) Descriptor

func (Schedule_State) Enum

func (x Schedule_State) Enum() *Schedule_State

func (Schedule_State) Number

func (Schedule_State) String

func (x Schedule_State) String() string

func (Schedule_State) Type

type Schedule_builder

type Schedule_builder struct {

	// Output only. The name of this schedule. Format:
	// `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
	Name string
	// Output only. Display name used for UI purposes.
	// Name can only contain alphanumeric characters, hyphens `-`,
	// and underscores `_`.
	DisplayName string
	// A brief description of this environment.
	Description string
	State       Schedule_State
	// Cron-tab formatted schedule by which the job will execute.
	// Format: minute, hour, day of month, month, day of week,
	// e.g. `0 0 * * WED` = every Wednesday
	// More examples: https://crontab.guru/examples.html
	CronSchedule string
	// Timezone on which the cron_schedule.
	// The value of this field must be a time zone name from the tz database.
	// TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	//
	// Note that some time zones include a provision for daylight savings time.
	// The rules for daylight saving time are determined by the chosen tz.
	// For UTC use the string "utc". If a time zone is not specified,
	// the default will be in UTC (also known as GMT).
	TimeZone string
	// Output only. Time the schedule was created.
	CreateTime *timestamppb.Timestamp
	// Output only. Time the schedule was last updated.
	UpdateTime *timestamppb.Timestamp
	// Notebook Execution Template corresponding to this schedule.
	ExecutionTemplate *ExecutionTemplate
	// Output only. The most recent execution names triggered from this schedule
	// and their corresponding states.
	RecentExecutions []*Execution
	// contains filtered or unexported fields
}

func (Schedule_builder) Build

func (b0 Schedule_builder) Build() *Schedule

type VirtualMachine

type VirtualMachine struct {

	// Output only. The user-friendly name of the Managed Compute Engine instance.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName,proto3" json:"instance_name,omitempty"`
	// Output only. The unique identifier of the Managed Compute Engine instance.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Virtual Machine configuration settings.
	VirtualMachineConfig *VirtualMachineConfig `protobuf:"bytes,3,opt,name=virtual_machine_config,json=virtualMachineConfig,proto3" json:"virtual_machine_config,omitempty"`
	// contains filtered or unexported fields
}

Runtime using Virtual Machine for computing.

func (*VirtualMachine) ClearVirtualMachineConfig

func (x *VirtualMachine) ClearVirtualMachineConfig()

func (*VirtualMachine) GetInstanceId

func (x *VirtualMachine) GetInstanceId() string

func (*VirtualMachine) GetInstanceName

func (x *VirtualMachine) GetInstanceName() string

func (*VirtualMachine) GetVirtualMachineConfig

func (x *VirtualMachine) GetVirtualMachineConfig() *VirtualMachineConfig

func (*VirtualMachine) HasVirtualMachineConfig

func (x *VirtualMachine) HasVirtualMachineConfig() bool

func (*VirtualMachine) ProtoMessage

func (*VirtualMachine) ProtoMessage()

func (*VirtualMachine) ProtoReflect

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

func (*VirtualMachine) Reset

func (x *VirtualMachine) Reset()

func (*VirtualMachine) SetInstanceId

func (x *VirtualMachine) SetInstanceId(v string)

func (*VirtualMachine) SetInstanceName

func (x *VirtualMachine) SetInstanceName(v string)

func (*VirtualMachine) SetVirtualMachineConfig

func (x *VirtualMachine) SetVirtualMachineConfig(v *VirtualMachineConfig)

func (*VirtualMachine) String

func (x *VirtualMachine) String() string

type VirtualMachineConfig

type VirtualMachineConfig struct {

	// Output only. The zone where the virtual machine is located.
	// If using regional request, the notebooks service will pick a location
	// in the corresponding runtime region.
	// On a get request, zone will always be present. Example:
	// * `us-central1-b`
	Zone string `protobuf:"bytes,1,opt,name=zone,proto3" json:"zone,omitempty"`
	// Required. The Compute Engine machine type used for runtimes.
	// Short name is valid. Examples:
	// * `n1-standard-2`
	// * `e2-standard-8`
	MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// Optional. Use a list of container images to use as Kernels in the notebook
	// instance.
	ContainerImages []*ContainerImage `protobuf:"bytes,3,rep,name=container_images,json=containerImages,proto3" json:"container_images,omitempty"`
	// Required. Data disk option configuration settings.
	DataDisk *LocalDisk `protobuf:"bytes,4,opt,name=data_disk,json=dataDisk,proto3" json:"data_disk,omitempty"`
	// Optional. Encryption settings for virtual machine data disk.
	EncryptionConfig *EncryptionConfig `protobuf:"bytes,5,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// Optional. Shielded VM Instance configuration settings.
	ShieldedInstanceConfig *RuntimeShieldedInstanceConfig `` /* 129-byte string literal not displayed */
	// Optional. The Compute Engine accelerator configuration for this runtime.
	AcceleratorConfig *RuntimeAcceleratorConfig `protobuf:"bytes,7,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
	// Optional. The Compute Engine network to be used for machine
	// communications. Cannot be specified with subnetwork. If neither
	// `network` nor `subnet` is specified, the "default" network of
	// the project is used, if it exists.
	//
	// A full URL or partial URI. Examples:
	//
	// * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default`
	// * `projects/[project_id]/global/networks/default`
	//
	// Runtimes are managed resources inside Google Infrastructure.
	// Runtimes support the following network configurations:
	//
	// * Google Managed Network (Network & subnet are empty)
	// * Consumer Project VPC (network & subnet are required). Requires
	// configuring Private Service Access.
	// * Shared VPC (network & subnet are required). Requires configuring Private
	// Service Access.
	Network string `protobuf:"bytes,8,opt,name=network,proto3" json:"network,omitempty"`
	// Optional. The Compute Engine subnetwork to be used for machine
	// communications. Cannot be specified with network.
	//
	// A full URL or partial URI are valid. Examples:
	//
	// * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0`
	// * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
	Subnet string `protobuf:"bytes,9,opt,name=subnet,proto3" json:"subnet,omitempty"`
	// Optional. If true, runtime will only have internal IP
	// addresses. By default, runtimes are not restricted to internal IP
	// addresses, and will have ephemeral external IP addresses assigned to each
	// vm. This `internal_ip_only` restriction can only be enabled for
	// subnetwork enabled networks, and all dependencies must be
	// configured to be accessible without external IP addresses.
	InternalIpOnly bool `protobuf:"varint,10,opt,name=internal_ip_only,json=internalIpOnly,proto3" json:"internal_ip_only,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,13,rep,name=tags,proto3" json:"tags,omitempty"`
	// Output only. The Compute Engine guest attributes. (see
	// [Project and instance
	// guest
	// attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
	GuestAttributes map[string]string `` /* 181-byte string literal not displayed */
	// Optional. The Compute Engine metadata entries to add to virtual machine.
	// (see [Project and instance
	// metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
	Metadata map[string]string `` /* 144-byte string literal not displayed */
	// Optional. The labels to associate with this runtime.
	// Label **keys** must contain 1 to 63 characters, and must conform to
	// [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Label **values** may be empty, but, if present, must contain 1 to 63
	// characters, and must conform to [RFC
	// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
	// associated with a cluster.
	Labels map[string]string `` /* 140-byte string literal not displayed */
	// Optional. The type of vNIC to be used on this interface. This may be gVNIC
	// or VirtioNet.
	NicType VirtualMachineConfig_NicType `` /* 151-byte string literal not displayed */
	// Optional. Reserved IP Range name is used for VPC Peering.
	// The subnetwork allocation will use the range *name* if it's assigned.
	//
	// Example: managed-notebooks-range-c
	//
	//	PEERING_RANGE_NAME_3=managed-notebooks-range-c
	//	gcloud compute addresses create $PEERING_RANGE_NAME_3 \
	//	  --global \
	//	  --prefix-length=24 \
	//	  --description="Google Cloud Managed Notebooks Range 24 c" \
	//	  --network=$NETWORK \
	//	  --addresses=192.168.0.0 \
	//	  --purpose=VPC_PEERING
	//
	// Field value will be: `managed-notebooks-range-c`
	ReservedIpRange string `protobuf:"bytes,18,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_ip_range,omitempty"`
	// Optional. Boot image metadata used for runtime upgradeability.
	BootImage *VirtualMachineConfig_BootImage `protobuf:"bytes,19,opt,name=boot_image,json=bootImage,proto3" json:"boot_image,omitempty"`
	// contains filtered or unexported fields
}

The config settings for virtual machine.

func (*VirtualMachineConfig) ClearAcceleratorConfig

func (x *VirtualMachineConfig) ClearAcceleratorConfig()

func (*VirtualMachineConfig) ClearBootImage

func (x *VirtualMachineConfig) ClearBootImage()

func (*VirtualMachineConfig) ClearDataDisk

func (x *VirtualMachineConfig) ClearDataDisk()

func (*VirtualMachineConfig) ClearEncryptionConfig

func (x *VirtualMachineConfig) ClearEncryptionConfig()

func (*VirtualMachineConfig) ClearShieldedInstanceConfig

func (x *VirtualMachineConfig) ClearShieldedInstanceConfig()

func (*VirtualMachineConfig) GetAcceleratorConfig

func (x *VirtualMachineConfig) GetAcceleratorConfig() *RuntimeAcceleratorConfig

func (*VirtualMachineConfig) GetBootImage

func (*VirtualMachineConfig) GetContainerImages

func (x *VirtualMachineConfig) GetContainerImages() []*ContainerImage

func (*VirtualMachineConfig) GetDataDisk

func (x *VirtualMachineConfig) GetDataDisk() *LocalDisk

func (*VirtualMachineConfig) GetEncryptionConfig

func (x *VirtualMachineConfig) GetEncryptionConfig() *EncryptionConfig

func (*VirtualMachineConfig) GetGuestAttributes

func (x *VirtualMachineConfig) GetGuestAttributes() map[string]string

func (*VirtualMachineConfig) GetInternalIpOnly

func (x *VirtualMachineConfig) GetInternalIpOnly() bool

func (*VirtualMachineConfig) GetLabels

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

func (*VirtualMachineConfig) GetMachineType

func (x *VirtualMachineConfig) GetMachineType() string

func (*VirtualMachineConfig) GetMetadata

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

func (*VirtualMachineConfig) GetNetwork

func (x *VirtualMachineConfig) GetNetwork() string

func (*VirtualMachineConfig) GetNicType

func (*VirtualMachineConfig) GetReservedIpRange

func (x *VirtualMachineConfig) GetReservedIpRange() string

func (*VirtualMachineConfig) GetShieldedInstanceConfig

func (x *VirtualMachineConfig) GetShieldedInstanceConfig() *RuntimeShieldedInstanceConfig

func (*VirtualMachineConfig) GetSubnet

func (x *VirtualMachineConfig) GetSubnet() string

func (*VirtualMachineConfig) GetTags

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

func (*VirtualMachineConfig) GetZone

func (x *VirtualMachineConfig) GetZone() string

func (*VirtualMachineConfig) HasAcceleratorConfig

func (x *VirtualMachineConfig) HasAcceleratorConfig() bool

func (*VirtualMachineConfig) HasBootImage

func (x *VirtualMachineConfig) HasBootImage() bool

func (*VirtualMachineConfig) HasDataDisk

func (x *VirtualMachineConfig) HasDataDisk() bool

func (*VirtualMachineConfig) HasEncryptionConfig

func (x *VirtualMachineConfig) HasEncryptionConfig() bool

func (*VirtualMachineConfig) HasShieldedInstanceConfig

func (x *VirtualMachineConfig) HasShieldedInstanceConfig() bool

func (*VirtualMachineConfig) ProtoMessage

func (*VirtualMachineConfig) ProtoMessage()

func (*VirtualMachineConfig) ProtoReflect

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

func (*VirtualMachineConfig) Reset

func (x *VirtualMachineConfig) Reset()

func (*VirtualMachineConfig) SetAcceleratorConfig

func (x *VirtualMachineConfig) SetAcceleratorConfig(v *RuntimeAcceleratorConfig)

func (*VirtualMachineConfig) SetBootImage

func (*VirtualMachineConfig) SetContainerImages

func (x *VirtualMachineConfig) SetContainerImages(v []*ContainerImage)

func (*VirtualMachineConfig) SetDataDisk

func (x *VirtualMachineConfig) SetDataDisk(v *LocalDisk)

func (*VirtualMachineConfig) SetEncryptionConfig

func (x *VirtualMachineConfig) SetEncryptionConfig(v *EncryptionConfig)

func (*VirtualMachineConfig) SetGuestAttributes

func (x *VirtualMachineConfig) SetGuestAttributes(v map[string]string)

func (*VirtualMachineConfig) SetInternalIpOnly

func (x *VirtualMachineConfig) SetInternalIpOnly(v bool)

func (*VirtualMachineConfig) SetLabels

func (x *VirtualMachineConfig) SetLabels(v map[string]string)

func (*VirtualMachineConfig) SetMachineType

func (x *VirtualMachineConfig) SetMachineType(v string)

func (*VirtualMachineConfig) SetMetadata

func (x *VirtualMachineConfig) SetMetadata(v map[string]string)

func (*VirtualMachineConfig) SetNetwork

func (x *VirtualMachineConfig) SetNetwork(v string)

func (*VirtualMachineConfig) SetNicType

func (*VirtualMachineConfig) SetReservedIpRange

func (x *VirtualMachineConfig) SetReservedIpRange(v string)

func (*VirtualMachineConfig) SetShieldedInstanceConfig

func (x *VirtualMachineConfig) SetShieldedInstanceConfig(v *RuntimeShieldedInstanceConfig)

func (*VirtualMachineConfig) SetSubnet

func (x *VirtualMachineConfig) SetSubnet(v string)

func (*VirtualMachineConfig) SetTags

func (x *VirtualMachineConfig) SetTags(v []string)

func (*VirtualMachineConfig) SetZone

func (x *VirtualMachineConfig) SetZone(v string)

func (*VirtualMachineConfig) String

func (x *VirtualMachineConfig) String() string

type VirtualMachineConfig_BootImage

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

Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.

func (*VirtualMachineConfig_BootImage) ProtoMessage

func (*VirtualMachineConfig_BootImage) ProtoMessage()

func (*VirtualMachineConfig_BootImage) ProtoReflect

func (*VirtualMachineConfig_BootImage) Reset

func (x *VirtualMachineConfig_BootImage) Reset()

func (*VirtualMachineConfig_BootImage) String

type VirtualMachineConfig_BootImage_builder

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

func (VirtualMachineConfig_BootImage_builder) Build

type VirtualMachineConfig_NicType

type VirtualMachineConfig_NicType int32

The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.

const (
	// No type specified.
	VirtualMachineConfig_UNSPECIFIED_NIC_TYPE VirtualMachineConfig_NicType = 0
	// VIRTIO
	VirtualMachineConfig_VIRTIO_NET VirtualMachineConfig_NicType = 1
	// GVNIC
	VirtualMachineConfig_GVNIC VirtualMachineConfig_NicType = 2
)

func (VirtualMachineConfig_NicType) Descriptor

func (VirtualMachineConfig_NicType) Enum

func (VirtualMachineConfig_NicType) Number

func (VirtualMachineConfig_NicType) String

func (VirtualMachineConfig_NicType) Type

type VirtualMachineConfig_builder

type VirtualMachineConfig_builder struct {

	// Output only. The zone where the virtual machine is located.
	// If using regional request, the notebooks service will pick a location
	// in the corresponding runtime region.
	// On a get request, zone will always be present. Example:
	// * `us-central1-b`
	Zone string
	// Required. The Compute Engine machine type used for runtimes.
	// Short name is valid. Examples:
	// * `n1-standard-2`
	// * `e2-standard-8`
	MachineType string
	// Optional. Use a list of container images to use as Kernels in the notebook
	// instance.
	ContainerImages []*ContainerImage
	// Required. Data disk option configuration settings.
	DataDisk *LocalDisk
	// Optional. Encryption settings for virtual machine data disk.
	EncryptionConfig *EncryptionConfig
	// Optional. Shielded VM Instance configuration settings.
	ShieldedInstanceConfig *RuntimeShieldedInstanceConfig
	// Optional. The Compute Engine accelerator configuration for this runtime.
	AcceleratorConfig *RuntimeAcceleratorConfig
	// Optional. The Compute Engine network to be used for machine
	// communications. Cannot be specified with subnetwork. If neither
	// `network` nor `subnet` is specified, the "default" network of
	// the project is used, if it exists.
	//
	// A full URL or partial URI. Examples:
	//
	// * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default`
	// * `projects/[project_id]/global/networks/default`
	//
	// Runtimes are managed resources inside Google Infrastructure.
	// Runtimes support the following network configurations:
	//
	// * Google Managed Network (Network & subnet are empty)
	// * Consumer Project VPC (network & subnet are required). Requires
	// configuring Private Service Access.
	// * Shared VPC (network & subnet are required). Requires configuring Private
	// Service Access.
	Network string
	// Optional. The Compute Engine subnetwork to be used for machine
	// communications. Cannot be specified with network.
	//
	// A full URL or partial URI are valid. Examples:
	//
	// * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0`
	// * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
	Subnet string
	// Optional. If true, runtime will only have internal IP
	// addresses. By default, runtimes are not restricted to internal IP
	// addresses, and will have ephemeral external IP addresses assigned to each
	// vm. This `internal_ip_only` restriction can only be enabled for
	// subnetwork enabled networks, and all dependencies must be
	// configured to be accessible without external IP addresses.
	InternalIpOnly bool
	// 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
	// Output only. The Compute Engine guest attributes. (see
	// [Project and instance
	// guest
	// attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
	GuestAttributes map[string]string
	// Optional. The Compute Engine metadata entries to add to virtual machine.
	// (see [Project and instance
	// metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
	Metadata map[string]string
	// Optional. The labels to associate with this runtime.
	// Label **keys** must contain 1 to 63 characters, and must conform to
	// [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
	// Label **values** may be empty, but, if present, must contain 1 to 63
	// characters, and must conform to [RFC
	// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
	// associated with a cluster.
	Labels map[string]string
	// Optional. The type of vNIC to be used on this interface. This may be gVNIC
	// or VirtioNet.
	NicType VirtualMachineConfig_NicType
	// Optional. Reserved IP Range name is used for VPC Peering.
	// The subnetwork allocation will use the range *name* if it's assigned.
	//
	// Example: managed-notebooks-range-c
	//
	//	PEERING_RANGE_NAME_3=managed-notebooks-range-c
	//	gcloud compute addresses create $PEERING_RANGE_NAME_3 \
	//	  --global \
	//	  --prefix-length=24 \
	//	  --description="Google Cloud Managed Notebooks Range 24 c" \
	//	  --network=$NETWORK \
	//	  --addresses=192.168.0.0 \
	//	  --purpose=VPC_PEERING
	//
	// Field value will be: `managed-notebooks-range-c`
	ReservedIpRange string
	// Optional. Boot image metadata used for runtime upgradeability.
	BootImage *VirtualMachineConfig_BootImage
	// contains filtered or unexported fields
}

func (VirtualMachineConfig_builder) Build

type VirtualMachine_builder

type VirtualMachine_builder struct {

	// Output only. The user-friendly name of the Managed Compute Engine instance.
	InstanceName string
	// Output only. The unique identifier of the Managed Compute Engine instance.
	InstanceId string
	// Virtual Machine configuration settings.
	VirtualMachineConfig *VirtualMachineConfig
	// contains filtered or unexported fields
}

func (VirtualMachine_builder) Build

type 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 valid to be assigned 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) ClearImage

func (x *VmImage) ClearImage()

func (*VmImage) ClearImageFamily

func (x *VmImage) ClearImageFamily()

func (*VmImage) ClearImageName

func (x *VmImage) ClearImageName()

func (*VmImage) GetImage

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

func (x *VmImage) HasImage() bool

func (*VmImage) HasImageFamily

func (x *VmImage) HasImageFamily() bool

func (*VmImage) HasImageName

func (x *VmImage) HasImageName() bool

func (*VmImage) ProtoMessage

func (*VmImage) ProtoMessage()

func (*VmImage) ProtoReflect

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

func (*VmImage) Reset

func (x *VmImage) Reset()

func (*VmImage) SetImageFamily

func (x *VmImage) SetImageFamily(v string)

func (*VmImage) SetImageName

func (x *VmImage) SetImageName(v string)

func (*VmImage) SetProject

func (x *VmImage) SetProject(v string)

func (*VmImage) String

func (x *VmImage) String() string

func (*VmImage) WhichImage

func (x *VmImage) WhichImage() case_VmImage_Image

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

type VmImage_builder

type VmImage_builder struct {

	// Required. The name of the Google Cloud project that this VM image belongs
	// to. Format: `{project_id}`
	Project string

	// Fields of oneof Image:
	// Use VM image name to find the image.
	ImageName *string
	// Use this VM image family to find the image; the newest image in this
	// family will be used.
	ImageFamily *string
	// contains filtered or unexported fields
}

func (VmImage_builder) Build

func (b0 VmImage_builder) Build() *VmImage

Source Files

  • data.pb.go
  • events.pb.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL