Variables
Event_EventType_name, Event_EventType_value
var (
Event_EventType_name = map[int32]string{
0: "EVENT_TYPE_UNSPECIFIED",
1: "IDLE",
2: "HEARTBEAT",
3: "HEALTH",
4: "MAINTENANCE",
}
Event_EventType_value = map[string]int32{
"EVENT_TYPE_UNSPECIFIED": 0,
"IDLE": 1,
"HEARTBEAT": 2,
"HEALTH": 3,
"MAINTENANCE": 4,
}
)
Enum value maps for Event_EventType.
ExecutionTemplate_ScaleTier_name, ExecutionTemplate_ScaleTier_value
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.
ExecutionTemplate_SchedulerAcceleratorType_name, ExecutionTemplate_SchedulerAcceleratorType_value
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.
ExecutionTemplate_JobType_name, ExecutionTemplate_JobType_value
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.
Execution_State_name, Execution_State_value
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.
ReservationAffinity_Type_name, ReservationAffinity_Type_value
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.
Instance_AcceleratorType_name, Instance_AcceleratorType_value
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.
Instance_State_name, Instance_State_value
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.
Instance_DiskType_name, Instance_DiskType_value
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.
Instance_DiskEncryption_name, Instance_DiskEncryption_value
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.
Instance_NicType_name, Instance_NicType_value
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.
Instance_UpgradeHistoryEntry_State_name, Instance_UpgradeHistoryEntry_State_value
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.
Instance_UpgradeHistoryEntry_Action_name, Instance_UpgradeHistoryEntry_Action_value
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.
Runtime_State_name, Runtime_State_value
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.
Runtime_HealthState_name, Runtime_HealthState_value
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.
RuntimeAcceleratorConfig_AcceleratorType_name, RuntimeAcceleratorConfig_AcceleratorType_value
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.
LocalDiskInitializeParams_DiskType_name, LocalDiskInitializeParams_DiskType_value
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.
RuntimeAccessConfig_RuntimeAccessType_name, RuntimeAccessConfig_RuntimeAccessType_value
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.
RuntimeSoftwareConfig_PostStartupScriptBehavior_name, RuntimeSoftwareConfig_PostStartupScriptBehavior_value
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.
VirtualMachineConfig_NicType_name, VirtualMachineConfig_NicType_value
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.
Schedule_State_name, Schedule_State_value
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.
UpgradeType_name, UpgradeType_value
var (
UpgradeType_name = map[int32]string{
0: "UPGRADE_TYPE_UNSPECIFIED",
1: "UPGRADE_FRAMEWORK",
2: "UPGRADE_OS",
3: "UPGRADE_CUDA",
4: "UPGRADE_ALL",
}
UpgradeType_value = map[string]int32{
"UPGRADE_TYPE_UNSPECIFIED": 0,
"UPGRADE_FRAMEWORK": 1,
"UPGRADE_OS": 2,
"UPGRADE_CUDA": 3,
"UPGRADE_ALL": 4,
}
)
Enum value maps for UpgradeType.
GetInstanceHealthResponse_HealthState_name, GetInstanceHealthResponse_HealthState_value
var (
GetInstanceHealthResponse_HealthState_name = map[int32]string{
0: "HEALTH_STATE_UNSPECIFIED",
1: "HEALTHY",
2: "UNHEALTHY",
3: "AGENT_NOT_INSTALLED",
4: "AGENT_NOT_RUNNING",
}
GetInstanceHealthResponse_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 GetInstanceHealthResponse_HealthState.
File_google_cloud_notebooks_v1_diagnostic_config_proto
var File_google_cloud_notebooks_v1_diagnostic_config_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_environment_proto
var File_google_cloud_notebooks_v1_environment_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_event_proto
var File_google_cloud_notebooks_v1_event_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_execution_proto
var File_google_cloud_notebooks_v1_execution_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_instance_config_proto
var File_google_cloud_notebooks_v1_instance_config_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_instance_proto
var File_google_cloud_notebooks_v1_instance_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_managed_service_proto
var File_google_cloud_notebooks_v1_managed_service_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_runtime_proto
var File_google_cloud_notebooks_v1_runtime_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_schedule_proto
var File_google_cloud_notebooks_v1_schedule_proto protoreflect.FileDescriptor
File_google_cloud_notebooks_v1_service_proto
var File_google_cloud_notebooks_v1_service_proto protoreflect.FileDescriptor
Functions
func RegisterManagedNotebookServiceServer
func RegisterManagedNotebookServiceServer(s *grpc.Server, srv ManagedNotebookServiceServer)
func RegisterNotebookServiceServer
func RegisterNotebookServiceServer(s *grpc.Server, srv NotebookServiceServer)
ContainerImage
type ContainerImage struct {
// Required. The path to the container image repository. For example:
// `gcr.io/{project_id}/{image_name}`
Repository string `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
// The tag of the container image. If not specified, this defaults
// to the latest tag.
Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
// contains filtered or unexported fields
}
Definition of a container image for starting a notebook instance with the environment installed in a container.
func (*ContainerImage) Descriptor
func (*ContainerImage) Descriptor() ([]byte, []int)
Deprecated: Use ContainerImage.ProtoReflect.Descriptor instead.
func (*ContainerImage) GetRepository
func (x *ContainerImage) GetRepository() string
func (*ContainerImage) GetTag
func (x *ContainerImage) GetTag() string
func (*ContainerImage) ProtoMessage
func (*ContainerImage) ProtoMessage()
func (*ContainerImage) ProtoReflect
func (x *ContainerImage) ProtoReflect() protoreflect.Message
func (*ContainerImage) Reset
func (x *ContainerImage) Reset()
func (*ContainerImage) String
func (x *ContainerImage) String() string
CreateEnvironmentRequest
type CreateEnvironmentRequest struct {
// Required. Format: `projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User-defined unique ID of this environment. The `environment_id` must
// be 1 to 63 characters long and contain only lowercase letters,
// numeric characters, and dashes. The first character must be a lowercase
// letter and the last character cannot be a dash.
EnvironmentId string `protobuf:"bytes,2,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
// Required. The environment to be created.
Environment *Environment `protobuf:"bytes,3,opt,name=environment,proto3" json:"environment,omitempty"`
// contains filtered or unexported fields
}
Request for creating a notebook environment.
func (*CreateEnvironmentRequest) Descriptor
func (*CreateEnvironmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateEnvironmentRequest.ProtoReflect.Descriptor instead.
func (*CreateEnvironmentRequest) GetEnvironment
func (x *CreateEnvironmentRequest) GetEnvironment() *Environment
func (*CreateEnvironmentRequest) GetEnvironmentId
func (x *CreateEnvironmentRequest) GetEnvironmentId() string
func (*CreateEnvironmentRequest) GetParent
func (x *CreateEnvironmentRequest) GetParent() string
func (*CreateEnvironmentRequest) ProtoMessage
func (*CreateEnvironmentRequest) ProtoMessage()
func (*CreateEnvironmentRequest) ProtoReflect
func (x *CreateEnvironmentRequest) ProtoReflect() protoreflect.Message
func (*CreateEnvironmentRequest) Reset
func (x *CreateEnvironmentRequest) Reset()
func (*CreateEnvironmentRequest) String
func (x *CreateEnvironmentRequest) String() string
CreateExecutionRequest
type CreateExecutionRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User-defined unique ID of this execution.
ExecutionId string `protobuf:"bytes,2,opt,name=execution_id,json=executionId,proto3" json:"execution_id,omitempty"`
// Required. The execution to be created.
Execution *Execution `protobuf:"bytes,3,opt,name=execution,proto3" json:"execution,omitempty"`
// contains filtered or unexported fields
}
Request to create notebook execution
func (*CreateExecutionRequest) Descriptor
func (*CreateExecutionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateExecutionRequest.ProtoReflect.Descriptor instead.
func (*CreateExecutionRequest) GetExecution
func (x *CreateExecutionRequest) GetExecution() *Execution
func (*CreateExecutionRequest) GetExecutionId
func (x *CreateExecutionRequest) GetExecutionId() string
func (*CreateExecutionRequest) GetParent
func (x *CreateExecutionRequest) GetParent() string
func (*CreateExecutionRequest) ProtoMessage
func (*CreateExecutionRequest) ProtoMessage()
func (*CreateExecutionRequest) ProtoReflect
func (x *CreateExecutionRequest) ProtoReflect() protoreflect.Message
func (*CreateExecutionRequest) Reset
func (x *CreateExecutionRequest) Reset()
func (*CreateExecutionRequest) String
func (x *CreateExecutionRequest) String() string
CreateInstanceRequest
type CreateInstanceRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User-defined unique ID of this instance.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The instance to be created.
Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// contains filtered or unexported fields
}
Request for creating a notebook instance.
func (*CreateInstanceRequest) Descriptor
func (*CreateInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.
func (*CreateInstanceRequest) GetInstance
func (x *CreateInstanceRequest) GetInstance() *Instance
func (*CreateInstanceRequest) GetInstanceId
func (x *CreateInstanceRequest) GetInstanceId() string
func (*CreateInstanceRequest) GetParent
func (x *CreateInstanceRequest) GetParent() string
func (*CreateInstanceRequest) ProtoMessage
func (*CreateInstanceRequest) ProtoMessage()
func (*CreateInstanceRequest) ProtoReflect
func (x *CreateInstanceRequest) ProtoReflect() protoreflect.Message
func (*CreateInstanceRequest) Reset
func (x *CreateInstanceRequest) Reset()
func (*CreateInstanceRequest) String
func (x *CreateInstanceRequest) String() string
CreateRuntimeRequest
type CreateRuntimeRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User-defined unique ID of this Runtime.
RuntimeId string `protobuf:"bytes,2,opt,name=runtime_id,json=runtimeId,proto3" json:"runtime_id,omitempty"`
// Required. The Runtime to be created.
Runtime *Runtime `protobuf:"bytes,3,opt,name=runtime,proto3" json:"runtime,omitempty"`
// Idempotent request UUID.
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
Request for creating a Managed Notebook Runtime.
func (*CreateRuntimeRequest) Descriptor
func (*CreateRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRuntimeRequest.ProtoReflect.Descriptor instead.
func (*CreateRuntimeRequest) GetParent
func (x *CreateRuntimeRequest) GetParent() string
func (*CreateRuntimeRequest) GetRequestId
func (x *CreateRuntimeRequest) GetRequestId() string
func (*CreateRuntimeRequest) GetRuntime
func (x *CreateRuntimeRequest) GetRuntime() *Runtime
func (*CreateRuntimeRequest) GetRuntimeId
func (x *CreateRuntimeRequest) GetRuntimeId() string
func (*CreateRuntimeRequest) ProtoMessage
func (*CreateRuntimeRequest) ProtoMessage()
func (*CreateRuntimeRequest) ProtoReflect
func (x *CreateRuntimeRequest) ProtoReflect() protoreflect.Message
func (*CreateRuntimeRequest) Reset
func (x *CreateRuntimeRequest) Reset()
func (*CreateRuntimeRequest) String
func (x *CreateRuntimeRequest) String() string
CreateScheduleRequest
type CreateScheduleRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User-defined unique ID of this schedule.
ScheduleId string `protobuf:"bytes,2,opt,name=schedule_id,json=scheduleId,proto3" json:"schedule_id,omitempty"`
// Required. The schedule to be created.
Schedule *Schedule `protobuf:"bytes,3,opt,name=schedule,proto3" json:"schedule,omitempty"`
// contains filtered or unexported fields
}
Request for created scheduled notebooks
func (*CreateScheduleRequest) Descriptor
func (*CreateScheduleRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateScheduleRequest.ProtoReflect.Descriptor instead.
func (*CreateScheduleRequest) GetParent
func (x *CreateScheduleRequest) GetParent() string
func (*CreateScheduleRequest) GetSchedule
func (x *CreateScheduleRequest) GetSchedule() *Schedule
func (*CreateScheduleRequest) GetScheduleId
func (x *CreateScheduleRequest) GetScheduleId() string
func (*CreateScheduleRequest) ProtoMessage
func (*CreateScheduleRequest) ProtoMessage()
func (*CreateScheduleRequest) ProtoReflect
func (x *CreateScheduleRequest) ProtoReflect() protoreflect.Message
func (*CreateScheduleRequest) Reset
func (x *CreateScheduleRequest) Reset()
func (*CreateScheduleRequest) String
func (x *CreateScheduleRequest) String() string
DeleteEnvironmentRequest
type DeleteEnvironmentRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/environments/{environment_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for deleting a notebook environment.
func (*DeleteEnvironmentRequest) Descriptor
func (*DeleteEnvironmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteEnvironmentRequest.ProtoReflect.Descriptor instead.
func (*DeleteEnvironmentRequest) GetName
func (x *DeleteEnvironmentRequest) GetName() string
func (*DeleteEnvironmentRequest) ProtoMessage
func (*DeleteEnvironmentRequest) ProtoMessage()
func (*DeleteEnvironmentRequest) ProtoReflect
func (x *DeleteEnvironmentRequest) ProtoReflect() protoreflect.Message
func (*DeleteEnvironmentRequest) Reset
func (x *DeleteEnvironmentRequest) Reset()
func (*DeleteEnvironmentRequest) String
func (x *DeleteEnvironmentRequest) String() string
DeleteExecutionRequest
type DeleteExecutionRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/executions/{execution_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for deleting a scheduled notebook execution
func (*DeleteExecutionRequest) Descriptor
func (*DeleteExecutionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteExecutionRequest.ProtoReflect.Descriptor instead.
func (*DeleteExecutionRequest) GetName
func (x *DeleteExecutionRequest) GetName() string
func (*DeleteExecutionRequest) ProtoMessage
func (*DeleteExecutionRequest) ProtoMessage()
func (*DeleteExecutionRequest) ProtoReflect
func (x *DeleteExecutionRequest) ProtoReflect() protoreflect.Message
func (*DeleteExecutionRequest) Reset
func (x *DeleteExecutionRequest) Reset()
func (*DeleteExecutionRequest) String
func (x *DeleteExecutionRequest) String() string
DeleteInstanceRequest
type DeleteInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for deleting a notebook instance.
func (*DeleteInstanceRequest) Descriptor
func (*DeleteInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.
func (*DeleteInstanceRequest) GetName
func (x *DeleteInstanceRequest) GetName() string
func (*DeleteInstanceRequest) ProtoMessage
func (*DeleteInstanceRequest) ProtoMessage()
func (*DeleteInstanceRequest) ProtoReflect
func (x *DeleteInstanceRequest) ProtoReflect() protoreflect.Message
func (*DeleteInstanceRequest) Reset
func (x *DeleteInstanceRequest) Reset()
func (*DeleteInstanceRequest) String
func (x *DeleteInstanceRequest) String() string
DeleteRuntimeRequest
type DeleteRuntimeRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Idempotent request UUID.
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
Request for deleting a Managed Notebook Runtime.
func (*DeleteRuntimeRequest) Descriptor
func (*DeleteRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRuntimeRequest.ProtoReflect.Descriptor instead.
func (*DeleteRuntimeRequest) GetName
func (x *DeleteRuntimeRequest) GetName() string
func (*DeleteRuntimeRequest) GetRequestId
func (x *DeleteRuntimeRequest) GetRequestId() string
func (*DeleteRuntimeRequest) ProtoMessage
func (*DeleteRuntimeRequest) ProtoMessage()
func (*DeleteRuntimeRequest) ProtoReflect
func (x *DeleteRuntimeRequest) ProtoReflect() protoreflect.Message
func (*DeleteRuntimeRequest) Reset
func (x *DeleteRuntimeRequest) Reset()
func (*DeleteRuntimeRequest) String
func (x *DeleteRuntimeRequest) String() string
DeleteScheduleRequest
type DeleteScheduleRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for deleting an Schedule
func (*DeleteScheduleRequest) Descriptor
func (*DeleteScheduleRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteScheduleRequest.ProtoReflect.Descriptor instead.
func (*DeleteScheduleRequest) GetName
func (x *DeleteScheduleRequest) GetName() string
func (*DeleteScheduleRequest) ProtoMessage
func (*DeleteScheduleRequest) ProtoMessage()
func (*DeleteScheduleRequest) ProtoReflect
func (x *DeleteScheduleRequest) ProtoReflect() protoreflect.Message
func (*DeleteScheduleRequest) Reset
func (x *DeleteScheduleRequest) Reset()
func (*DeleteScheduleRequest) String
func (x *DeleteScheduleRequest) String() string
DiagnoseInstanceRequest
type DiagnoseInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Defines flags that are used to run the diagnostic tool
DiagnosticConfig *DiagnosticConfig `protobuf:"bytes,2,opt,name=diagnostic_config,json=diagnosticConfig,proto3" json:"diagnostic_config,omitempty"`
// contains filtered or unexported fields
}
Request for creating a notebook instance diagnostic file.
func (*DiagnoseInstanceRequest) Descriptor
func (*DiagnoseInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DiagnoseInstanceRequest.ProtoReflect.Descriptor instead.
func (*DiagnoseInstanceRequest) GetDiagnosticConfig
func (x *DiagnoseInstanceRequest) GetDiagnosticConfig() *DiagnosticConfig
func (*DiagnoseInstanceRequest) GetName
func (x *DiagnoseInstanceRequest) GetName() string
func (*DiagnoseInstanceRequest) ProtoMessage
func (*DiagnoseInstanceRequest) ProtoMessage()
func (*DiagnoseInstanceRequest) ProtoReflect
func (x *DiagnoseInstanceRequest) ProtoReflect() protoreflect.Message
func (*DiagnoseInstanceRequest) Reset
func (x *DiagnoseInstanceRequest) Reset()
func (*DiagnoseInstanceRequest) String
func (x *DiagnoseInstanceRequest) String() string
DiagnoseRuntimeRequest
type DiagnoseRuntimeRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Defines flags that are used to run the diagnostic tool
DiagnosticConfig *DiagnosticConfig `protobuf:"bytes,2,opt,name=diagnostic_config,json=diagnosticConfig,proto3" json:"diagnostic_config,omitempty"`
// contains filtered or unexported fields
}
Request for creating a notebook instance diagnostic file.
func (*DiagnoseRuntimeRequest) Descriptor
func (*DiagnoseRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use DiagnoseRuntimeRequest.ProtoReflect.Descriptor instead.
func (*DiagnoseRuntimeRequest) GetDiagnosticConfig
func (x *DiagnoseRuntimeRequest) GetDiagnosticConfig() *DiagnosticConfig
func (*DiagnoseRuntimeRequest) GetName
func (x *DiagnoseRuntimeRequest) GetName() string
func (*DiagnoseRuntimeRequest) ProtoMessage
func (*DiagnoseRuntimeRequest) ProtoMessage()
func (*DiagnoseRuntimeRequest) ProtoReflect
func (x *DiagnoseRuntimeRequest) ProtoReflect() protoreflect.Message
func (*DiagnoseRuntimeRequest) Reset
func (x *DiagnoseRuntimeRequest) Reset()
func (*DiagnoseRuntimeRequest) String
func (x *DiagnoseRuntimeRequest) String() string
DiagnosticConfig
type DiagnosticConfig struct {
// Required. User Cloud Storage bucket location (REQUIRED).
// Must be formatted with path prefix (`gs://$GCS_BUCKET`).
//
// Permissions:
// User Managed Notebooks:
// - storage.buckets.writer: Must be given to the project's service account
// attached to VM.
//
// Google Managed Notebooks:
// - storage.buckets.writer: Must be given to the project's service account or
// user credentials attached to VM depending on authentication mode.
//
// Cloud Storage bucket Log file will be written to
// `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
GcsBucket string `protobuf:"bytes,1,opt,name=gcs_bucket,json=gcsBucket,proto3" json:"gcs_bucket,omitempty"`
// Optional. Defines the relative storage path in the Cloud Storage bucket
// where the diagnostic logs will be written: Default path will be the root
// directory of the Cloud Storage bucket
// (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
// Example of full path where Log file will be written:
// `gs://$GCS_BUCKET/$RELATIVE_PATH/`
RelativePath string `protobuf:"bytes,2,opt,name=relative_path,json=relativePath,proto3" json:"relative_path,omitempty"`
// Optional. Enables flag to repair service for instance
RepairFlagEnabled bool `protobuf:"varint,3,opt,name=repair_flag_enabled,json=repairFlagEnabled,proto3" json:"repair_flag_enabled,omitempty"`
// Optional. Enables flag to capture packets from the instance for 30 seconds
PacketCaptureFlagEnabled bool `protobuf:"varint,4,opt,name=packet_capture_flag_enabled,json=packetCaptureFlagEnabled,proto3" json:"packet_capture_flag_enabled,omitempty"`
// Optional. Enables flag to copy all `/home/jupyter` folder contents
CopyHomeFilesFlagEnabled bool `protobuf:"varint,5,opt,name=copy_home_files_flag_enabled,json=copyHomeFilesFlagEnabled,proto3" json:"copy_home_files_flag_enabled,omitempty"`
// contains filtered or unexported fields
}
Defines flags that are used to run the diagnostic tool
func (*DiagnosticConfig) Descriptor
func (*DiagnosticConfig) Descriptor() ([]byte, []int)
Deprecated: Use DiagnosticConfig.ProtoReflect.Descriptor instead.
func (*DiagnosticConfig) GetCopyHomeFilesFlagEnabled
func (x *DiagnosticConfig) GetCopyHomeFilesFlagEnabled() bool
func (*DiagnosticConfig) GetGcsBucket
func (x *DiagnosticConfig) GetGcsBucket() string
func (*DiagnosticConfig) GetPacketCaptureFlagEnabled
func (x *DiagnosticConfig) GetPacketCaptureFlagEnabled() bool
func (*DiagnosticConfig) GetRelativePath
func (x *DiagnosticConfig) GetRelativePath() string
func (*DiagnosticConfig) GetRepairFlagEnabled
func (x *DiagnosticConfig) GetRepairFlagEnabled() bool
func (*DiagnosticConfig) ProtoMessage
func (*DiagnosticConfig) ProtoMessage()
func (*DiagnosticConfig) ProtoReflect
func (x *DiagnosticConfig) ProtoReflect() protoreflect.Message
func (*DiagnosticConfig) Reset
func (x *DiagnosticConfig) Reset()
func (*DiagnosticConfig) String
func (x *DiagnosticConfig) String() string
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) Descriptor
func (*EncryptionConfig) Descriptor() ([]byte, []int)
Deprecated: Use EncryptionConfig.ProtoReflect.Descriptor instead.
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) String
func (x *EncryptionConfig) String() string
Environment
type Environment struct {
// Output only. Name of this environment.
// Format:
// `projects/{project_id}/locations/{location}/environments/{environment_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Display name of this environment for the UI.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// A brief description of this environment.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Type of the environment; can be one of VM image, or container image.
//
// Types that are assignable to ImageType:
//
// *Environment_VmImage
// *Environment_ContainerImage
ImageType isEnvironment_ImageType `protobuf_oneof:"image_type"`
// Path to a Bash script that automatically runs after a notebook instance
// fully boots up. The path must be a URL or
// Cloud Storage path. Example: `"gs://path-to-file/file-name"`
PostStartupScript string `protobuf:"bytes,8,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
// Output only. The time at which this environment was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
Definition of a software environment that is used to start a notebook instance.
func (*Environment) Descriptor
func (*Environment) Descriptor() ([]byte, []int)
Deprecated: Use Environment.ProtoReflect.Descriptor instead.
func (*Environment) GetContainerImage
func (x *Environment) GetContainerImage() *ContainerImage
func (*Environment) GetCreateTime
func (x *Environment) GetCreateTime() *timestamppb.Timestamp
func (*Environment) GetDescription
func (x *Environment) GetDescription() string
func (*Environment) GetDisplayName
func (x *Environment) GetDisplayName() string
func (*Environment) GetImageType
func (m *Environment) GetImageType() isEnvironment_ImageType
func (*Environment) GetName
func (x *Environment) GetName() string
func (*Environment) GetPostStartupScript
func (x *Environment) GetPostStartupScript() string
func (*Environment) GetVmImage
func (x *Environment) GetVmImage() *VmImage
func (*Environment) ProtoMessage
func (*Environment) ProtoMessage()
func (*Environment) ProtoReflect
func (x *Environment) ProtoReflect() protoreflect.Message
func (*Environment) Reset
func (x *Environment) Reset()
func (*Environment) String
func (x *Environment) String() string
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"`
}
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"`
}
Event
type Event struct {
// Event report time.
ReportTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`
// Event type.
Type Event_EventType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1.Event_EventType" json:"type,omitempty"`
// Optional. Event details. This field is used to pass event information.
Details map[string]string `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
The definition of an Event for a managed / semi-managed notebook instance.
func (*Event) Descriptor
Deprecated: Use Event.ProtoReflect.Descriptor instead.
func (*Event) GetDetails
func (*Event) GetReportTime
func (x *Event) GetReportTime() *timestamppb.Timestamp
func (*Event) GetType
func (x *Event) GetType() Event_EventType
func (*Event) ProtoMessage
func (*Event) ProtoMessage()
func (*Event) ProtoReflect
func (x *Event) ProtoReflect() protoreflect.Message
func (*Event) Reset
func (x *Event) Reset()
func (*Event) String
Event_EventType
type Event_EventType int32
The definition of the event types.
Event_EVENT_TYPE_UNSPECIFIED, Event_IDLE, Event_HEARTBEAT, Event_HEALTH, Event_MAINTENANCE
const (
// Event is not specified.
Event_EVENT_TYPE_UNSPECIFIED Event_EventType = 0
// The instance / runtime is idle
Event_IDLE Event_EventType = 1
// The instance / runtime is available.
// This event indicates that instance / runtime underlying compute is
// operational.
Event_HEARTBEAT Event_EventType = 2
// The instance / runtime health is available.
// This event indicates that instance / runtime health information.
Event_HEALTH Event_EventType = 3
// The instance / runtime is available.
// This event allows instance / runtime to send Host maintenance
// information to Control Plane.
// https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
Event_MAINTENANCE Event_EventType = 4
)
func (Event_EventType) Descriptor
func (Event_EventType) Descriptor() protoreflect.EnumDescriptor
func (Event_EventType) Enum
func (x Event_EventType) Enum() *Event_EventType
func (Event_EventType) EnumDescriptor
func (Event_EventType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Event_EventType.Descriptor instead.
func (Event_EventType) Number
func (x Event_EventType) Number() protoreflect.EnumNumber
func (Event_EventType) String
func (x Event_EventType) String() string
func (Event_EventType) Type
func (Event_EventType) Type() protoreflect.EnumType
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.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) Descriptor
Deprecated: Use Execution.ProtoReflect.Descriptor instead.
func (*Execution) GetCreateTime
func (x *Execution) GetCreateTime() *timestamppb.Timestamp
func (*Execution) GetDescription
func (*Execution) GetDisplayName
func (*Execution) GetExecutionTemplate
func (x *Execution) GetExecutionTemplate() *ExecutionTemplate
func (*Execution) GetJobUri
func (*Execution) GetName
func (*Execution) GetOutputNotebookFile
func (*Execution) GetState
func (x *Execution) GetState() Execution_State
func (*Execution) GetUpdateTime
func (x *Execution) GetUpdateTime() *timestamppb.Timestamp
func (*Execution) ProtoMessage
func (*Execution) ProtoMessage()
func (*Execution) ProtoReflect
func (x *Execution) ProtoReflect() protoreflect.Message
func (*Execution) Reset
func (x *Execution) Reset()
func (*Execution) String
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.
//
// Deprecated: Marked as deprecated in google/cloud/notebooks/v1/execution.proto.
ScaleTier ExecutionTemplate_ScaleTier `protobuf:"varint,1,opt,name=scale_tier,json=scaleTier,proto3,enum=google.cloud.notebooks.v1.ExecutionTemplate_ScaleTier" json:"scale_tier,omitempty"`
// 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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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 `protobuf:"varint,11,opt,name=job_type,json=jobType,proto3,enum=google.cloud.notebooks.v1.ExecutionTemplate_JobType" json:"job_type,omitempty"`
// Parameters for an execution type.
// NOTE: There are currently no extra parameters for VertexAI jobs.
//
// Types that are assignable 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) Descriptor
func (*ExecutionTemplate) Descriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate.ProtoReflect.Descriptor instead.
func (*ExecutionTemplate) GetAcceleratorConfig
func (x *ExecutionTemplate) GetAcceleratorConfig() *ExecutionTemplate_SchedulerAcceleratorConfig
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 (m *ExecutionTemplate) GetJobParameters() isExecutionTemplate_JobParameters
func (*ExecutionTemplate) GetJobType
func (x *ExecutionTemplate) GetJobType() ExecutionTemplate_JobType
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 (x *ExecutionTemplate) GetScaleTier() ExecutionTemplate_ScaleTier
Deprecated: Marked as deprecated in google/cloud/notebooks/v1/execution.proto.
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) ProtoMessage
func (*ExecutionTemplate) ProtoMessage()
func (*ExecutionTemplate) ProtoReflect
func (x *ExecutionTemplate) ProtoReflect() protoreflect.Message
func (*ExecutionTemplate) Reset
func (x *ExecutionTemplate) Reset()
func (*ExecutionTemplate) String
func (x *ExecutionTemplate) String()