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.
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_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
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 *timestamp.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() *timestamp.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 {
ReportTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`
Type Event_EventType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1.Event_EventType" json:"type,omitempty"`
Details map[string]string "" /* 155 byte string literal not displayed */
}
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 (*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 *timestamp.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time the Execution was last updated.
UpdateTime *timestamp.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 (*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 (*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 {
ScaleTier ExecutionTemplate_ScaleTier "" /* 148 byte string literal not displayed */
MasterType string `protobuf:"bytes,2,opt,name=master_type,json=masterType,proto3" json:"master_type,omitempty"`
AcceleratorConfig *ExecutionTemplate_SchedulerAcceleratorConfig `protobuf:"bytes,3,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
InputNotebookFile string `protobuf:"bytes,5,opt,name=input_notebook_file,json=inputNotebookFile,proto3" json:"input_notebook_file,omitempty"`
ContainerImageUri string `protobuf:"bytes,6,opt,name=container_image_uri,json=containerImageUri,proto3" json:"container_image_uri,omitempty"`
OutputNotebookFolder string `protobuf:"bytes,7,opt,name=output_notebook_folder,json=outputNotebookFolder,proto3" json:"output_notebook_folder,omitempty"`
ParamsYamlFile string `protobuf:"bytes,8,opt,name=params_yaml_file,json=paramsYamlFile,proto3" json:"params_yaml_file,omitempty"`
Parameters string `protobuf:"bytes,9,opt,name=parameters,proto3" json:"parameters,omitempty"`
ServiceAccount string `protobuf:"bytes,10,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
JobType ExecutionTemplate_JobType "" /* 141 byte string literal not displayed */
JobParameters isExecutionTemplate_JobParameters `protobuf_oneof:"job_parameters"`
KernelSpec string `protobuf:"bytes,14,opt,name=kernel_spec,json=kernelSpec,proto3" json:"kernel_spec,omitempty"`
Tensorboard string `protobuf:"bytes,15,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
}
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: Do not use.
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() string
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) Descriptor
func (*ExecutionTemplate_DataprocParameters) Descriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate_DataprocParameters.ProtoReflect.Descriptor instead.
func (*ExecutionTemplate_DataprocParameters) GetCluster
func (x *ExecutionTemplate_DataprocParameters) GetCluster() string
func (*ExecutionTemplate_DataprocParameters) ProtoMessage
func (*ExecutionTemplate_DataprocParameters) ProtoMessage()
func (*ExecutionTemplate_DataprocParameters) ProtoReflect
func (x *ExecutionTemplate_DataprocParameters) ProtoReflect() protoreflect.Message
func (*ExecutionTemplate_DataprocParameters) Reset
func (x *ExecutionTemplate_DataprocParameters) Reset()
func (*ExecutionTemplate_DataprocParameters) String
func (x *ExecutionTemplate_DataprocParameters) String() string
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"`
}
ExecutionTemplate_JobType
type ExecutionTemplate_JobType int32
The backend used for this execution.
ExecutionTemplate_JOB_TYPE_UNSPECIFIED, ExecutionTemplate_VERTEX_AI, ExecutionTemplate_DATAPROC
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) Descriptor() protoreflect.EnumDescriptor
func (ExecutionTemplate_JobType) Enum
func (x ExecutionTemplate_JobType) Enum() *ExecutionTemplate_JobType
func (ExecutionTemplate_JobType) EnumDescriptor
func (ExecutionTemplate_JobType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate_JobType.Descriptor instead.
func (ExecutionTemplate_JobType) Number
func (x ExecutionTemplate_JobType) Number() protoreflect.EnumNumber
func (ExecutionTemplate_JobType) String
func (x ExecutionTemplate_JobType) String() string
func (ExecutionTemplate_JobType) Type
func (ExecutionTemplate_JobType) Type() protoreflect.EnumType
ExecutionTemplate_ScaleTier
type ExecutionTemplate_ScaleTier int32
Required. Specifies the machine types, the number of replicas for workers and parameter servers.
ExecutionTemplate_SCALE_TIER_UNSPECIFIED, ExecutionTemplate_BASIC, ExecutionTemplate_STANDARD_1, ExecutionTemplate_PREMIUM_1, ExecutionTemplate_BASIC_GPU, ExecutionTemplate_BASIC_TPU, ExecutionTemplate_CUSTOM
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) Descriptor() protoreflect.EnumDescriptor
func (ExecutionTemplate_ScaleTier) Enum
func (x ExecutionTemplate_ScaleTier) Enum() *ExecutionTemplate_ScaleTier
func (ExecutionTemplate_ScaleTier) EnumDescriptor
func (ExecutionTemplate_ScaleTier) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate_ScaleTier.Descriptor instead.
func (ExecutionTemplate_ScaleTier) Number
func (x ExecutionTemplate_ScaleTier) Number() protoreflect.EnumNumber
func (ExecutionTemplate_ScaleTier) String
func (x ExecutionTemplate_ScaleTier) String() string
func (ExecutionTemplate_ScaleTier) Type
func (ExecutionTemplate_ScaleTier) Type() protoreflect.EnumType
ExecutionTemplate_SchedulerAcceleratorConfig
type ExecutionTemplate_SchedulerAcceleratorConfig struct {
Type ExecutionTemplate_SchedulerAcceleratorType "" /* 136 byte string literal not displayed */
CoreCount int64 `protobuf:"varint,2,opt,name=core_count,json=coreCount,proto3" json:"core_count,omitempty"`
}
Definition of a hardware accelerator. Note that not all combinations
of type
and core_count
are valid. Check GPUs on
Compute Engine to find a valid
combination. TPUs are not supported.
func (*ExecutionTemplate_SchedulerAcceleratorConfig) Descriptor
func (*ExecutionTemplate_SchedulerAcceleratorConfig) Descriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate_SchedulerAcceleratorConfig.ProtoReflect.Descriptor instead.
func (*ExecutionTemplate_SchedulerAcceleratorConfig) GetCoreCount
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) GetCoreCount() int64
func (*ExecutionTemplate_SchedulerAcceleratorConfig) GetType
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) GetType() ExecutionTemplate_SchedulerAcceleratorType
func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoMessage
func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoMessage()
func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoReflect
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) ProtoReflect() protoreflect.Message
func (*ExecutionTemplate_SchedulerAcceleratorConfig) Reset
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) Reset()
func (*ExecutionTemplate_SchedulerAcceleratorConfig) String
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) String() string
ExecutionTemplate_SchedulerAcceleratorType
type ExecutionTemplate_SchedulerAcceleratorType int32
Hardware accelerator types for AI Platform Training jobs.
ExecutionTemplate_SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED, ExecutionTemplate_NVIDIA_TESLA_K80, ExecutionTemplate_NVIDIA_TESLA_P100, ExecutionTemplate_NVIDIA_TESLA_V100, ExecutionTemplate_NVIDIA_TESLA_P4, ExecutionTemplate_NVIDIA_TESLA_T4, ExecutionTemplate_NVIDIA_TESLA_A100, ExecutionTemplate_TPU_V2, ExecutionTemplate_TPU_V3
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) Descriptor() protoreflect.EnumDescriptor
func (ExecutionTemplate_SchedulerAcceleratorType) Enum
func (x ExecutionTemplate_SchedulerAcceleratorType) Enum() *ExecutionTemplate_SchedulerAcceleratorType
func (ExecutionTemplate_SchedulerAcceleratorType) EnumDescriptor
func (ExecutionTemplate_SchedulerAcceleratorType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate_SchedulerAcceleratorType.Descriptor instead.
func (ExecutionTemplate_SchedulerAcceleratorType) Number
func (x ExecutionTemplate_SchedulerAcceleratorType) Number() protoreflect.EnumNumber
func (ExecutionTemplate_SchedulerAcceleratorType) String
func (x ExecutionTemplate_SchedulerAcceleratorType) String() string
func (ExecutionTemplate_SchedulerAcceleratorType) Type
func (ExecutionTemplate_SchedulerAcceleratorType) Type() protoreflect.EnumType
ExecutionTemplate_VertexAIParameters
type ExecutionTemplate_VertexAIParameters struct {
Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
Env map[string]string "" /* 147 byte string literal not displayed */
}
Parameters used in Vertex AI JobType executions.
func (*ExecutionTemplate_VertexAIParameters) Descriptor
func (*ExecutionTemplate_VertexAIParameters) Descriptor() ([]byte, []int)
Deprecated: Use ExecutionTemplate_VertexAIParameters.ProtoReflect.Descriptor instead.
func (*ExecutionTemplate_VertexAIParameters) GetEnv
func (x *ExecutionTemplate_VertexAIParameters) GetEnv() map[string]string
func (*ExecutionTemplate_VertexAIParameters) GetNetwork
func (x *ExecutionTemplate_VertexAIParameters) GetNetwork() string
func (*ExecutionTemplate_VertexAIParameters) ProtoMessage
func (*ExecutionTemplate_VertexAIParameters) ProtoMessage()
func (*ExecutionTemplate_VertexAIParameters) ProtoReflect
func (x *ExecutionTemplate_VertexAIParameters) ProtoReflect() protoreflect.Message
func (*ExecutionTemplate_VertexAIParameters) Reset
func (x *ExecutionTemplate_VertexAIParameters) Reset()
func (*ExecutionTemplate_VertexAIParameters) String
func (x *ExecutionTemplate_VertexAIParameters) String() string
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"`
}
Execution_State
type Execution_State int32
Enum description of the state of the underlying AIP job.
Execution_STATE_UNSPECIFIED, Execution_QUEUED, Execution_PREPARING, Execution_RUNNING, Execution_SUCCEEDED, Execution_FAILED, Execution_CANCELLING, Execution_CANCELLED, Execution_EXPIRED, Execution_INITIALIZING
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) Descriptor() protoreflect.EnumDescriptor
func (Execution_State) Enum
func (x Execution_State) Enum() *Execution_State
func (Execution_State) EnumDescriptor
func (Execution_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Execution_State.Descriptor instead.
func (Execution_State) Number
func (x Execution_State) Number() protoreflect.EnumNumber
func (Execution_State) String
func (x Execution_State) String() string
func (Execution_State) Type
func (Execution_State) Type() protoreflect.EnumType
GetEnvironmentRequest
type GetEnvironmentRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/environments/{environment_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for getting a notebook environment.
func (*GetEnvironmentRequest) Descriptor
func (*GetEnvironmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetEnvironmentRequest.ProtoReflect.Descriptor instead.
func (*GetEnvironmentRequest) GetName
func (x *GetEnvironmentRequest) GetName() string
func (*GetEnvironmentRequest) ProtoMessage
func (*GetEnvironmentRequest) ProtoMessage()
func (*GetEnvironmentRequest) ProtoReflect
func (x *GetEnvironmentRequest) ProtoReflect() protoreflect.Message
func (*GetEnvironmentRequest) Reset
func (x *GetEnvironmentRequest) Reset()
func (*GetEnvironmentRequest) String
func (x *GetEnvironmentRequest) String() string
GetExecutionRequest
type GetExecutionRequest 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 getting scheduled notebook execution
func (*GetExecutionRequest) Descriptor
func (*GetExecutionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetExecutionRequest.ProtoReflect.Descriptor instead.
func (*GetExecutionRequest) GetName
func (x *GetExecutionRequest) GetName() string
func (*GetExecutionRequest) ProtoMessage
func (*GetExecutionRequest) ProtoMessage()
func (*GetExecutionRequest) ProtoReflect
func (x *GetExecutionRequest) ProtoReflect() protoreflect.Message
func (*GetExecutionRequest) Reset
func (x *GetExecutionRequest) Reset()
func (*GetExecutionRequest) String
func (x *GetExecutionRequest) String() string
GetInstanceHealthRequest
type GetInstanceHealthRequest 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 checking if a notebook instance is healthy.
func (*GetInstanceHealthRequest) Descriptor
func (*GetInstanceHealthRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetInstanceHealthRequest.ProtoReflect.Descriptor instead.
func (*GetInstanceHealthRequest) GetName
func (x *GetInstanceHealthRequest) GetName() string
func (*GetInstanceHealthRequest) ProtoMessage
func (*GetInstanceHealthRequest) ProtoMessage()
func (*GetInstanceHealthRequest) ProtoReflect
func (x *GetInstanceHealthRequest) ProtoReflect() protoreflect.Message
func (*GetInstanceHealthRequest) Reset
func (x *GetInstanceHealthRequest) Reset()
func (*GetInstanceHealthRequest) String
func (x *GetInstanceHealthRequest) String() string
GetInstanceHealthResponse
type GetInstanceHealthResponse struct {
HealthState GetInstanceHealthResponse_HealthState "" /* 164 byte string literal not displayed */
HealthInfo map[string]string "" /* 179 byte string literal not displayed */
}
Response for checking if a notebook instance is healthy.
func (*GetInstanceHealthResponse) Descriptor
func (*GetInstanceHealthResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetInstanceHealthResponse.ProtoReflect.Descriptor instead.
func (*GetInstanceHealthResponse) GetHealthInfo
func (x *GetInstanceHealthResponse) GetHealthInfo() map[string]string
func (*GetInstanceHealthResponse) GetHealthState
func (x *GetInstanceHealthResponse) GetHealthState() GetInstanceHealthResponse_HealthState
func (*GetInstanceHealthResponse) ProtoMessage
func (*GetInstanceHealthResponse) ProtoMessage()
func (*GetInstanceHealthResponse) ProtoReflect
func (x *GetInstanceHealthResponse) ProtoReflect() protoreflect.Message
func (*GetInstanceHealthResponse) Reset
func (x *GetInstanceHealthResponse) Reset()
func (*GetInstanceHealthResponse) String
func (x *GetInstanceHealthResponse) String() string
GetInstanceHealthResponse_HealthState
type GetInstanceHealthResponse_HealthState int32
If an instance is healthy or not.
GetInstanceHealthResponse_HEALTH_STATE_UNSPECIFIED, GetInstanceHealthResponse_HEALTHY, GetInstanceHealthResponse_UNHEALTHY, GetInstanceHealthResponse_AGENT_NOT_INSTALLED, GetInstanceHealthResponse_AGENT_NOT_RUNNING
const (
// The instance substate is unknown.
GetInstanceHealthResponse_HEALTH_STATE_UNSPECIFIED GetInstanceHealthResponse_HealthState = 0
// The instance is known to be in an healthy state
// (for example, critical daemons are running)
// Applies to ACTIVE state.
GetInstanceHealthResponse_HEALTHY GetInstanceHealthResponse_HealthState = 1
// The instance is known to be in an unhealthy state
// (for example, critical daemons are not running)
// Applies to ACTIVE state.
GetInstanceHealthResponse_UNHEALTHY GetInstanceHealthResponse_HealthState = 2
// The instance has not installed health monitoring agent.
// Applies to ACTIVE state.
GetInstanceHealthResponse_AGENT_NOT_INSTALLED GetInstanceHealthResponse_HealthState = 3
// The instance health monitoring agent is not running.
// Applies to ACTIVE state.
GetInstanceHealthResponse_AGENT_NOT_RUNNING GetInstanceHealthResponse_HealthState = 4
)
func (GetInstanceHealthResponse_HealthState) Descriptor
func (GetInstanceHealthResponse_HealthState) Descriptor() protoreflect.EnumDescriptor
func (GetInstanceHealthResponse_HealthState) Enum
func (GetInstanceHealthResponse_HealthState) EnumDescriptor
func (GetInstanceHealthResponse_HealthState) EnumDescriptor() ([]byte, []int)
Deprecated: Use GetInstanceHealthResponse_HealthState.Descriptor instead.
func (GetInstanceHealthResponse_HealthState) Number
func (x GetInstanceHealthResponse_HealthState) Number() protoreflect.EnumNumber
func (GetInstanceHealthResponse_HealthState) String
func (x GetInstanceHealthResponse_HealthState) String() string
func (GetInstanceHealthResponse_HealthState) Type
func (GetInstanceHealthResponse_HealthState) Type() protoreflect.EnumType
GetInstanceRequest
type GetInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for getting a notebook instance.
func (*GetInstanceRequest) Descriptor
func (*GetInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.
func (*GetInstanceRequest) GetName
func (x *GetInstanceRequest) GetName() string
func (*GetInstanceRequest) ProtoMessage
func (*GetInstanceRequest) ProtoMessage()
func (*GetInstanceRequest) ProtoReflect
func (x *GetInstanceRequest) ProtoReflect() protoreflect.Message
func (*GetInstanceRequest) Reset
func (x *GetInstanceRequest) Reset()
func (*GetInstanceRequest) String
func (x *GetInstanceRequest) String() string
GetRuntimeRequest
type GetRuntimeRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for getting a Managed Notebook Runtime.
func (*GetRuntimeRequest) Descriptor
func (*GetRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRuntimeRequest.ProtoReflect.Descriptor instead.
func (*GetRuntimeRequest) GetName
func (x *GetRuntimeRequest) GetName() string
func (*GetRuntimeRequest) ProtoMessage
func (*GetRuntimeRequest) ProtoMessage()
func (*GetRuntimeRequest) ProtoReflect
func (x *GetRuntimeRequest) ProtoReflect() protoreflect.Message
func (*GetRuntimeRequest) Reset
func (x *GetRuntimeRequest) Reset()
func (*GetRuntimeRequest) String
func (x *GetRuntimeRequest) String() string
GetScheduleRequest
type GetScheduleRequest 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 getting scheduled notebook.
func (*GetScheduleRequest) Descriptor
func (*GetScheduleRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetScheduleRequest.ProtoReflect.Descriptor instead.
func (*GetScheduleRequest) GetName
func (x *GetScheduleRequest) GetName() string
func (*GetScheduleRequest) ProtoMessage
func (*GetScheduleRequest) ProtoMessage()
func (*GetScheduleRequest) ProtoReflect
func (x *GetScheduleRequest) ProtoReflect() protoreflect.Message
func (*GetScheduleRequest) Reset
func (x *GetScheduleRequest) Reset()
func (*GetScheduleRequest) String
func (x *GetScheduleRequest) String() string
Instance
type Instance struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Environment isInstance_Environment `protobuf_oneof:"environment"`
PostStartupScript string `protobuf:"bytes,4,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
ProxyUri string `protobuf:"bytes,5,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
InstanceOwners []string `protobuf:"bytes,6,rep,name=instance_owners,json=instanceOwners,proto3" json:"instance_owners,omitempty"`
ServiceAccount string `protobuf:"bytes,7,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
ServiceAccountScopes []string `protobuf:"bytes,31,rep,name=service_account_scopes,json=serviceAccountScopes,proto3" json:"service_account_scopes,omitempty"`
MachineType string `protobuf:"bytes,8,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
AcceleratorConfig *Instance_AcceleratorConfig `protobuf:"bytes,9,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
State Instance_State `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.notebooks.v1.Instance_State" json:"state,omitempty"`
InstallGpuDriver bool `protobuf:"varint,11,opt,name=install_gpu_driver,json=installGpuDriver,proto3" json:"install_gpu_driver,omitempty"`
CustomGpuDriverPath string `protobuf:"bytes,12,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
BootDiskType Instance_DiskType "" /* 150 byte string literal not displayed */
BootDiskSizeGb int64 `protobuf:"varint,14,opt,name=boot_disk_size_gb,json=bootDiskSizeGb,proto3" json:"boot_disk_size_gb,omitempty"`
DataDiskType Instance_DiskType "" /* 150 byte string literal not displayed */
DataDiskSizeGb int64 `protobuf:"varint,26,opt,name=data_disk_size_gb,json=dataDiskSizeGb,proto3" json:"data_disk_size_gb,omitempty"`
NoRemoveDataDisk bool `protobuf:"varint,27,opt,name=no_remove_data_disk,json=noRemoveDataDisk,proto3" json:"no_remove_data_disk,omitempty"`
DiskEncryption Instance_DiskEncryption "" /* 160 byte string literal not displayed */
KmsKey string `protobuf:"bytes,16,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
Disks []*Instance_Disk `protobuf:"bytes,28,rep,name=disks,proto3" json:"disks,omitempty"`
ShieldedInstanceConfig *Instance_ShieldedInstanceConfig "" /* 130 byte string literal not displayed */
NoPublicIp bool `protobuf:"varint,17,opt,name=no_public_ip,json=noPublicIp,proto3" json:"no_public_ip,omitempty"`
NoProxyAccess bool `protobuf:"varint,18,opt,name=no_proxy_access,json=noProxyAccess,proto3" json:"no_proxy_access,omitempty"`
Network string `protobuf:"bytes,19,opt,name=network,proto3" json:"network,omitempty"`
Subnet string `protobuf:"bytes,20,opt,name=subnet,proto3" json:"subnet,omitempty"`
Labels map[string]string "" /* 154 byte string literal not displayed */
Metadata map[string]string "" /* 158 byte string literal not displayed */
Tags []string `protobuf:"bytes,32,rep,name=tags,proto3" json:"tags,omitempty"`
UpgradeHistory []*Instance_UpgradeHistoryEntry `protobuf:"bytes,29,rep,name=upgrade_history,json=upgradeHistory,proto3" json:"upgrade_history,omitempty"`
NicType Instance_NicType "" /* 132 byte string literal not displayed */
ReservationAffinity *ReservationAffinity `protobuf:"bytes,34,opt,name=reservation_affinity,json=reservationAffinity,proto3" json:"reservation_affinity,omitempty"`
Creator string `protobuf:"bytes,36,opt,name=creator,proto3" json:"creator,omitempty"`
CanIpForward bool `protobuf:"varint,39,opt,name=can_ip_forward,json=canIpForward,proto3" json:"can_ip_forward,omitempty"`
CreateTime *timestamp.Timestamp `protobuf:"bytes,23,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamp.Timestamp `protobuf:"bytes,24,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
}
The definition of a notebook instance.
func (*Instance) Descriptor
Deprecated: Use Instance.ProtoReflect.Descriptor instead.
func (*Instance) GetAcceleratorConfig
func (x *Instance) GetAcceleratorConfig() *Instance_AcceleratorConfig
func (*Instance) GetBootDiskSizeGb
func (*Instance) GetBootDiskType
func (x *Instance) GetBootDiskType() Instance_DiskType
func (*Instance) GetCanIpForward
func (*Instance) GetContainerImage
func (x *Instance) GetContainerImage() *ContainerImage
func (*Instance) GetCreateTime
func (*Instance) GetCreator
func (*Instance) GetCustomGpuDriverPath
func (*Instance) GetDataDiskSizeGb
func (*Instance) GetDataDiskType
func (x *Instance) GetDataDiskType() Instance_DiskType
func (*Instance) GetDiskEncryption
func (x *Instance) GetDiskEncryption() Instance_DiskEncryption
func (*Instance) GetDisks
func (x *Instance) GetDisks() []*Instance_Disk
func (*Instance) GetEnvironment
func (m *Instance) GetEnvironment() isInstance_Environment
func (*Instance) GetInstallGpuDriver
func (*Instance) GetInstanceOwners
func (*Instance) GetKmsKey
func (*Instance) GetLabels
func (*Instance) GetMachineType
func (*Instance) GetMetadata
func (*Instance) GetName
func (*Instance) GetNetwork
func (*Instance) GetNicType
func (x *Instance) GetNicType() Instance_NicType
func (*Instance) GetNoProxyAccess
func (*Instance) GetNoPublicIp
func (*Instance) GetNoRemoveDataDisk
func (*Instance) GetPostStartupScript
func (*Instance) GetProxyUri
func (*Instance) GetReservationAffinity
func (x *Instance) GetReservationAffinity() *ReservationAffinity
func (*Instance) GetServiceAccount
func (*Instance) GetServiceAccountScopes
func (*Instance) GetShieldedInstanceConfig
func (x *Instance) GetShieldedInstanceConfig() *Instance_ShieldedInstanceConfig
func (*Instance) GetState
func (x *Instance) GetState() Instance_State
func (*Instance) GetSubnet
func (*Instance) GetTags
func (*Instance) GetUpdateTime
func (*Instance) GetUpgradeHistory
func (x *Instance) GetUpgradeHistory() []*Instance_UpgradeHistoryEntry
func (*Instance) GetVmImage
func (*Instance) ProtoMessage
func (*Instance) ProtoMessage()
func (*Instance) ProtoReflect
func (x *Instance) ProtoReflect() protoreflect.Message
func (*Instance) Reset
func (x *Instance) Reset()
func (*Instance) String
InstanceConfig
type InstanceConfig struct {
NotebookUpgradeSchedule string "" /* 132 byte string literal not displayed */
EnableHealthMonitoring bool "" /* 130 byte string literal not displayed */
}
Notebook instance configurations that can be updated.
func (*InstanceConfig) Descriptor
func (*InstanceConfig) Descriptor() ([]byte, []int)
Deprecated: Use InstanceConfig.ProtoReflect.Descriptor instead.
func (*InstanceConfig) GetEnableHealthMonitoring
func (x *InstanceConfig) GetEnableHealthMonitoring() bool
func (*InstanceConfig) GetNotebookUpgradeSchedule
func (x *InstanceConfig) GetNotebookUpgradeSchedule() string
func (*InstanceConfig) ProtoMessage
func (*InstanceConfig) ProtoMessage()
func (*InstanceConfig) ProtoReflect
func (x *InstanceConfig) ProtoReflect() protoreflect.Message
func (*InstanceConfig) Reset
func (x *InstanceConfig) Reset()
func (*InstanceConfig) String
func (x *InstanceConfig) String() string
Instance_AcceleratorConfig
type Instance_AcceleratorConfig struct {
// Type of this accelerator.
Type Instance_AcceleratorType `protobuf:"varint,1,opt,name=type,proto3,enum=google.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. Check GPUs on
Compute Engine to find a valid
combination. TPUs are not supported.
func (*Instance_AcceleratorConfig) Descriptor
func (*Instance_AcceleratorConfig) Descriptor() ([]byte, []int)
Deprecated: Use Instance_AcceleratorConfig.ProtoReflect.Descriptor instead.
func (*Instance_AcceleratorConfig) GetCoreCount
func (x *Instance_AcceleratorConfig) GetCoreCount() int64
func (*Instance_AcceleratorConfig) GetType
func (x *Instance_AcceleratorConfig) GetType() Instance_AcceleratorType
func (*Instance_AcceleratorConfig) ProtoMessage
func (*Instance_AcceleratorConfig) ProtoMessage()
func (*Instance_AcceleratorConfig) ProtoReflect
func (x *Instance_AcceleratorConfig) ProtoReflect() protoreflect.Message
func (*Instance_AcceleratorConfig) Reset
func (x *Instance_AcceleratorConfig) Reset()
func (*Instance_AcceleratorConfig) String
func (x *Instance_AcceleratorConfig) String() string
Instance_AcceleratorType
type Instance_AcceleratorType int32
Definition of the types of hardware accelerators that can be used on this instance.
Instance_ACCELERATOR_TYPE_UNSPECIFIED, Instance_NVIDIA_TESLA_K80, Instance_NVIDIA_TESLA_P100, Instance_NVIDIA_TESLA_V100, Instance_NVIDIA_TESLA_P4, Instance_NVIDIA_TESLA_T4, Instance_NVIDIA_TESLA_A100, Instance_NVIDIA_TESLA_T4_VWS, Instance_NVIDIA_TESLA_P100_VWS, Instance_NVIDIA_TESLA_P4_VWS, Instance_TPU_V2, Instance_TPU_V3
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_AcceleratorType) Enum
func (x Instance_AcceleratorType) Enum() *Instance_AcceleratorType
func (Instance_AcceleratorType) EnumDescriptor
func (Instance_AcceleratorType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_AcceleratorType.Descriptor instead.
func (Instance_AcceleratorType) Number
func (x Instance_AcceleratorType) Number() protoreflect.EnumNumber
func (Instance_AcceleratorType) String
func (x Instance_AcceleratorType) String() string
func (Instance_AcceleratorType) Type
func (Instance_AcceleratorType) Type() protoreflect.EnumType
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"`
}
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) Descriptor
func (*Instance_Disk) Descriptor() ([]byte, []int)
Deprecated: Use Instance_Disk.ProtoReflect.Descriptor instead.
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) String
func (x *Instance_Disk) String() string
Instance_DiskEncryption
type Instance_DiskEncryption int32
Definition of the disk encryption options.
Instance_DISK_ENCRYPTION_UNSPECIFIED, Instance_GMEK, Instance_CMEK
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_DiskEncryption) Enum
func (x Instance_DiskEncryption) Enum() *Instance_DiskEncryption
func (Instance_DiskEncryption) EnumDescriptor
func (Instance_DiskEncryption) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_DiskEncryption.Descriptor instead.
func (Instance_DiskEncryption) Number
func (x Instance_DiskEncryption) Number() protoreflect.EnumNumber
func (Instance_DiskEncryption) String
func (x Instance_DiskEncryption) String() string
func (Instance_DiskEncryption) Type
func (Instance_DiskEncryption) Type() protoreflect.EnumType
Instance_DiskType
type Instance_DiskType int32
Possible disk types for notebook instances.
Instance_DISK_TYPE_UNSPECIFIED, Instance_PD_STANDARD, Instance_PD_SSD, Instance_PD_BALANCED, Instance_PD_EXTREME
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_DiskType) Enum
func (x Instance_DiskType) Enum() *Instance_DiskType
func (Instance_DiskType) EnumDescriptor
func (Instance_DiskType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_DiskType.Descriptor instead.
func (Instance_DiskType) Number
func (x Instance_DiskType) Number() protoreflect.EnumNumber
func (Instance_DiskType) String
func (x Instance_DiskType) String() string
func (Instance_DiskType) Type
func (Instance_DiskType) Type() protoreflect.EnumType
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) Descriptor
func (*Instance_Disk_GuestOsFeature) Descriptor() ([]byte, []int)
Deprecated: Use Instance_Disk_GuestOsFeature.ProtoReflect.Descriptor instead.
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 (x *Instance_Disk_GuestOsFeature) ProtoReflect() protoreflect.Message
func (*Instance_Disk_GuestOsFeature) Reset
func (x *Instance_Disk_GuestOsFeature) Reset()
func (*Instance_Disk_GuestOsFeature) String
func (x *Instance_Disk_GuestOsFeature) String() string
Instance_NicType
type Instance_NicType int32
The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
Instance_UNSPECIFIED_NIC_TYPE, Instance_VIRTIO_NET, Instance_GVNIC
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_NicType) Enum
func (x Instance_NicType) Enum() *Instance_NicType
func (Instance_NicType) EnumDescriptor
func (Instance_NicType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_NicType.Descriptor instead.
func (Instance_NicType) Number
func (x Instance_NicType) Number() protoreflect.EnumNumber
func (Instance_NicType) String
func (x Instance_NicType) String() string
func (Instance_NicType) Type
func (Instance_NicType) Type() protoreflect.EnumType
Instance_ShieldedInstanceConfig
type Instance_ShieldedInstanceConfig struct {
EnableSecureBoot bool `protobuf:"varint,1,opt,name=enable_secure_boot,json=enableSecureBoot,proto3" json:"enable_secure_boot,omitempty"`
EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
EnableIntegrityMonitoring bool "" /* 139 byte string literal not displayed */
}
A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid.
func (*Instance_ShieldedInstanceConfig) Descriptor
func (*Instance_ShieldedInstanceConfig) Descriptor() ([]byte, []int)
Deprecated: Use Instance_ShieldedInstanceConfig.ProtoReflect.Descriptor instead.
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 (x *Instance_ShieldedInstanceConfig) ProtoReflect() protoreflect.Message
func (*Instance_ShieldedInstanceConfig) Reset
func (x *Instance_ShieldedInstanceConfig) Reset()
func (*Instance_ShieldedInstanceConfig) String
func (x *Instance_ShieldedInstanceConfig) String() string
Instance_State
type Instance_State int32
The definition of the states of this instance.
Instance_STATE_UNSPECIFIED, Instance_STARTING, Instance_PROVISIONING, Instance_ACTIVE, Instance_STOPPING, Instance_STOPPED, Instance_DELETED, Instance_UPGRADING, Instance_INITIALIZING, Instance_REGISTERING, Instance_SUSPENDING, Instance_SUSPENDED
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_State) Enum
func (x Instance_State) Enum() *Instance_State
func (Instance_State) EnumDescriptor
func (Instance_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_State.Descriptor instead.
func (Instance_State) Number
func (x Instance_State) Number() protoreflect.EnumNumber
func (Instance_State) String
func (x Instance_State) String() string
func (Instance_State) Type
func (Instance_State) Type() protoreflect.EnumType
Instance_UpgradeHistoryEntry
type Instance_UpgradeHistoryEntry struct {
Snapshot string `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
VmImage string `protobuf:"bytes,2,opt,name=vm_image,json=vmImage,proto3" json:"vm_image,omitempty"`
ContainerImage string `protobuf:"bytes,3,opt,name=container_image,json=containerImage,proto3" json:"container_image,omitempty"`
Framework string `protobuf:"bytes,4,opt,name=framework,proto3" json:"framework,omitempty"`
Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
State Instance_UpgradeHistoryEntry_State "" /* 130 byte string literal not displayed */
CreateTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
TargetImage string `protobuf:"bytes,8,opt,name=target_image,json=targetImage,proto3" json:"target_image,omitempty"`
Action Instance_UpgradeHistoryEntry_Action "" /* 133 byte string literal not displayed */
TargetVersion string `protobuf:"bytes,10,opt,name=target_version,json=targetVersion,proto3" json:"target_version,omitempty"`
}
The entry of VM image upgrade history.
func (*Instance_UpgradeHistoryEntry) Descriptor
func (*Instance_UpgradeHistoryEntry) Descriptor() ([]byte, []int)
Deprecated: Use Instance_UpgradeHistoryEntry.ProtoReflect.Descriptor instead.
func (*Instance_UpgradeHistoryEntry) GetAction
func (x *Instance_UpgradeHistoryEntry) GetAction() Instance_UpgradeHistoryEntry_Action
func (*Instance_UpgradeHistoryEntry) GetContainerImage
func (x *Instance_UpgradeHistoryEntry) GetContainerImage() string
func (*Instance_UpgradeHistoryEntry) GetCreateTime
func (x *Instance_UpgradeHistoryEntry) GetCreateTime() *timestamp.Timestamp
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 (x *Instance_UpgradeHistoryEntry) GetState() Instance_UpgradeHistoryEntry_State
func (*Instance_UpgradeHistoryEntry) GetTargetImage
func (x *Instance_UpgradeHistoryEntry) GetTargetImage() string
Deprecated: Do not use.
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) ProtoMessage
func (*Instance_UpgradeHistoryEntry) ProtoMessage()
func (*Instance_UpgradeHistoryEntry) ProtoReflect
func (x *Instance_UpgradeHistoryEntry) ProtoReflect() protoreflect.Message
func (*Instance_UpgradeHistoryEntry) Reset
func (x *Instance_UpgradeHistoryEntry) Reset()
func (*Instance_UpgradeHistoryEntry) String
func (x *Instance_UpgradeHistoryEntry) String() string
Instance_UpgradeHistoryEntry_Action
type Instance_UpgradeHistoryEntry_Action int32
The definition of operations of this upgrade history entry.
Instance_UpgradeHistoryEntry_ACTION_UNSPECIFIED, Instance_UpgradeHistoryEntry_UPGRADE, Instance_UpgradeHistoryEntry_ROLLBACK
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_UpgradeHistoryEntry_Action) Enum
func (x Instance_UpgradeHistoryEntry_Action) Enum() *Instance_UpgradeHistoryEntry_Action
func (Instance_UpgradeHistoryEntry_Action) EnumDescriptor
func (Instance_UpgradeHistoryEntry_Action) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_UpgradeHistoryEntry_Action.Descriptor instead.
func (Instance_UpgradeHistoryEntry_Action) Number
func (x Instance_UpgradeHistoryEntry_Action) Number() protoreflect.EnumNumber
func (Instance_UpgradeHistoryEntry_Action) String
func (x Instance_UpgradeHistoryEntry_Action) String() string
func (Instance_UpgradeHistoryEntry_Action) Type
func (Instance_UpgradeHistoryEntry_Action) Type() protoreflect.EnumType
Instance_UpgradeHistoryEntry_State
type Instance_UpgradeHistoryEntry_State int32
The definition of the states of this upgrade history entry.
Instance_UpgradeHistoryEntry_STATE_UNSPECIFIED, Instance_UpgradeHistoryEntry_STARTED, Instance_UpgradeHistoryEntry_SUCCEEDED, Instance_UpgradeHistoryEntry_FAILED
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) Descriptor() protoreflect.EnumDescriptor
func (Instance_UpgradeHistoryEntry_State) Enum
func (x Instance_UpgradeHistoryEntry_State) Enum() *Instance_UpgradeHistoryEntry_State
func (Instance_UpgradeHistoryEntry_State) EnumDescriptor
func (Instance_UpgradeHistoryEntry_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_UpgradeHistoryEntry_State.Descriptor instead.
func (Instance_UpgradeHistoryEntry_State) Number
func (x Instance_UpgradeHistoryEntry_State) Number() protoreflect.EnumNumber
func (Instance_UpgradeHistoryEntry_State) String
func (x Instance_UpgradeHistoryEntry_State) String() string
func (Instance_UpgradeHistoryEntry_State) Type
func (Instance_UpgradeHistoryEntry_State) Type() protoreflect.EnumType
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"`
}
IsInstanceUpgradeableRequest
type IsInstanceUpgradeableRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
NotebookInstance string `protobuf:"bytes,1,opt,name=notebook_instance,json=notebookInstance,proto3" json:"notebook_instance,omitempty"`
// Optional. The optional UpgradeType. Setting this field will search for additional
// compute images to upgrade this instance.
Type UpgradeType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1.UpgradeType" json:"type,omitempty"`
// contains filtered or unexported fields
}
Request for checking if a notebook instance is upgradeable.
func (*IsInstanceUpgradeableRequest) Descriptor
func (*IsInstanceUpgradeableRequest) Descriptor() ([]byte, []int)
Deprecated: Use IsInstanceUpgradeableRequest.ProtoReflect.Descriptor instead.
func (*IsInstanceUpgradeableRequest) GetNotebookInstance
func (x *IsInstanceUpgradeableRequest) GetNotebookInstance() string
func (*IsInstanceUpgradeableRequest) GetType
func (x *IsInstanceUpgradeableRequest) GetType() UpgradeType
func (*IsInstanceUpgradeableRequest) ProtoMessage
func (*IsInstanceUpgradeableRequest) ProtoMessage()
func (*IsInstanceUpgradeableRequest) ProtoReflect
func (x *IsInstanceUpgradeableRequest) ProtoReflect() protoreflect.Message
func (*IsInstanceUpgradeableRequest) Reset
func (x *IsInstanceUpgradeableRequest) Reset()
func (*IsInstanceUpgradeableRequest) String
func (x *IsInstanceUpgradeableRequest) String() string
IsInstanceUpgradeableResponse
type IsInstanceUpgradeableResponse struct {
// If an instance is upgradeable.
Upgradeable bool `protobuf:"varint,1,opt,name=upgradeable,proto3" json:"upgradeable,omitempty"`
// The version this instance will be upgraded to if calling the upgrade
// endpoint. This field will only be populated if field upgradeable is true.
UpgradeVersion string `protobuf:"bytes,2,opt,name=upgrade_version,json=upgradeVersion,proto3" json:"upgrade_version,omitempty"`
// Additional information about upgrade.
UpgradeInfo string `protobuf:"bytes,3,opt,name=upgrade_info,json=upgradeInfo,proto3" json:"upgrade_info,omitempty"`
// The new image self link this instance will be upgraded to if calling the
// upgrade endpoint. This field will only be populated if field upgradeable
// is true.
UpgradeImage string `protobuf:"bytes,4,opt,name=upgrade_image,json=upgradeImage,proto3" json:"upgrade_image,omitempty"`
// contains filtered or unexported fields
}
Response for checking if a notebook instance is upgradeable.
func (*IsInstanceUpgradeableResponse) Descriptor
func (*IsInstanceUpgradeableResponse) Descriptor() ([]byte, []int)
Deprecated: Use IsInstanceUpgradeableResponse.ProtoReflect.Descriptor instead.
func (*IsInstanceUpgradeableResponse) GetUpgradeImage
func (x *IsInstanceUpgradeableResponse) GetUpgradeImage() string
func (*IsInstanceUpgradeableResponse) GetUpgradeInfo
func (x *IsInstanceUpgradeableResponse) GetUpgradeInfo() string
func (*IsInstanceUpgradeableResponse) GetUpgradeVersion
func (x *IsInstanceUpgradeableResponse) GetUpgradeVersion() string
func (*IsInstanceUpgradeableResponse) GetUpgradeable
func (x *IsInstanceUpgradeableResponse) GetUpgradeable() bool
func (*IsInstanceUpgradeableResponse) ProtoMessage
func (*IsInstanceUpgradeableResponse) ProtoMessage()
func (*IsInstanceUpgradeableResponse) ProtoReflect
func (x *IsInstanceUpgradeableResponse) ProtoReflect() protoreflect.Message
func (*IsInstanceUpgradeableResponse) Reset
func (x *IsInstanceUpgradeableResponse) Reset()
func (*IsInstanceUpgradeableResponse) String
func (x *IsInstanceUpgradeableResponse) String() string
ListEnvironmentsRequest
type ListEnvironmentsRequest struct {
// Required. Format: `projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum return size of the list call.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A previous returned page token that can be used to continue listing from
// the last result.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request for listing environments.
func (*ListEnvironmentsRequest) Descriptor
func (*ListEnvironmentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListEnvironmentsRequest.ProtoReflect.Descriptor instead.
func (*ListEnvironmentsRequest) GetPageSize
func (x *ListEnvironmentsRequest) GetPageSize() int32
func (*ListEnvironmentsRequest) GetPageToken
func (x *ListEnvironmentsRequest) GetPageToken() string
func (*ListEnvironmentsRequest) GetParent
func (x *ListEnvironmentsRequest) GetParent() string
func (*ListEnvironmentsRequest) ProtoMessage
func (*ListEnvironmentsRequest) ProtoMessage()
func (*ListEnvironmentsRequest) ProtoReflect
func (x *ListEnvironmentsRequest) ProtoReflect() protoreflect.Message
func (*ListEnvironmentsRequest) Reset
func (x *ListEnvironmentsRequest) Reset()
func (*ListEnvironmentsRequest) String
func (x *ListEnvironmentsRequest) String() string
ListEnvironmentsResponse
type ListEnvironmentsResponse struct {
// A list of returned environments.
Environments []*Environment `protobuf:"bytes,1,rep,name=environments,proto3" json:"environments,omitempty"`
// A page token that can be used to continue listing from the last result
// in the next list call.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response for listing environments.
func (*ListEnvironmentsResponse) Descriptor
func (*ListEnvironmentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListEnvironmentsResponse.ProtoReflect.Descriptor instead.
func (*ListEnvironmentsResponse) GetEnvironments
func (x *ListEnvironmentsResponse) GetEnvironments() []*Environment
func (*ListEnvironmentsResponse) GetNextPageToken
func (x *ListEnvironmentsResponse) GetNextPageToken() string
func (*ListEnvironmentsResponse) GetUnreachable
func (x *ListEnvironmentsResponse) GetUnreachable() []string
func (*ListEnvironmentsResponse) ProtoMessage
func (*ListEnvironmentsResponse) ProtoMessage()
func (*ListEnvironmentsResponse) ProtoReflect
func (x *ListEnvironmentsResponse) ProtoReflect() protoreflect.Message
func (*ListEnvironmentsResponse) Reset
func (x *ListEnvironmentsResponse) Reset()
func (*ListEnvironmentsResponse) String
func (x *ListEnvironmentsResponse) String() string
ListExecutionsRequest
type ListExecutionsRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum return size of the list call.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A previous returned page token that can be used to continue listing
// from the last result.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Filter applied to resulting executions. Currently only supports filtering
// executions by a specified schedule_id.
// Format: `schedule_id=
Request for listing scheduled notebook executions.
func (*ListExecutionsRequest) Descriptor
func (*ListExecutionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListExecutionsRequest.ProtoReflect.Descriptor instead.
func (*ListExecutionsRequest) GetFilter
func (x *ListExecutionsRequest) GetFilter() string
func (*ListExecutionsRequest) GetOrderBy
func (x *ListExecutionsRequest) GetOrderBy() string
func (*ListExecutionsRequest) GetPageSize
func (x *ListExecutionsRequest) GetPageSize() int32
func (*ListExecutionsRequest) GetPageToken
func (x *ListExecutionsRequest) GetPageToken() string
func (*ListExecutionsRequest) GetParent
func (x *ListExecutionsRequest) GetParent() string
func (*ListExecutionsRequest) ProtoMessage
func (*ListExecutionsRequest) ProtoMessage()
func (*ListExecutionsRequest) ProtoReflect
func (x *ListExecutionsRequest) ProtoReflect() protoreflect.Message
func (*ListExecutionsRequest) Reset
func (x *ListExecutionsRequest) Reset()
func (*ListExecutionsRequest) String
func (x *ListExecutionsRequest) String() string
ListExecutionsResponse
type ListExecutionsResponse struct {
// A list of returned instances.
Executions []*Execution `protobuf:"bytes,1,rep,name=executions,proto3" json:"executions,omitempty"`
// Page token that can be used to continue listing from the last result in the
// next list call.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Executions IDs that could not be reached. For example:
//
// ['projects/{project_id}/location/{location}/executions/imagenet_test1',
// 'projects/{project_id}/location/{location}/executions/classifier_train1']
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response for listing scheduled notebook executions
func (*ListExecutionsResponse) Descriptor
func (*ListExecutionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListExecutionsResponse.ProtoReflect.Descriptor instead.
func (*ListExecutionsResponse) GetExecutions
func (x *ListExecutionsResponse) GetExecutions() []*Execution
func (*ListExecutionsResponse) GetNextPageToken
func (x *ListExecutionsResponse) GetNextPageToken() string
func (*ListExecutionsResponse) GetUnreachable
func (x *ListExecutionsResponse) GetUnreachable() []string
func (*ListExecutionsResponse) ProtoMessage
func (*ListExecutionsResponse) ProtoMessage()
func (*ListExecutionsResponse) ProtoReflect
func (x *ListExecutionsResponse) ProtoReflect() protoreflect.Message
func (*ListExecutionsResponse) Reset
func (x *ListExecutionsResponse) Reset()
func (*ListExecutionsResponse) String
func (x *ListExecutionsResponse) String() string
ListInstancesRequest
type ListInstancesRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum return size of the list call.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A previous returned page token that can be used to continue listing
// from the last result.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request for listing notebook instances.
func (*ListInstancesRequest) Descriptor
func (*ListInstancesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.
func (*ListInstancesRequest) GetPageSize
func (x *ListInstancesRequest) GetPageSize() int32
func (*ListInstancesRequest) GetPageToken
func (x *ListInstancesRequest) GetPageToken() string
func (*ListInstancesRequest) GetParent
func (x *ListInstancesRequest) GetParent() string
func (*ListInstancesRequest) ProtoMessage
func (*ListInstancesRequest) ProtoMessage()
func (*ListInstancesRequest) ProtoReflect
func (x *ListInstancesRequest) ProtoReflect() protoreflect.Message
func (*ListInstancesRequest) Reset
func (x *ListInstancesRequest) Reset()
func (*ListInstancesRequest) String
func (x *ListInstancesRequest) String() string
ListInstancesResponse
type ListInstancesResponse struct {
// A list of returned instances.
Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
// Page token that can be used to continue listing from the last result in the
// next list call.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached. For example,
// ['us-west1-a', 'us-central1-b'].
// A ListInstancesResponse will only contain either instances or unreachables,
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response for listing notebook instances.
func (*ListInstancesResponse) Descriptor
func (*ListInstancesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.
func (*ListInstancesResponse) GetInstances
func (x *ListInstancesResponse) GetInstances() []*Instance
func (*ListInstancesResponse) GetNextPageToken
func (x *ListInstancesResponse) GetNextPageToken() string
func (*ListInstancesResponse) GetUnreachable
func (x *ListInstancesResponse) GetUnreachable() []string
func (*ListInstancesResponse) ProtoMessage
func (*ListInstancesResponse) ProtoMessage()
func (*ListInstancesResponse) ProtoReflect
func (x *ListInstancesResponse) ProtoReflect() protoreflect.Message
func (*ListInstancesResponse) Reset
func (x *ListInstancesResponse) Reset()
func (*ListInstancesResponse) String
func (x *ListInstancesResponse) String() string
ListRuntimesRequest
type ListRuntimesRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum return size of the list call.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A previous returned page token that can be used to continue listing
// from the last result.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
Request for listing Managed Notebook Runtimes.
func (*ListRuntimesRequest) Descriptor
func (*ListRuntimesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimesRequest.ProtoReflect.Descriptor instead.
func (*ListRuntimesRequest) GetPageSize
func (x *ListRuntimesRequest) GetPageSize() int32
func (*ListRuntimesRequest) GetPageToken
func (x *ListRuntimesRequest) GetPageToken() string
func (*ListRuntimesRequest) GetParent
func (x *ListRuntimesRequest) GetParent() string
func (*ListRuntimesRequest) ProtoMessage
func (*ListRuntimesRequest) ProtoMessage()
func (*ListRuntimesRequest) ProtoReflect
func (x *ListRuntimesRequest) ProtoReflect() protoreflect.Message
func (*ListRuntimesRequest) Reset
func (x *ListRuntimesRequest) Reset()
func (*ListRuntimesRequest) String
func (x *ListRuntimesRequest) String() string
ListRuntimesResponse
type ListRuntimesResponse struct {
// A list of returned Runtimes.
Runtimes []*Runtime `protobuf:"bytes,1,rep,name=runtimes,proto3" json:"runtimes,omitempty"`
// Page token that can be used to continue listing from the last result in the
// next list call.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached. For example,
// ['us-west1', 'us-central1'].
// A ListRuntimesResponse will only contain either runtimes or unreachables,
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response for listing Managed Notebook Runtimes.
func (*ListRuntimesResponse) Descriptor
func (*ListRuntimesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRuntimesResponse.ProtoReflect.Descriptor instead.
func (*ListRuntimesResponse) GetNextPageToken
func (x *ListRuntimesResponse) GetNextPageToken() string
func (*ListRuntimesResponse) GetRuntimes
func (x *ListRuntimesResponse) GetRuntimes() []*Runtime
func (*ListRuntimesResponse) GetUnreachable
func (x *ListRuntimesResponse) GetUnreachable() []string
func (*ListRuntimesResponse) ProtoMessage
func (*ListRuntimesResponse) ProtoMessage()
func (*ListRuntimesResponse) ProtoReflect
func (x *ListRuntimesResponse) ProtoReflect() protoreflect.Message
func (*ListRuntimesResponse) Reset
func (x *ListRuntimesResponse) Reset()
func (*ListRuntimesResponse) String
func (x *ListRuntimesResponse) String() string
ListSchedulesRequest
type ListSchedulesRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum return size of the list call.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A previous returned page token that can be used to continue listing
// from the last result.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Filter applied to resulting schedules.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Field to order results by.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}
Request for listing scheduled notebook job.
func (*ListSchedulesRequest) Descriptor
func (*ListSchedulesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSchedulesRequest.ProtoReflect.Descriptor instead.
func (*ListSchedulesRequest) GetFilter
func (x *ListSchedulesRequest) GetFilter() string
func (*ListSchedulesRequest) GetOrderBy
func (x *ListSchedulesRequest) GetOrderBy() string
func (*ListSchedulesRequest) GetPageSize
func (x *ListSchedulesRequest) GetPageSize() int32
func (*ListSchedulesRequest) GetPageToken
func (x *ListSchedulesRequest) GetPageToken() string
func (*ListSchedulesRequest) GetParent
func (x *ListSchedulesRequest) GetParent() string
func (*ListSchedulesRequest) ProtoMessage
func (*ListSchedulesRequest) ProtoMessage()
func (*ListSchedulesRequest) ProtoReflect
func (x *ListSchedulesRequest) ProtoReflect() protoreflect.Message
func (*ListSchedulesRequest) Reset
func (x *ListSchedulesRequest) Reset()
func (*ListSchedulesRequest) String
func (x *ListSchedulesRequest) String() string
ListSchedulesResponse
type ListSchedulesResponse struct {
// A list of returned instances.
Schedules []*Schedule `protobuf:"bytes,1,rep,name=schedules,proto3" json:"schedules,omitempty"`
// Page token that can be used to continue listing from the last result in the
// next list call.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Schedules that could not be reached. For example:
//
// ['projects/{project_id}/location/{location}/schedules/monthly_digest',
// 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}
Response for listing scheduled notebook job.
func (*ListSchedulesResponse) Descriptor
func (*ListSchedulesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSchedulesResponse.ProtoReflect.Descriptor instead.
func (*ListSchedulesResponse) GetNextPageToken
func (x *ListSchedulesResponse) GetNextPageToken() string
func (*ListSchedulesResponse) GetSchedules
func (x *ListSchedulesResponse) GetSchedules() []*Schedule
func (*ListSchedulesResponse) GetUnreachable
func (x *ListSchedulesResponse) GetUnreachable() []string
func (*ListSchedulesResponse) ProtoMessage
func (*ListSchedulesResponse) ProtoMessage()
func (*ListSchedulesResponse) ProtoReflect
func (x *ListSchedulesResponse) ProtoReflect() protoreflect.Message
func (*ListSchedulesResponse) Reset
func (x *ListSchedulesResponse) Reset()
func (*ListSchedulesResponse) String
func (x *ListSchedulesResponse) String() string
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"`
// 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 instance.
//
// This property is mutually exclusive with the source property; you can only
// define one or the other, but not both.
InitializeParams *LocalDiskInitializeParams `protobuf:"bytes,6,opt,name=initialize_params,json=initializeParams,proto3" json:"initialize_params,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) Descriptor
Deprecated: Use LocalDisk.ProtoReflect.Descriptor instead.
func (*LocalDisk) GetAutoDelete
func (*LocalDisk) GetBoot
func (*LocalDisk) GetDeviceName
func (*LocalDisk) GetGuestOsFeatures
func (x *LocalDisk) GetGuestOsFeatures() []*LocalDisk_RuntimeGuestOsFeature
func (*LocalDisk) GetIndex
func (*LocalDisk) GetInitializeParams
func (x *LocalDisk) GetInitializeParams() *LocalDiskInitializeParams
func (*LocalDisk) GetInterface
func (*LocalDisk) GetKind
func (*LocalDisk) GetLicenses
func (*LocalDisk) GetMode
func (*LocalDisk) GetSource
func (*LocalDisk) GetType
func (*LocalDisk) ProtoMessage
func (*LocalDisk) ProtoMessage()
func (*LocalDisk) ProtoReflect
func (x *LocalDisk) ProtoReflect() protoreflect.Message
func (*LocalDisk) Reset
func (x *LocalDisk) Reset()
func (*LocalDisk) String
LocalDiskInitializeParams
type LocalDiskInitializeParams struct {
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
DiskName string `protobuf:"bytes,2,opt,name=disk_name,json=diskName,proto3" json:"disk_name,omitempty"`
DiskSizeGb int64 `protobuf:"varint,3,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
DiskType LocalDiskInitializeParams_DiskType "" /* 152 byte string literal not displayed */
Labels map[string]string "" /* 153 byte string literal not displayed */
}
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) Descriptor
func (*LocalDiskInitializeParams) Descriptor() ([]byte, []int)
Deprecated: Use LocalDiskInitializeParams.ProtoReflect.Descriptor instead.
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) GetDiskType
func (x *LocalDiskInitializeParams) GetDiskType() LocalDiskInitializeParams_DiskType
func (*LocalDiskInitializeParams) GetLabels
func (x *LocalDiskInitializeParams) GetLabels() map[string]string
func (*LocalDiskInitializeParams) ProtoMessage
func (*LocalDiskInitializeParams) ProtoMessage()
func (*LocalDiskInitializeParams) ProtoReflect
func (x *LocalDiskInitializeParams) ProtoReflect() protoreflect.Message
func (*LocalDiskInitializeParams) Reset
func (x *LocalDiskInitializeParams) Reset()
func (*LocalDiskInitializeParams) String
func (x *LocalDiskInitializeParams) String() string
LocalDiskInitializeParams_DiskType
type LocalDiskInitializeParams_DiskType int32
Possible disk types.
LocalDiskInitializeParams_DISK_TYPE_UNSPECIFIED, LocalDiskInitializeParams_PD_STANDARD, LocalDiskInitializeParams_PD_SSD, LocalDiskInitializeParams_PD_BALANCED, LocalDiskInitializeParams_PD_EXTREME
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) Descriptor() protoreflect.EnumDescriptor
func (LocalDiskInitializeParams_DiskType) Enum
func (x LocalDiskInitializeParams_DiskType) Enum() *LocalDiskInitializeParams_DiskType
func (LocalDiskInitializeParams_DiskType) EnumDescriptor
func (LocalDiskInitializeParams_DiskType) EnumDescriptor() ([]byte, []int)
Deprecated: Use LocalDiskInitializeParams_DiskType.Descriptor instead.
func (LocalDiskInitializeParams_DiskType) Number
func (x LocalDiskInitializeParams_DiskType) Number() protoreflect.EnumNumber
func (LocalDiskInitializeParams_DiskType) String
func (x LocalDiskInitializeParams_DiskType) String() string
func (LocalDiskInitializeParams_DiskType) Type
func (LocalDiskInitializeParams_DiskType) Type() protoreflect.EnumType
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 to see a list of available options. Guest OS features for boot disk.
func (*LocalDisk_RuntimeGuestOsFeature) Descriptor
func (*LocalDisk_RuntimeGuestOsFeature) Descriptor() ([]byte, []int)
Deprecated: Use LocalDisk_RuntimeGuestOsFeature.ProtoReflect.Descriptor instead.
func (*LocalDisk_RuntimeGuestOsFeature) GetType
func (x *LocalDisk_RuntimeGuestOsFeature) GetType() string
func (*LocalDisk_RuntimeGuestOsFeature) ProtoMessage
func (*LocalDisk_RuntimeGuestOsFeature) ProtoMessage()
func (*LocalDisk_RuntimeGuestOsFeature) ProtoReflect
func (x *LocalDisk_RuntimeGuestOsFeature) ProtoReflect() protoreflect.Message
func (*LocalDisk_RuntimeGuestOsFeature) Reset
func (x *LocalDisk_RuntimeGuestOsFeature) Reset()
func (*LocalDisk_RuntimeGuestOsFeature) String
func (x *LocalDisk_RuntimeGuestOsFeature) String() string
ManagedNotebookServiceClient
type ManagedNotebookServiceClient interface {
// Lists Runtimes in a given project and location.
ListRuntimes(ctx context.Context, in *ListRuntimesRequest, opts ...grpc.CallOption) (*ListRuntimesResponse, error)
// Gets details of a single Runtime. The location must be a regional endpoint
// rather than zonal.
GetRuntime(ctx context.Context, in *GetRuntimeRequest, opts ...grpc.CallOption) (*Runtime, error)
// Creates a new Runtime in a given project and location.
CreateRuntime(ctx context.Context, in *CreateRuntimeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Deletes a single Runtime.
DeleteRuntime(ctx context.Context, in *DeleteRuntimeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Starts a Managed Notebook Runtime.
// Perform "Start" on GPU instances; "Resume" on CPU instances
// See:
// https://cloud.google.com/compute/docs/instances/stop-start-instance
// https://cloud.google.com/compute/docs/instances/suspend-resume-instance
StartRuntime(ctx context.Context, in *StartRuntimeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Stops a Managed Notebook Runtime.
// Perform "Stop" on GPU instances; "Suspend" on CPU instances
// See:
// https://cloud.google.com/compute/docs/instances/stop-start-instance
// https://cloud.google.com/compute/docs/instances/suspend-resume-instance
StopRuntime(ctx context.Context, in *StopRuntimeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Switch a Managed Notebook Runtime.
SwitchRuntime(ctx context.Context, in *SwitchRuntimeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Resets a Managed Notebook Runtime.
ResetRuntime(ctx context.Context, in *ResetRuntimeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Report and process a runtime event.
ReportRuntimeEvent(ctx context.Context, in *ReportRuntimeEventRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Gets an access token for the consumer service account that the customer
// attached to the runtime. Only accessible from the tenant instance.
RefreshRuntimeTokenInternal(ctx context.Context, in *RefreshRuntimeTokenInternalRequest, opts ...grpc.CallOption) (*RefreshRuntimeTokenInternalResponse, error)
}
ManagedNotebookServiceClient is the client API for ManagedNotebookService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewManagedNotebookServiceClient
func NewManagedNotebookServiceClient(cc grpc.ClientConnInterface) ManagedNotebookServiceClient
ManagedNotebookServiceServer
type ManagedNotebookServiceServer interface {
// Lists Runtimes in a given project and location.
ListRuntimes(context.Context, *ListRuntimesRequest) (*ListRuntimesResponse, error)
// Gets details of a single Runtime. The location must be a regional endpoint
// rather than zonal.
GetRuntime(context.Context, *GetRuntimeRequest) (*Runtime, error)
// Creates a new Runtime in a given project and location.
CreateRuntime(context.Context, *CreateRuntimeRequest) (*longrunning.Operation, error)
// Deletes a single Runtime.
DeleteRuntime(context.Context, *DeleteRuntimeRequest) (*longrunning.Operation, error)
// Starts a Managed Notebook Runtime.
// Perform "Start" on GPU instances; "Resume" on CPU instances
// See:
// https://cloud.google.com/compute/docs/instances/stop-start-instance
// https://cloud.google.com/compute/docs/instances/suspend-resume-instance
StartRuntime(context.Context, *StartRuntimeRequest) (*longrunning.Operation, error)
// Stops a Managed Notebook Runtime.
// Perform "Stop" on GPU instances; "Suspend" on CPU instances
// See:
// https://cloud.google.com/compute/docs/instances/stop-start-instance
// https://cloud.google.com/compute/docs/instances/suspend-resume-instance
StopRuntime(context.Context, *StopRuntimeRequest) (*longrunning.Operation, error)
// Switch a Managed Notebook Runtime.
SwitchRuntime(context.Context, *SwitchRuntimeRequest) (*longrunning.Operation, error)
// Resets a Managed Notebook Runtime.
ResetRuntime(context.Context, *ResetRuntimeRequest) (*longrunning.Operation, error)
// Report and process a runtime event.
ReportRuntimeEvent(context.Context, *ReportRuntimeEventRequest) (*longrunning.Operation, error)
// Gets an access token for the consumer service account that the customer
// attached to the runtime. Only accessible from the tenant instance.
RefreshRuntimeTokenInternal(context.Context, *RefreshRuntimeTokenInternalRequest) (*RefreshRuntimeTokenInternalResponse, error)
}
ManagedNotebookServiceServer is the server API for ManagedNotebookService service.
NotebookServiceClient
type NotebookServiceClient interface {
// Lists instances in a given project and location.
ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
// Gets details of a single Instance.
GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
// Creates a new Instance in a given project and location.
CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Registers an existing legacy notebook instance to the Notebooks API server.
// Legacy instances are instances created with the legacy Compute Engine
// calls. They are not manageable by the Notebooks API out of the box. This
// call makes these instances manageable by the Notebooks API.
RegisterInstance(ctx context.Context, in *RegisterInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Updates the guest accelerators of a single Instance.
SetInstanceAccelerator(ctx context.Context, in *SetInstanceAcceleratorRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Updates the machine type of a single Instance.
SetInstanceMachineType(ctx context.Context, in *SetInstanceMachineTypeRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Update Notebook Instance configurations.
UpdateInstanceConfig(ctx context.Context, in *UpdateInstanceConfigRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Updates the Shielded instance configuration of a single Instance.
UpdateShieldedInstanceConfig(ctx context.Context, in *UpdateShieldedInstanceConfigRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Replaces all the labels of an Instance.
SetInstanceLabels(ctx context.Context, in *SetInstanceLabelsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Add/update metadata items for an instance.
UpdateInstanceMetadataItems(ctx context.Context, in *UpdateInstanceMetadataItemsRequest, opts ...grpc.CallOption) (*UpdateInstanceMetadataItemsResponse, error)
// Deletes a single Instance.
DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Starts a notebook instance.
StartInstance(ctx context.Context, in *StartInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Stops a notebook instance.
StopInstance(ctx context.Context, in *StopInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Resets a notebook instance.
ResetInstance(ctx context.Context, in *ResetInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Allows notebook instances to
// report their latest instance information to the Notebooks
// API server. The server will merge the reported information to
// the instance metadata store. Do not use this method directly.
ReportInstanceInfo(ctx context.Context, in *ReportInstanceInfoRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Check if a notebook instance is upgradable.
IsInstanceUpgradeable(ctx context.Context, in *IsInstanceUpgradeableRequest, opts ...grpc.CallOption) (*IsInstanceUpgradeableResponse, error)
// Check if a notebook instance is healthy.
GetInstanceHealth(ctx context.Context, in *GetInstanceHealthRequest, opts ...grpc.CallOption) (*GetInstanceHealthResponse, error)
// Upgrades a notebook instance to the latest version.
UpgradeInstance(ctx context.Context, in *UpgradeInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Rollbacks a notebook instance to the previous version.
RollbackInstance(ctx context.Context, in *RollbackInstanceRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Allows notebook instances to
// call this endpoint to upgrade themselves. Do not use this method directly.
UpgradeInstanceInternal(ctx context.Context, in *UpgradeInstanceInternalRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Lists environments in a project.
ListEnvironments(ctx context.Context, in *ListEnvironmentsRequest, opts ...grpc.CallOption) (*ListEnvironmentsResponse, error)
// Gets details of a single Environment.
GetEnvironment(ctx context.Context, in *GetEnvironmentRequest, opts ...grpc.CallOption) (*Environment, error)
// Creates a new Environment.
CreateEnvironment(ctx context.Context, in *CreateEnvironmentRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Deletes a single Environment.
DeleteEnvironment(ctx context.Context, in *DeleteEnvironmentRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Lists schedules in a given project and location.
ListSchedules(ctx context.Context, in *ListSchedulesRequest, opts ...grpc.CallOption) (*ListSchedulesResponse, error)
// Gets details of schedule
GetSchedule(ctx context.Context, in *GetScheduleRequest, opts ...grpc.CallOption) (*Schedule, error)
// Deletes schedule and all underlying jobs
DeleteSchedule(ctx context.Context, in *DeleteScheduleRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Creates a new Scheduled Notebook in a given project and location.
CreateSchedule(ctx context.Context, in *CreateScheduleRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Triggers execution of an existing schedule.
TriggerSchedule(ctx context.Context, in *TriggerScheduleRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Lists executions in a given project and location
ListExecutions(ctx context.Context, in *ListExecutionsRequest, opts ...grpc.CallOption) (*ListExecutionsResponse, error)
// Gets details of executions
GetExecution(ctx context.Context, in *GetExecutionRequest, opts ...grpc.CallOption) (*Execution, error)
// Deletes execution
DeleteExecution(ctx context.Context, in *DeleteExecutionRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Creates a new Execution in a given project and location.
CreateExecution(ctx context.Context, in *CreateExecutionRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}
NotebookServiceClient is the client API for NotebookService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewNotebookServiceClient
func NewNotebookServiceClient(cc grpc.ClientConnInterface) NotebookServiceClient
NotebookServiceServer
type NotebookServiceServer interface {
// Lists instances in a given project and location.
ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
// Gets details of a single Instance.
GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
// Creates a new Instance in a given project and location.
CreateInstance(context.Context, *CreateInstanceRequest) (*longrunning.Operation, error)
// Registers an existing legacy notebook instance to the Notebooks API server.
// Legacy instances are instances created with the legacy Compute Engine
// calls. They are not manageable by the Notebooks API out of the box. This
// call makes these instances manageable by the Notebooks API.
RegisterInstance(context.Context, *RegisterInstanceRequest) (*longrunning.Operation, error)
// Updates the guest accelerators of a single Instance.
SetInstanceAccelerator(context.Context, *SetInstanceAcceleratorRequest) (*longrunning.Operation, error)
// Updates the machine type of a single Instance.
SetInstanceMachineType(context.Context, *SetInstanceMachineTypeRequest) (*longrunning.Operation, error)
// Update Notebook Instance configurations.
UpdateInstanceConfig(context.Context, *UpdateInstanceConfigRequest) (*longrunning.Operation, error)
// Updates the Shielded instance configuration of a single Instance.
UpdateShieldedInstanceConfig(context.Context, *UpdateShieldedInstanceConfigRequest) (*longrunning.Operation, error)
// Replaces all the labels of an Instance.
SetInstanceLabels(context.Context, *SetInstanceLabelsRequest) (*longrunning.Operation, error)
// Add/update metadata items for an instance.
UpdateInstanceMetadataItems(context.Context, *UpdateInstanceMetadataItemsRequest) (*UpdateInstanceMetadataItemsResponse, error)
// Deletes a single Instance.
DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunning.Operation, error)
// Starts a notebook instance.
StartInstance(context.Context, *StartInstanceRequest) (*longrunning.Operation, error)
// Stops a notebook instance.
StopInstance(context.Context, *StopInstanceRequest) (*longrunning.Operation, error)
// Resets a notebook instance.
ResetInstance(context.Context, *ResetInstanceRequest) (*longrunning.Operation, error)
// Allows notebook instances to
// report their latest instance information to the Notebooks
// API server. The server will merge the reported information to
// the instance metadata store. Do not use this method directly.
ReportInstanceInfo(context.Context, *ReportInstanceInfoRequest) (*longrunning.Operation, error)
// Check if a notebook instance is upgradable.
IsInstanceUpgradeable(context.Context, *IsInstanceUpgradeableRequest) (*IsInstanceUpgradeableResponse, error)
// Check if a notebook instance is healthy.
GetInstanceHealth(context.Context, *GetInstanceHealthRequest) (*GetInstanceHealthResponse, error)
// Upgrades a notebook instance to the latest version.
UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunning.Operation, error)
// Rollbacks a notebook instance to the previous version.
RollbackInstance(context.Context, *RollbackInstanceRequest) (*longrunning.Operation, error)
// Allows notebook instances to
// call this endpoint to upgrade themselves. Do not use this method directly.
UpgradeInstanceInternal(context.Context, *UpgradeInstanceInternalRequest) (*longrunning.Operation, error)
// Lists environments in a project.
ListEnvironments(context.Context, *ListEnvironmentsRequest) (*ListEnvironmentsResponse, error)
// Gets details of a single Environment.
GetEnvironment(context.Context, *GetEnvironmentRequest) (*Environment, error)
// Creates a new Environment.
CreateEnvironment(context.Context, *CreateEnvironmentRequest) (*longrunning.Operation, error)
// Deletes a single Environment.
DeleteEnvironment(context.Context, *DeleteEnvironmentRequest) (*longrunning.Operation, error)
// Lists schedules in a given project and location.
ListSchedules(context.Context, *ListSchedulesRequest) (*ListSchedulesResponse, error)
// Gets details of schedule
GetSchedule(context.Context, *GetScheduleRequest) (*Schedule, error)
// Deletes schedule and all underlying jobs
DeleteSchedule(context.Context, *DeleteScheduleRequest) (*longrunning.Operation, error)
// Creates a new Scheduled Notebook in a given project and location.
CreateSchedule(context.Context, *CreateScheduleRequest) (*longrunning.Operation, error)
// Triggers execution of an existing schedule.
TriggerSchedule(context.Context, *TriggerScheduleRequest) (*longrunning.Operation, error)
// Lists executions in a given project and location
ListExecutions(context.Context, *ListExecutionsRequest) (*ListExecutionsResponse, error)
// Gets details of executions
GetExecution(context.Context, *GetExecutionRequest) (*Execution, error)
// Deletes execution
DeleteExecution(context.Context, *DeleteExecutionRequest) (*longrunning.Operation, error)
// Creates a new Execution in a given project and location.
CreateExecution(context.Context, *CreateExecutionRequest) (*longrunning.Operation, error)
}
NotebookServiceServer is the server API for NotebookService service.
OperationMetadata
type OperationMetadata struct {
// The time the operation was created.
CreateTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The time the operation finished running.
EndTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Server-defined resource path for the target of the operation.
Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Name of the verb executed by the operation.
Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Human-readable status of the operation, if any.
StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
// have [Operation.error][] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// API version used to start the operation.
ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// API endpoint name of this operation.
Endpoint string `protobuf:"bytes,8,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
// contains filtered or unexported fields
}
Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
func (*OperationMetadata) Descriptor() ([]byte, []int)
Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() string
func (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamp.Timestamp
func (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamp.Timestamp
func (*OperationMetadata) GetEndpoint
func (x *OperationMetadata) GetEndpoint() string
func (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() bool
func (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() string
func (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() string
func (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() string
func (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()
func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Message
func (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()
func (*OperationMetadata) String
func (x *OperationMetadata) String() string
RefreshRuntimeTokenInternalRequest
type RefreshRuntimeTokenInternalRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The VM hardware token for authenticating the VM.
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
// contains filtered or unexported fields
}
Request for getting a new access token.
func (*RefreshRuntimeTokenInternalRequest) Descriptor
func (*RefreshRuntimeTokenInternalRequest) Descriptor() ([]byte, []int)
Deprecated: Use RefreshRuntimeTokenInternalRequest.ProtoReflect.Descriptor instead.
func (*RefreshRuntimeTokenInternalRequest) GetName
func (x *RefreshRuntimeTokenInternalRequest) GetName() string
func (*RefreshRuntimeTokenInternalRequest) GetVmId
func (x *RefreshRuntimeTokenInternalRequest) GetVmId() string
func (*RefreshRuntimeTokenInternalRequest) ProtoMessage
func (*RefreshRuntimeTokenInternalRequest) ProtoMessage()
func (*RefreshRuntimeTokenInternalRequest) ProtoReflect
func (x *RefreshRuntimeTokenInternalRequest) ProtoReflect() protoreflect.Message
func (*RefreshRuntimeTokenInternalRequest) Reset
func (x *RefreshRuntimeTokenInternalRequest) Reset()
func (*RefreshRuntimeTokenInternalRequest) String
func (x *RefreshRuntimeTokenInternalRequest) String() string
RefreshRuntimeTokenInternalResponse
type RefreshRuntimeTokenInternalResponse struct {
// The OAuth 2.0 access token.
AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
// Output only. Token expiration time.
ExpireTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}
Response with a new access token.
func (*RefreshRuntimeTokenInternalResponse) Descriptor
func (*RefreshRuntimeTokenInternalResponse) Descriptor() ([]byte, []int)
Deprecated: Use RefreshRuntimeTokenInternalResponse.ProtoReflect.Descriptor instead.
func (*RefreshRuntimeTokenInternalResponse) GetAccessToken
func (x *RefreshRuntimeTokenInternalResponse) GetAccessToken() string
func (*RefreshRuntimeTokenInternalResponse) GetExpireTime
func (x *RefreshRuntimeTokenInternalResponse) GetExpireTime() *timestamp.Timestamp
func (*RefreshRuntimeTokenInternalResponse) ProtoMessage
func (*RefreshRuntimeTokenInternalResponse) ProtoMessage()
func (*RefreshRuntimeTokenInternalResponse) ProtoReflect
func (x *RefreshRuntimeTokenInternalResponse) ProtoReflect() protoreflect.Message
func (*RefreshRuntimeTokenInternalResponse) Reset
func (x *RefreshRuntimeTokenInternalResponse) Reset()
func (*RefreshRuntimeTokenInternalResponse) String
func (x *RefreshRuntimeTokenInternalResponse) String() string
RegisterInstanceRequest
type RegisterInstanceRequest struct {
// Required. Format:
// `parent=projects/{project_id}/locations/{location}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. User defined unique ID of this instance. The `instance_id` must
// be 1 to 63 characters long and contain only lowercase letters,
// numeric characters, and dashes. The first character must be a lowercase
// letter and the last character cannot be a dash.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// contains filtered or unexported fields
}
Request for registering a notebook instance.
func (*RegisterInstanceRequest) Descriptor
func (*RegisterInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use RegisterInstanceRequest.ProtoReflect.Descriptor instead.
func (*RegisterInstanceRequest) GetInstanceId
func (x *RegisterInstanceRequest) GetInstanceId() string
func (*RegisterInstanceRequest) GetParent
func (x *RegisterInstanceRequest) GetParent() string
func (*RegisterInstanceRequest) ProtoMessage
func (*RegisterInstanceRequest) ProtoMessage()
func (*RegisterInstanceRequest) ProtoReflect
func (x *RegisterInstanceRequest) ProtoReflect() protoreflect.Message
func (*RegisterInstanceRequest) Reset
func (x *RegisterInstanceRequest) Reset()
func (*RegisterInstanceRequest) String
func (x *RegisterInstanceRequest) String() string
ReportInstanceInfoRequest
type ReportInstanceInfoRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
Metadata map[string]string "" /* 157 byte string literal not displayed */
}
Request for notebook instances to report information to Notebooks API.
func (*ReportInstanceInfoRequest) Descriptor
func (*ReportInstanceInfoRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReportInstanceInfoRequest.ProtoReflect.Descriptor instead.
func (*ReportInstanceInfoRequest) GetMetadata
func (x *ReportInstanceInfoRequest) GetMetadata() map[string]string
func (*ReportInstanceInfoRequest) GetName
func (x *ReportInstanceInfoRequest) GetName() string
func (*ReportInstanceInfoRequest) GetVmId
func (x *ReportInstanceInfoRequest) GetVmId() string
func (*ReportInstanceInfoRequest) ProtoMessage
func (*ReportInstanceInfoRequest) ProtoMessage()
func (*ReportInstanceInfoRequest) ProtoReflect
func (x *ReportInstanceInfoRequest) ProtoReflect() protoreflect.Message
func (*ReportInstanceInfoRequest) Reset
func (x *ReportInstanceInfoRequest) Reset()
func (*ReportInstanceInfoRequest) String
func (x *ReportInstanceInfoRequest) String() string
ReportRuntimeEventRequest
type ReportRuntimeEventRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The VM hardware token for authenticating the VM.
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
// Required. The Event to be reported.
Event *Event `protobuf:"bytes,3,opt,name=event,proto3" json:"event,omitempty"`
// contains filtered or unexported fields
}
Request for reporting a Managed Notebook Event.
func (*ReportRuntimeEventRequest) Descriptor
func (*ReportRuntimeEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReportRuntimeEventRequest.ProtoReflect.Descriptor instead.
func (*ReportRuntimeEventRequest) GetEvent
func (x *ReportRuntimeEventRequest) GetEvent() *Event
func (*ReportRuntimeEventRequest) GetName
func (x *ReportRuntimeEventRequest) GetName() string
func (*ReportRuntimeEventRequest) GetVmId
func (x *ReportRuntimeEventRequest) GetVmId() string
func (*ReportRuntimeEventRequest) ProtoMessage
func (*ReportRuntimeEventRequest) ProtoMessage()
func (*ReportRuntimeEventRequest) ProtoReflect
func (x *ReportRuntimeEventRequest) ProtoReflect() protoreflect.Message
func (*ReportRuntimeEventRequest) Reset
func (x *ReportRuntimeEventRequest) Reset()
func (*ReportRuntimeEventRequest) String
func (x *ReportRuntimeEventRequest) String() string
ReservationAffinity
type ReservationAffinity struct {
ConsumeReservationType ReservationAffinity_Type "" /* 186 byte string literal not displayed */
Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
Values []string `protobuf:"bytes,3,rep,name=values,proto3" json:"values,omitempty"`
}
Reservation Affinity for consuming Zonal reservation.
func (*ReservationAffinity) Descriptor
func (*ReservationAffinity) Descriptor() ([]byte, []int)
Deprecated: Use ReservationAffinity.ProtoReflect.Descriptor instead.
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) String
func (x *ReservationAffinity) String() string
ReservationAffinity_Type
type ReservationAffinity_Type int32
Indicates whether to consume capacity from an reservation or not.
ReservationAffinity_TYPE_UNSPECIFIED, ReservationAffinity_NO_RESERVATION, ReservationAffinity_ANY_RESERVATION, ReservationAffinity_SPECIFIC_RESERVATION
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) Descriptor() protoreflect.EnumDescriptor
func (ReservationAffinity_Type) Enum
func (x ReservationAffinity_Type) Enum() *ReservationAffinity_Type
func (ReservationAffinity_Type) EnumDescriptor
func (ReservationAffinity_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use ReservationAffinity_Type.Descriptor instead.
func (ReservationAffinity_Type) Number
func (x ReservationAffinity_Type) Number() protoreflect.EnumNumber
func (ReservationAffinity_Type) String
func (x ReservationAffinity_Type) String() string
func (ReservationAffinity_Type) Type
func (ReservationAffinity_Type) Type() protoreflect.EnumType
ResetInstanceRequest
type ResetInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for resetting a notebook instance
func (*ResetInstanceRequest) Descriptor
func (*ResetInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use ResetInstanceRequest.ProtoReflect.Descriptor instead.
func (*ResetInstanceRequest) GetName
func (x *ResetInstanceRequest) GetName() string
func (*ResetInstanceRequest) ProtoMessage
func (*ResetInstanceRequest) ProtoMessage()
func (*ResetInstanceRequest) ProtoReflect
func (x *ResetInstanceRequest) ProtoReflect() protoreflect.Message
func (*ResetInstanceRequest) Reset
func (x *ResetInstanceRequest) Reset()
func (*ResetInstanceRequest) String
func (x *ResetInstanceRequest) String() string
ResetRuntimeRequest
type ResetRuntimeRequest 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 resetting a Managed Notebook Runtime.
func (*ResetRuntimeRequest) Descriptor
func (*ResetRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use ResetRuntimeRequest.ProtoReflect.Descriptor instead.
func (*ResetRuntimeRequest) GetName
func (x *ResetRuntimeRequest) GetName() string
func (*ResetRuntimeRequest) GetRequestId
func (x *ResetRuntimeRequest) GetRequestId() string
func (*ResetRuntimeRequest) ProtoMessage
func (*ResetRuntimeRequest) ProtoMessage()
func (*ResetRuntimeRequest) ProtoReflect
func (x *ResetRuntimeRequest) ProtoReflect() protoreflect.Message
func (*ResetRuntimeRequest) Reset
func (x *ResetRuntimeRequest) Reset()
func (*ResetRuntimeRequest) String
func (x *ResetRuntimeRequest) String() string
RollbackInstanceRequest
type RollbackInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The snapshot for rollback.
// Example: "projects/test-project/global/snapshots/krwlzipynril".
TargetSnapshot string `protobuf:"bytes,2,opt,name=target_snapshot,json=targetSnapshot,proto3" json:"target_snapshot,omitempty"`
// contains filtered or unexported fields
}
Request for rollbacking a notebook instance
func (*RollbackInstanceRequest) Descriptor
func (*RollbackInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use RollbackInstanceRequest.ProtoReflect.Descriptor instead.
func (*RollbackInstanceRequest) GetName
func (x *RollbackInstanceRequest) GetName() string
func (*RollbackInstanceRequest) GetTargetSnapshot
func (x *RollbackInstanceRequest) GetTargetSnapshot() string
func (*RollbackInstanceRequest) ProtoMessage
func (*RollbackInstanceRequest) ProtoMessage()
func (*RollbackInstanceRequest) ProtoReflect
func (x *RollbackInstanceRequest) ProtoReflect() protoreflect.Message
func (*RollbackInstanceRequest) Reset
func (x *RollbackInstanceRequest) Reset()
func (*RollbackInstanceRequest) String
func (x *RollbackInstanceRequest) String() string
Runtime
type Runtime struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
RuntimeType isRuntime_RuntimeType `protobuf_oneof:"runtime_type"`
State Runtime_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.notebooks.v1.Runtime_State" json:"state,omitempty"`
HealthState Runtime_HealthState "" /* 146 byte string literal not displayed */
AccessConfig *RuntimeAccessConfig `protobuf:"bytes,5,opt,name=access_config,json=accessConfig,proto3" json:"access_config,omitempty"`
SoftwareConfig *RuntimeSoftwareConfig `protobuf:"bytes,6,opt,name=software_config,json=softwareConfig,proto3" json:"software_config,omitempty"`
Metrics *RuntimeMetrics `protobuf:"bytes,7,opt,name=metrics,proto3" json:"metrics,omitempty"`
CreateTime *timestamp.Timestamp `protobuf:"bytes,20,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamp.Timestamp `protobuf:"bytes,21,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
}
The definition of a Runtime for a managed notebook instance.
func (*Runtime) Descriptor
Deprecated: Use Runtime.ProtoReflect.Descriptor instead.
func (*Runtime) GetAccessConfig
func (x *Runtime) GetAccessConfig() *RuntimeAccessConfig
func (*Runtime) GetCreateTime
func (*Runtime) GetHealthState
func (x *Runtime) GetHealthState() Runtime_HealthState
func (*Runtime) GetMetrics
func (x *Runtime) GetMetrics() *RuntimeMetrics
func (*Runtime) GetName
func (*Runtime) GetRuntimeType
func (m *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 (*Runtime) GetVirtualMachine
func (x *Runtime) GetVirtualMachine() *VirtualMachine
func (*Runtime) ProtoMessage
func (*Runtime) ProtoMessage()
func (*Runtime) ProtoReflect
func (x *Runtime) ProtoReflect() protoreflect.Message
func (*Runtime) Reset
func (x *Runtime) Reset()
func (*Runtime) String
RuntimeAcceleratorConfig
type RuntimeAcceleratorConfig struct {
Type RuntimeAcceleratorConfig_AcceleratorType "" /* 134 byte string literal not displayed */
CoreCount int64 `protobuf:"varint,2,opt,name=core_count,json=coreCount,proto3" json:"core_count,omitempty"`
}
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. Examples:
nvidia-tesla-k80
nvidia-tesla-p100
nvidia-tesla-v100
nvidia-tesla-p4
nvidia-tesla-t4
nvidia-tesla-a100
func (*RuntimeAcceleratorConfig) Descriptor
func (*RuntimeAcceleratorConfig) Descriptor() ([]byte, []int)
Deprecated: Use RuntimeAcceleratorConfig.ProtoReflect.Descriptor instead.
func (*RuntimeAcceleratorConfig) GetCoreCount
func (x *RuntimeAcceleratorConfig) GetCoreCount() int64
func (*RuntimeAcceleratorConfig) GetType
func (x *RuntimeAcceleratorConfig) GetType() RuntimeAcceleratorConfig_AcceleratorType
func (*RuntimeAcceleratorConfig) ProtoMessage
func (*RuntimeAcceleratorConfig) ProtoMessage()
func (*RuntimeAcceleratorConfig) ProtoReflect
func (x *RuntimeAcceleratorConfig) ProtoReflect() protoreflect.Message
func (*RuntimeAcceleratorConfig) Reset
func (x *RuntimeAcceleratorConfig) Reset()
func (*RuntimeAcceleratorConfig) String
func (x *RuntimeAcceleratorConfig) String() string
RuntimeAcceleratorConfig_AcceleratorType
type RuntimeAcceleratorConfig_AcceleratorType int32
Type of this accelerator.
RuntimeAcceleratorConfig_ACCELERATOR_TYPE_UNSPECIFIED, RuntimeAcceleratorConfig_NVIDIA_TESLA_K80, RuntimeAcceleratorConfig_NVIDIA_TESLA_P100, RuntimeAcceleratorConfig_NVIDIA_TESLA_V100, RuntimeAcceleratorConfig_NVIDIA_TESLA_P4, RuntimeAcceleratorConfig_NVIDIA_TESLA_T4, RuntimeAcceleratorConfig_NVIDIA_TESLA_A100, RuntimeAcceleratorConfig_TPU_V2, RuntimeAcceleratorConfig_TPU_V3, RuntimeAcceleratorConfig_NVIDIA_TESLA_T4_VWS, RuntimeAcceleratorConfig_NVIDIA_TESLA_P100_VWS, RuntimeAcceleratorConfig_NVIDIA_TESLA_P4_VWS
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.
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) Descriptor() protoreflect.EnumDescriptor
func (RuntimeAcceleratorConfig_AcceleratorType) Enum
func (RuntimeAcceleratorConfig_AcceleratorType) EnumDescriptor
func (RuntimeAcceleratorConfig_AcceleratorType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RuntimeAcceleratorConfig_AcceleratorType.Descriptor instead.
func (RuntimeAcceleratorConfig_AcceleratorType) Number
func (x RuntimeAcceleratorConfig_AcceleratorType) Number() protoreflect.EnumNumber
func (RuntimeAcceleratorConfig_AcceleratorType) String
func (x RuntimeAcceleratorConfig_AcceleratorType) String() string
func (RuntimeAcceleratorConfig_AcceleratorType) Type
func (RuntimeAcceleratorConfig_AcceleratorType) Type() protoreflect.EnumType
RuntimeAccessConfig
type RuntimeAccessConfig struct {
AccessType RuntimeAccessConfig_RuntimeAccessType "" /* 161 byte string literal not displayed */
RuntimeOwner string `protobuf:"bytes,2,opt,name=runtime_owner,json=runtimeOwner,proto3" json:"runtime_owner,omitempty"`
ProxyUri string `protobuf:"bytes,3,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
}
Specifies the login configuration for Runtime
func (*RuntimeAccessConfig) Descriptor
func (*RuntimeAccessConfig) Descriptor() ([]byte, []int)
Deprecated: Use RuntimeAccessConfig.ProtoReflect.Descriptor instead.
func (*RuntimeAccessConfig) GetAccessType
func (x *RuntimeAccessConfig) GetAccessType() RuntimeAccessConfig_RuntimeAccessType
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) String
func (x *RuntimeAccessConfig) String() string
RuntimeAccessConfig_RuntimeAccessType
type RuntimeAccessConfig_RuntimeAccessType int32
Possible ways to access runtime. Authentication mode. Currently supports: Single User only.
RuntimeAccessConfig_RUNTIME_ACCESS_TYPE_UNSPECIFIED, RuntimeAccessConfig_SINGLE_USER, RuntimeAccessConfig_SERVICE_ACCOUNT
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) Descriptor() protoreflect.EnumDescriptor
func (RuntimeAccessConfig_RuntimeAccessType) Enum
func (RuntimeAccessConfig_RuntimeAccessType) EnumDescriptor
func (RuntimeAccessConfig_RuntimeAccessType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RuntimeAccessConfig_RuntimeAccessType.Descriptor instead.
func (RuntimeAccessConfig_RuntimeAccessType) Number
func (x RuntimeAccessConfig_RuntimeAccessType) Number() protoreflect.EnumNumber
func (RuntimeAccessConfig_RuntimeAccessType) String
func (x RuntimeAccessConfig_RuntimeAccessType) String() string
func (RuntimeAccessConfig_RuntimeAccessType) Type
func (RuntimeAccessConfig_RuntimeAccessType) Type() protoreflect.EnumType
RuntimeMetrics
type RuntimeMetrics struct {
SystemMetrics map[string]string "" /* 188 byte string literal not displayed */
}
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
func (*RuntimeMetrics) Descriptor
func (*RuntimeMetrics) Descriptor() ([]byte, []int)
Deprecated: Use RuntimeMetrics.ProtoReflect.Descriptor instead.
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) String
func (x *RuntimeMetrics) String() string
RuntimeShieldedInstanceConfig
type RuntimeShieldedInstanceConfig struct {
EnableSecureBoot bool `protobuf:"varint,1,opt,name=enable_secure_boot,json=enableSecureBoot,proto3" json:"enable_secure_boot,omitempty"`
EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
EnableIntegrityMonitoring bool "" /* 139 byte string literal not displayed */
}
A set of Shielded Instance options. Check Images using supported Shielded VM features. Not all combinations are valid.
func (*RuntimeShieldedInstanceConfig) Descriptor
func (*RuntimeShieldedInstanceConfig) Descriptor() ([]byte, []int)
Deprecated: Use RuntimeShieldedInstanceConfig.ProtoReflect.Descriptor instead.
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 (x *RuntimeShieldedInstanceConfig) ProtoReflect() protoreflect.Message
func (*RuntimeShieldedInstanceConfig) Reset
func (x *RuntimeShieldedInstanceConfig) Reset()
func (*RuntimeShieldedInstanceConfig) String
func (x *RuntimeShieldedInstanceConfig) String() string
RuntimeSoftwareConfig
type RuntimeSoftwareConfig struct {
NotebookUpgradeSchedule string "" /* 132 byte string literal not displayed */
EnableHealthMonitoring *bool "" /* 136 byte string literal not displayed */
IdleShutdown *bool `protobuf:"varint,3,opt,name=idle_shutdown,json=idleShutdown,proto3,oneof" json:"idle_shutdown,omitempty"`
IdleShutdownTimeout int32 `protobuf:"varint,4,opt,name=idle_shutdown_timeout,json=idleShutdownTimeout,proto3" json:"idle_shutdown_timeout,omitempty"`
InstallGpuDriver bool `protobuf:"varint,5,opt,name=install_gpu_driver,json=installGpuDriver,proto3" json:"install_gpu_driver,omitempty"`
CustomGpuDriverPath string `protobuf:"bytes,6,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
PostStartupScript string `protobuf:"bytes,7,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
Kernels []*ContainerImage `protobuf:"bytes,8,rep,name=kernels,proto3" json:"kernels,omitempty"`
Upgradeable *bool `protobuf:"varint,9,opt,name=upgradeable,proto3,oneof" json:"upgradeable,omitempty"`
}
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) Descriptor
func (*RuntimeSoftwareConfig) Descriptor() ([]byte, []int)
Deprecated: Use RuntimeSoftwareConfig.ProtoReflect.Descriptor instead.
func (*RuntimeSoftwareConfig) GetCustomGpuDriverPath
func (x *RuntimeSoftwareConfig) GetCustomGpuDriverPath() string
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) GetNotebookUpgradeSchedule
func (x *RuntimeSoftwareConfig) GetNotebookUpgradeSchedule() string
func (*RuntimeSoftwareConfig) GetPostStartupScript
func (x *RuntimeSoftwareConfig) GetPostStartupScript() string
func (*RuntimeSoftwareConfig) GetUpgradeable
func (x *RuntimeSoftwareConfig) GetUpgradeable() 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) String
func (x *RuntimeSoftwareConfig) String() string
Runtime_HealthState
type Runtime_HealthState int32
The runtime substate.
Runtime_HEALTH_STATE_UNSPECIFIED, Runtime_HEALTHY, Runtime_UNHEALTHY, Runtime_AGENT_NOT_INSTALLED, Runtime_AGENT_NOT_RUNNING
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) Descriptor() protoreflect.EnumDescriptor
func (Runtime_HealthState) Enum
func (x Runtime_HealthState) Enum() *Runtime_HealthState
func (Runtime_HealthState) EnumDescriptor
func (Runtime_HealthState) EnumDescriptor() ([]byte, []int)
Deprecated: Use Runtime_HealthState.Descriptor instead.
func (Runtime_HealthState) Number
func (x Runtime_HealthState) Number() protoreflect.EnumNumber
func (Runtime_HealthState) String
func (x Runtime_HealthState) String() string
func (Runtime_HealthState) Type
func (Runtime_HealthState) Type() protoreflect.EnumType
Runtime_State
type Runtime_State int32
The definition of the states of this runtime.
Runtime_STATE_UNSPECIFIED, Runtime_STARTING, Runtime_PROVISIONING, Runtime_ACTIVE, Runtime_STOPPING, Runtime_STOPPED, Runtime_DELETING, Runtime_UPGRADING, Runtime_INITIALIZING
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) Descriptor() protoreflect.EnumDescriptor
func (Runtime_State) Enum
func (x Runtime_State) Enum() *Runtime_State
func (Runtime_State) EnumDescriptor
func (Runtime_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Runtime_State.Descriptor instead.
func (Runtime_State) Number
func (x Runtime_State) Number() protoreflect.EnumNumber
func (Runtime_State) String
func (x Runtime_State) String() string
func (Runtime_State) Type
func (Runtime_State) Type() protoreflect.EnumType
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"`
}
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.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 *timestamp.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time the schedule was last updated.
UpdateTime *timestamp.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) Descriptor
Deprecated: Use Schedule.ProtoReflect.Descriptor instead.
func (*Schedule) GetCreateTime
func (*Schedule) GetCronSchedule
func (*Schedule) GetDescription
func (*Schedule) GetDisplayName
func (*Schedule) GetExecutionTemplate
func (x *Schedule) GetExecutionTemplate() *ExecutionTemplate
func (*Schedule) GetName
func (*Schedule) GetRecentExecutions
func (*Schedule) GetState
func (x *Schedule) GetState() Schedule_State
func (*Schedule) GetTimeZone
func (*Schedule) GetUpdateTime
func (*Schedule) ProtoMessage
func (*Schedule) ProtoMessage()
func (*Schedule) ProtoReflect
func (x *Schedule) ProtoReflect() protoreflect.Message
func (*Schedule) Reset
func (x *Schedule) Reset()
func (*Schedule) String
Schedule_State
type Schedule_State int32
State of the job.
Schedule_STATE_UNSPECIFIED, Schedule_ENABLED, Schedule_PAUSED, Schedule_DISABLED, Schedule_UPDATE_FAILED, Schedule_INITIALIZING, Schedule_DELETING
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) Descriptor() protoreflect.EnumDescriptor
func (Schedule_State) Enum
func (x Schedule_State) Enum() *Schedule_State
func (Schedule_State) EnumDescriptor
func (Schedule_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Schedule_State.Descriptor instead.
func (Schedule_State) Number
func (x Schedule_State) Number() protoreflect.EnumNumber
func (Schedule_State) String
func (x Schedule_State) String() string
func (Schedule_State) Type
func (Schedule_State) Type() protoreflect.EnumType
SetInstanceAcceleratorRequest
type SetInstanceAcceleratorRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Type of this accelerator.
Type Instance_AcceleratorType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1.Instance_AcceleratorType" json:"type,omitempty"`
// Required. Count of cores of this accelerator. Note that not all combinations
// of `type` and `core_count` are valid. Check [GPUs on
// Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
// find a valid combination. TPUs are not supported.
CoreCount int64 `protobuf:"varint,3,opt,name=core_count,json=coreCount,proto3" json:"core_count,omitempty"`
// contains filtered or unexported fields
}
Request for setting instance accelerator.
func (*SetInstanceAcceleratorRequest) Descriptor
func (*SetInstanceAcceleratorRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetInstanceAcceleratorRequest.ProtoReflect.Descriptor instead.
func (*SetInstanceAcceleratorRequest) GetCoreCount
func (x *SetInstanceAcceleratorRequest) GetCoreCount() int64
func (*SetInstanceAcceleratorRequest) GetName
func (x *SetInstanceAcceleratorRequest) GetName() string
func (*SetInstanceAcceleratorRequest) GetType
func (x *SetInstanceAcceleratorRequest) GetType() Instance_AcceleratorType
func (*SetInstanceAcceleratorRequest) ProtoMessage
func (*SetInstanceAcceleratorRequest) ProtoMessage()
func (*SetInstanceAcceleratorRequest) ProtoReflect
func (x *SetInstanceAcceleratorRequest) ProtoReflect() protoreflect.Message
func (*SetInstanceAcceleratorRequest) Reset
func (x *SetInstanceAcceleratorRequest) Reset()
func (*SetInstanceAcceleratorRequest) String
func (x *SetInstanceAcceleratorRequest) String() string
SetInstanceLabelsRequest
type SetInstanceLabelsRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
}
Request for setting instance labels.
func (*SetInstanceLabelsRequest) Descriptor
func (*SetInstanceLabelsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetInstanceLabelsRequest.ProtoReflect.Descriptor instead.
func (*SetInstanceLabelsRequest) GetLabels
func (x *SetInstanceLabelsRequest) GetLabels() map[string]string
func (*SetInstanceLabelsRequest) GetName
func (x *SetInstanceLabelsRequest) GetName() string
func (*SetInstanceLabelsRequest) ProtoMessage
func (*SetInstanceLabelsRequest) ProtoMessage()
func (*SetInstanceLabelsRequest) ProtoReflect
func (x *SetInstanceLabelsRequest) ProtoReflect() protoreflect.Message
func (*SetInstanceLabelsRequest) Reset
func (x *SetInstanceLabelsRequest) Reset()
func (*SetInstanceLabelsRequest) String
func (x *SetInstanceLabelsRequest) String() string
SetInstanceMachineTypeRequest
type SetInstanceMachineTypeRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The [Compute Engine machine
// type](https://cloud.google.com/compute/docs/machine-types).
MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
// contains filtered or unexported fields
}
Request for setting instance machine type.
func (*SetInstanceMachineTypeRequest) Descriptor
func (*SetInstanceMachineTypeRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetInstanceMachineTypeRequest.ProtoReflect.Descriptor instead.
func (*SetInstanceMachineTypeRequest) GetMachineType
func (x *SetInstanceMachineTypeRequest) GetMachineType() string
func (*SetInstanceMachineTypeRequest) GetName
func (x *SetInstanceMachineTypeRequest) GetName() string
func (*SetInstanceMachineTypeRequest) ProtoMessage
func (*SetInstanceMachineTypeRequest) ProtoMessage()
func (*SetInstanceMachineTypeRequest) ProtoReflect
func (x *SetInstanceMachineTypeRequest) ProtoReflect() protoreflect.Message
func (*SetInstanceMachineTypeRequest) Reset
func (x *SetInstanceMachineTypeRequest) Reset()
func (*SetInstanceMachineTypeRequest) String
func (x *SetInstanceMachineTypeRequest) String() string
StartInstanceRequest
type StartInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for starting a notebook instance
func (*StartInstanceRequest) Descriptor
func (*StartInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartInstanceRequest.ProtoReflect.Descriptor instead.
func (*StartInstanceRequest) GetName
func (x *StartInstanceRequest) GetName() string
func (*StartInstanceRequest) ProtoMessage
func (*StartInstanceRequest) ProtoMessage()
func (*StartInstanceRequest) ProtoReflect
func (x *StartInstanceRequest) ProtoReflect() protoreflect.Message
func (*StartInstanceRequest) Reset
func (x *StartInstanceRequest) Reset()
func (*StartInstanceRequest) String
func (x *StartInstanceRequest) String() string
StartRuntimeRequest
type StartRuntimeRequest 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 starting a Managed Notebook Runtime.
func (*StartRuntimeRequest) Descriptor
func (*StartRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartRuntimeRequest.ProtoReflect.Descriptor instead.
func (*StartRuntimeRequest) GetName
func (x *StartRuntimeRequest) GetName() string
func (*StartRuntimeRequest) GetRequestId
func (x *StartRuntimeRequest) GetRequestId() string
func (*StartRuntimeRequest) ProtoMessage
func (*StartRuntimeRequest) ProtoMessage()
func (*StartRuntimeRequest) ProtoReflect
func (x *StartRuntimeRequest) ProtoReflect() protoreflect.Message
func (*StartRuntimeRequest) Reset
func (x *StartRuntimeRequest) Reset()
func (*StartRuntimeRequest) String
func (x *StartRuntimeRequest) String() string
StopInstanceRequest
type StopInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request for stopping a notebook instance
func (*StopInstanceRequest) Descriptor
func (*StopInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use StopInstanceRequest.ProtoReflect.Descriptor instead.
func (*StopInstanceRequest) GetName
func (x *StopInstanceRequest) GetName() string
func (*StopInstanceRequest) ProtoMessage
func (*StopInstanceRequest) ProtoMessage()
func (*StopInstanceRequest) ProtoReflect
func (x *StopInstanceRequest) ProtoReflect() protoreflect.Message
func (*StopInstanceRequest) Reset
func (x *StopInstanceRequest) Reset()
func (*StopInstanceRequest) String
func (x *StopInstanceRequest) String() string
StopRuntimeRequest
type StopRuntimeRequest 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 stopping a Managed Notebook Runtime.
func (*StopRuntimeRequest) Descriptor
func (*StopRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use StopRuntimeRequest.ProtoReflect.Descriptor instead.
func (*StopRuntimeRequest) GetName
func (x *StopRuntimeRequest) GetName() string
func (*StopRuntimeRequest) GetRequestId
func (x *StopRuntimeRequest) GetRequestId() string
func (*StopRuntimeRequest) ProtoMessage
func (*StopRuntimeRequest) ProtoMessage()
func (*StopRuntimeRequest) ProtoReflect
func (x *StopRuntimeRequest) ProtoReflect() protoreflect.Message
func (*StopRuntimeRequest) Reset
func (x *StopRuntimeRequest) Reset()
func (*StopRuntimeRequest) String
func (x *StopRuntimeRequest) String() string
SwitchRuntimeRequest
type SwitchRuntimeRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// machine type.
MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
// accelerator config.
AcceleratorConfig *RuntimeAcceleratorConfig `protobuf:"bytes,3,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,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 switching a Managed Notebook Runtime.
func (*SwitchRuntimeRequest) Descriptor
func (*SwitchRuntimeRequest) Descriptor() ([]byte, []int)
Deprecated: Use SwitchRuntimeRequest.ProtoReflect.Descriptor instead.
func (*SwitchRuntimeRequest) GetAcceleratorConfig
func (x *SwitchRuntimeRequest) GetAcceleratorConfig() *RuntimeAcceleratorConfig
func (*SwitchRuntimeRequest) GetMachineType
func (x *SwitchRuntimeRequest) GetMachineType() string
func (*SwitchRuntimeRequest) GetName
func (x *SwitchRuntimeRequest) GetName() string
func (*SwitchRuntimeRequest) GetRequestId
func (x *SwitchRuntimeRequest) GetRequestId() string
func (*SwitchRuntimeRequest) ProtoMessage
func (*SwitchRuntimeRequest) ProtoMessage()
func (*SwitchRuntimeRequest) ProtoReflect
func (x *SwitchRuntimeRequest) ProtoReflect() protoreflect.Message
func (*SwitchRuntimeRequest) Reset
func (x *SwitchRuntimeRequest) Reset()
func (*SwitchRuntimeRequest) String
func (x *SwitchRuntimeRequest) String() string
TriggerScheduleRequest
type TriggerScheduleRequest struct {
// Required. Format:
// `parent=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 created scheduled notebooks
func (*TriggerScheduleRequest) Descriptor
func (*TriggerScheduleRequest) Descriptor() ([]byte, []int)
Deprecated: Use TriggerScheduleRequest.ProtoReflect.Descriptor instead.
func (*TriggerScheduleRequest) GetName
func (x *TriggerScheduleRequest) GetName() string
func (*TriggerScheduleRequest) ProtoMessage
func (*TriggerScheduleRequest) ProtoMessage()
func (*TriggerScheduleRequest) ProtoReflect
func (x *TriggerScheduleRequest) ProtoReflect() protoreflect.Message
func (*TriggerScheduleRequest) Reset
func (x *TriggerScheduleRequest) Reset()
func (*TriggerScheduleRequest) String
func (x *TriggerScheduleRequest) String() string
UnimplementedManagedNotebookServiceServer
type UnimplementedManagedNotebookServiceServer struct {
}
UnimplementedManagedNotebookServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedManagedNotebookServiceServer) CreateRuntime
func (*UnimplementedManagedNotebookServiceServer) CreateRuntime(context.Context, *CreateRuntimeRequest) (*longrunning.Operation, error)
func (*UnimplementedManagedNotebookServiceServer) DeleteRuntime
func (*UnimplementedManagedNotebookServiceServer) DeleteRuntime(context.Context, *DeleteRuntimeRequest) (*longrunning.Operation, error)
func (*UnimplementedManagedNotebookServiceServer) GetRuntime
func (*UnimplementedManagedNotebookServiceServer) GetRuntime(context.Context, *GetRuntimeRequest) (*Runtime, error)
func (*UnimplementedManagedNotebookServiceServer) ListRuntimes
func (*UnimplementedManagedNotebookServiceServer) ListRuntimes(context.Context, *ListRuntimesRequest) (*ListRuntimesResponse, error)
func (*UnimplementedManagedNotebookServiceServer) RefreshRuntimeTokenInternal
func (*UnimplementedManagedNotebookServiceServer) RefreshRuntimeTokenInternal(context.Context, *RefreshRuntimeTokenInternalRequest) (*RefreshRuntimeTokenInternalResponse, error)
func (*UnimplementedManagedNotebookServiceServer) ReportRuntimeEvent
func (*UnimplementedManagedNotebookServiceServer) ReportRuntimeEvent(context.Context, *ReportRuntimeEventRequest) (*longrunning.Operation, error)
func (*UnimplementedManagedNotebookServiceServer) ResetRuntime
func (*UnimplementedManagedNotebookServiceServer) ResetRuntime(context.Context, *ResetRuntimeRequest) (*longrunning.Operation, error)
func (*UnimplementedManagedNotebookServiceServer) StartRuntime
func (*UnimplementedManagedNotebookServiceServer) StartRuntime(context.Context, *StartRuntimeRequest) (*longrunning.Operation, error)
func (*UnimplementedManagedNotebookServiceServer) StopRuntime
func (*UnimplementedManagedNotebookServiceServer) StopRuntime(context.Context, *StopRuntimeRequest) (*longrunning.Operation, error)
func (*UnimplementedManagedNotebookServiceServer) SwitchRuntime
func (*UnimplementedManagedNotebookServiceServer) SwitchRuntime(context.Context, *SwitchRuntimeRequest) (*longrunning.Operation, error)
UnimplementedNotebookServiceServer
type UnimplementedNotebookServiceServer struct {
}
UnimplementedNotebookServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedNotebookServiceServer) CreateEnvironment
func (*UnimplementedNotebookServiceServer) CreateEnvironment(context.Context, *CreateEnvironmentRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) CreateExecution
func (*UnimplementedNotebookServiceServer) CreateExecution(context.Context, *CreateExecutionRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) CreateInstance
func (*UnimplementedNotebookServiceServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) CreateSchedule
func (*UnimplementedNotebookServiceServer) CreateSchedule(context.Context, *CreateScheduleRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) DeleteEnvironment
func (*UnimplementedNotebookServiceServer) DeleteEnvironment(context.Context, *DeleteEnvironmentRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) DeleteExecution
func (*UnimplementedNotebookServiceServer) DeleteExecution(context.Context, *DeleteExecutionRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) DeleteInstance
func (*UnimplementedNotebookServiceServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) DeleteSchedule
func (*UnimplementedNotebookServiceServer) DeleteSchedule(context.Context, *DeleteScheduleRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) GetEnvironment
func (*UnimplementedNotebookServiceServer) GetEnvironment(context.Context, *GetEnvironmentRequest) (*Environment, error)
func (*UnimplementedNotebookServiceServer) GetExecution
func (*UnimplementedNotebookServiceServer) GetExecution(context.Context, *GetExecutionRequest) (*Execution, error)
func (*UnimplementedNotebookServiceServer) GetInstance
func (*UnimplementedNotebookServiceServer) GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
func (*UnimplementedNotebookServiceServer) GetInstanceHealth
func (*UnimplementedNotebookServiceServer) GetInstanceHealth(context.Context, *GetInstanceHealthRequest) (*GetInstanceHealthResponse, error)
func (*UnimplementedNotebookServiceServer) GetSchedule
func (*UnimplementedNotebookServiceServer) GetSchedule(context.Context, *GetScheduleRequest) (*Schedule, error)
func (*UnimplementedNotebookServiceServer) IsInstanceUpgradeable
func (*UnimplementedNotebookServiceServer) IsInstanceUpgradeable(context.Context, *IsInstanceUpgradeableRequest) (*IsInstanceUpgradeableResponse, error)
func (*UnimplementedNotebookServiceServer) ListEnvironments
func (*UnimplementedNotebookServiceServer) ListEnvironments(context.Context, *ListEnvironmentsRequest) (*ListEnvironmentsResponse, error)
func (*UnimplementedNotebookServiceServer) ListExecutions
func (*UnimplementedNotebookServiceServer) ListExecutions(context.Context, *ListExecutionsRequest) (*ListExecutionsResponse, error)
func (*UnimplementedNotebookServiceServer) ListInstances
func (*UnimplementedNotebookServiceServer) ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
func (*UnimplementedNotebookServiceServer) ListSchedules
func (*UnimplementedNotebookServiceServer) ListSchedules(context.Context, *ListSchedulesRequest) (*ListSchedulesResponse, error)
func (*UnimplementedNotebookServiceServer) RegisterInstance
func (*UnimplementedNotebookServiceServer) RegisterInstance(context.Context, *RegisterInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) ReportInstanceInfo
func (*UnimplementedNotebookServiceServer) ReportInstanceInfo(context.Context, *ReportInstanceInfoRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) ResetInstance
func (*UnimplementedNotebookServiceServer) ResetInstance(context.Context, *ResetInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) RollbackInstance
func (*UnimplementedNotebookServiceServer) RollbackInstance(context.Context, *RollbackInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) SetInstanceAccelerator
func (*UnimplementedNotebookServiceServer) SetInstanceAccelerator(context.Context, *SetInstanceAcceleratorRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) SetInstanceLabels
func (*UnimplementedNotebookServiceServer) SetInstanceLabels(context.Context, *SetInstanceLabelsRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) SetInstanceMachineType
func (*UnimplementedNotebookServiceServer) SetInstanceMachineType(context.Context, *SetInstanceMachineTypeRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) StartInstance
func (*UnimplementedNotebookServiceServer) StartInstance(context.Context, *StartInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) StopInstance
func (*UnimplementedNotebookServiceServer) StopInstance(context.Context, *StopInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) TriggerSchedule
func (*UnimplementedNotebookServiceServer) TriggerSchedule(context.Context, *TriggerScheduleRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) UpdateInstanceConfig
func (*UnimplementedNotebookServiceServer) UpdateInstanceConfig(context.Context, *UpdateInstanceConfigRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) UpdateInstanceMetadataItems
func (*UnimplementedNotebookServiceServer) UpdateInstanceMetadataItems(context.Context, *UpdateInstanceMetadataItemsRequest) (*UpdateInstanceMetadataItemsResponse, error)
func (*UnimplementedNotebookServiceServer) UpdateShieldedInstanceConfig
func (*UnimplementedNotebookServiceServer) UpdateShieldedInstanceConfig(context.Context, *UpdateShieldedInstanceConfigRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) UpgradeInstance
func (*UnimplementedNotebookServiceServer) UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunning.Operation, error)
func (*UnimplementedNotebookServiceServer) UpgradeInstanceInternal
func (*UnimplementedNotebookServiceServer) UpgradeInstanceInternal(context.Context, *UpgradeInstanceInternalRequest) (*longrunning.Operation, error)
UpdateInstanceConfigRequest
type UpdateInstanceConfigRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The instance configurations to be updated.
Config *InstanceConfig `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
// contains filtered or unexported fields
}
Request for updating instance configurations.
func (*UpdateInstanceConfigRequest) Descriptor
func (*UpdateInstanceConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateInstanceConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateInstanceConfigRequest) GetConfig
func (x *UpdateInstanceConfigRequest) GetConfig() *InstanceConfig
func (*UpdateInstanceConfigRequest) GetName
func (x *UpdateInstanceConfigRequest) GetName() string
func (*UpdateInstanceConfigRequest) ProtoMessage
func (*UpdateInstanceConfigRequest) ProtoMessage()
func (*UpdateInstanceConfigRequest) ProtoReflect
func (x *UpdateInstanceConfigRequest) ProtoReflect() protoreflect.Message
func (*UpdateInstanceConfigRequest) Reset
func (x *UpdateInstanceConfigRequest) Reset()
func (*UpdateInstanceConfigRequest) String
func (x *UpdateInstanceConfigRequest) String() string
UpdateInstanceMetadataItemsRequest
type UpdateInstanceMetadataItemsRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Items map[string]string "" /* 151 byte string literal not displayed */
}
Request for adding/changing metadata items for an instance.
func (*UpdateInstanceMetadataItemsRequest) Descriptor
func (*UpdateInstanceMetadataItemsRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateInstanceMetadataItemsRequest.ProtoReflect.Descriptor instead.
func (*UpdateInstanceMetadataItemsRequest) GetItems
func (x *UpdateInstanceMetadataItemsRequest) GetItems() map[string]string
func (*UpdateInstanceMetadataItemsRequest) GetName
func (x *UpdateInstanceMetadataItemsRequest) GetName() string
func (*UpdateInstanceMetadataItemsRequest) ProtoMessage
func (*UpdateInstanceMetadataItemsRequest) ProtoMessage()
func (*UpdateInstanceMetadataItemsRequest) ProtoReflect
func (x *UpdateInstanceMetadataItemsRequest) ProtoReflect() protoreflect.Message
func (*UpdateInstanceMetadataItemsRequest) Reset
func (x *UpdateInstanceMetadataItemsRequest) Reset()
func (*UpdateInstanceMetadataItemsRequest) String
func (x *UpdateInstanceMetadataItemsRequest) String() string
UpdateInstanceMetadataItemsResponse
type UpdateInstanceMetadataItemsResponse struct {
Items map[string]string "" /* 151 byte string literal not displayed */
}
Response for adding/changing metadata items for an instance.
func (*UpdateInstanceMetadataItemsResponse) Descriptor
func (*UpdateInstanceMetadataItemsResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateInstanceMetadataItemsResponse.ProtoReflect.Descriptor instead.
func (*UpdateInstanceMetadataItemsResponse) GetItems
func (x *UpdateInstanceMetadataItemsResponse) GetItems() map[string]string
func (*UpdateInstanceMetadataItemsResponse) ProtoMessage
func (*UpdateInstanceMetadataItemsResponse) ProtoMessage()
func (*UpdateInstanceMetadataItemsResponse) ProtoReflect
func (x *UpdateInstanceMetadataItemsResponse) ProtoReflect() protoreflect.Message
func (*UpdateInstanceMetadataItemsResponse) Reset
func (x *UpdateInstanceMetadataItemsResponse) Reset()
func (*UpdateInstanceMetadataItemsResponse) String
func (x *UpdateInstanceMetadataItemsResponse) String() string
UpdateShieldedInstanceConfigRequest
type UpdateShieldedInstanceConfigRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
ShieldedInstanceConfig *Instance_ShieldedInstanceConfig "" /* 129 byte string literal not displayed */
}
Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance
func (*UpdateShieldedInstanceConfigRequest) Descriptor
func (*UpdateShieldedInstanceConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateShieldedInstanceConfigRequest.ProtoReflect.Descriptor instead.
func (*UpdateShieldedInstanceConfigRequest) GetName
func (x *UpdateShieldedInstanceConfigRequest) GetName() string
func (*UpdateShieldedInstanceConfigRequest) GetShieldedInstanceConfig
func (x *UpdateShieldedInstanceConfigRequest) GetShieldedInstanceConfig() *Instance_ShieldedInstanceConfig
func (*UpdateShieldedInstanceConfigRequest) ProtoMessage
func (*UpdateShieldedInstanceConfigRequest) ProtoMessage()
func (*UpdateShieldedInstanceConfigRequest) ProtoReflect
func (x *UpdateShieldedInstanceConfigRequest) ProtoReflect() protoreflect.Message
func (*UpdateShieldedInstanceConfigRequest) Reset
func (x *UpdateShieldedInstanceConfigRequest) Reset()
func (*UpdateShieldedInstanceConfigRequest) String
func (x *UpdateShieldedInstanceConfigRequest) String() string
UpgradeInstanceInternalRequest
type UpgradeInstanceInternalRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The VM hardware token for authenticating the VM.
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
// Optional. The optional UpgradeType. Setting this field will search for additional
// compute images to upgrade this instance.
Type UpgradeType `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.notebooks.v1.UpgradeType" json:"type,omitempty"`
// contains filtered or unexported fields
}
Request for upgrading a notebook instance from within the VM
func (*UpgradeInstanceInternalRequest) Descriptor
func (*UpgradeInstanceInternalRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpgradeInstanceInternalRequest.ProtoReflect.Descriptor instead.
func (*UpgradeInstanceInternalRequest) GetName
func (x *UpgradeInstanceInternalRequest) GetName() string
func (*UpgradeInstanceInternalRequest) GetType
func (x *UpgradeInstanceInternalRequest) GetType() UpgradeType
func (*UpgradeInstanceInternalRequest) GetVmId
func (x *UpgradeInstanceInternalRequest) GetVmId() string
func (*UpgradeInstanceInternalRequest) ProtoMessage
func (*UpgradeInstanceInternalRequest) ProtoMessage()
func (*UpgradeInstanceInternalRequest) ProtoReflect
func (x *UpgradeInstanceInternalRequest) ProtoReflect() protoreflect.Message
func (*UpgradeInstanceInternalRequest) Reset
func (x *UpgradeInstanceInternalRequest) Reset()
func (*UpgradeInstanceInternalRequest) String
func (x *UpgradeInstanceInternalRequest) String() string
UpgradeInstanceRequest
type UpgradeInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The optional UpgradeType. Setting this field will search for additional
// compute images to upgrade this instance.
Type UpgradeType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1.UpgradeType" json:"type,omitempty"`
// contains filtered or unexported fields
}
Request for upgrading a notebook instance
func (*UpgradeInstanceRequest) Descriptor
func (*UpgradeInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpgradeInstanceRequest.ProtoReflect.Descriptor instead.
func (*UpgradeInstanceRequest) GetName
func (x *UpgradeInstanceRequest) GetName() string
func (*UpgradeInstanceRequest) GetType
func (x *UpgradeInstanceRequest) GetType() UpgradeType
func (*UpgradeInstanceRequest) ProtoMessage
func (*UpgradeInstanceRequest) ProtoMessage()
func (*UpgradeInstanceRequest) ProtoReflect
func (x *UpgradeInstanceRequest) ProtoReflect() protoreflect.Message
func (*UpgradeInstanceRequest) Reset
func (x *UpgradeInstanceRequest) Reset()
func (*UpgradeInstanceRequest) String
func (x *UpgradeInstanceRequest) String() string
UpgradeType
type UpgradeType int32
Definition of the types of upgrade that can be used on this instance.
UpgradeType_UPGRADE_TYPE_UNSPECIFIED, UpgradeType_UPGRADE_FRAMEWORK, UpgradeType_UPGRADE_OS, UpgradeType_UPGRADE_CUDA, UpgradeType_UPGRADE_ALL
const (
// Upgrade type is not specified.
UpgradeType_UPGRADE_TYPE_UNSPECIFIED UpgradeType = 0
// Upgrade ML framework.
UpgradeType_UPGRADE_FRAMEWORK UpgradeType = 1
// Upgrade Operating System.
UpgradeType_UPGRADE_OS UpgradeType = 2
// Upgrade CUDA.
UpgradeType_UPGRADE_CUDA UpgradeType = 3
// Upgrade All (OS, Framework and CUDA).
UpgradeType_UPGRADE_ALL UpgradeType = 4
)
func (UpgradeType) Descriptor
func (UpgradeType) Descriptor() protoreflect.EnumDescriptor
func (UpgradeType) Enum
func (x UpgradeType) Enum() *UpgradeType
func (UpgradeType) EnumDescriptor
func (UpgradeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use UpgradeType.Descriptor instead.
func (UpgradeType) Number
func (x UpgradeType) Number() protoreflect.EnumNumber
func (UpgradeType) String
func (x UpgradeType) String() string
func (UpgradeType) Type
func (UpgradeType) Type() protoreflect.EnumType
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) Descriptor
func (*VirtualMachine) Descriptor() ([]byte, []int)
Deprecated: Use VirtualMachine.ProtoReflect.Descriptor instead.
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) ProtoMessage
func (*VirtualMachine) ProtoMessage()
func (*VirtualMachine) ProtoReflect
func (x *VirtualMachine) ProtoReflect() protoreflect.Message
func (*VirtualMachine) Reset
func (x *VirtualMachine) Reset()
func (*VirtualMachine) String
func (x *VirtualMachine) String() string
VirtualMachineConfig
type VirtualMachineConfig struct {
Zone string `protobuf:"bytes,1,opt,name=zone,proto3" json:"zone,omitempty"`
MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
ContainerImages []*ContainerImage `protobuf:"bytes,3,rep,name=container_images,json=containerImages,proto3" json:"container_images,omitempty"`
DataDisk *LocalDisk `protobuf:"bytes,4,opt,name=data_disk,json=dataDisk,proto3" json:"data_disk,omitempty"`
EncryptionConfig *EncryptionConfig `protobuf:"bytes,5,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
ShieldedInstanceConfig *RuntimeShieldedInstanceConfig "" /* 129 byte string literal not displayed */
AcceleratorConfig *RuntimeAcceleratorConfig `protobuf:"bytes,7,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
Network string `protobuf:"bytes,8,opt,name=network,proto3" json:"network,omitempty"`
Subnet string `protobuf:"bytes,9,opt,name=subnet,proto3" json:"subnet,omitempty"`
InternalIpOnly bool `protobuf:"varint,10,opt,name=internal_ip_only,json=internalIpOnly,proto3" json:"internal_ip_only,omitempty"`
Tags []string `protobuf:"bytes,13,rep,name=tags,proto3" json:"tags,omitempty"`
GuestAttributes map[string]string "" /* 195 byte string literal not displayed */
Metadata map[string]string "" /* 158 byte string literal not displayed */
Labels map[string]string "" /* 154 byte string literal not displayed */
NicType VirtualMachineConfig_NicType "" /* 144 byte string literal not displayed */
ReservedIpRange string `protobuf:"bytes,18,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_ip_range,omitempty"`
BootImage *VirtualMachineConfig_BootImage `protobuf:"bytes,19,opt,name=boot_image,json=bootImage,proto3" json:"boot_image,omitempty"`
}
The config settings for virtual machine.
func (*VirtualMachineConfig) Descriptor
func (*VirtualMachineConfig) Descriptor() ([]byte, []int)
Deprecated: Use VirtualMachineConfig.ProtoReflect.Descriptor instead.
func (*VirtualMachineConfig) GetAcceleratorConfig
func (x *VirtualMachineConfig) GetAcceleratorConfig() *RuntimeAcceleratorConfig
func (*VirtualMachineConfig) GetBootImage
func (x *VirtualMachineConfig) GetBootImage() *VirtualMachineConfig_BootImage
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 (x *VirtualMachineConfig) GetNicType() VirtualMachineConfig_NicType
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) ProtoMessage
func (*VirtualMachineConfig) ProtoMessage()
func (*VirtualMachineConfig) ProtoReflect
func (x *VirtualMachineConfig) ProtoReflect() protoreflect.Message
func (*VirtualMachineConfig) Reset
func (x *VirtualMachineConfig) Reset()
func (*VirtualMachineConfig) String
func (x *VirtualMachineConfig) String() string
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) Descriptor
func (*VirtualMachineConfig_BootImage) Descriptor() ([]byte, []int)
Deprecated: Use VirtualMachineConfig_BootImage.ProtoReflect.Descriptor instead.
func (*VirtualMachineConfig_BootImage) ProtoMessage
func (*VirtualMachineConfig_BootImage) ProtoMessage()
func (*VirtualMachineConfig_BootImage) ProtoReflect
func (x *VirtualMachineConfig_BootImage) ProtoReflect() protoreflect.Message
func (*VirtualMachineConfig_BootImage) Reset
func (x *VirtualMachineConfig_BootImage) Reset()
func (*VirtualMachineConfig_BootImage) String
func (x *VirtualMachineConfig_BootImage) String() string
VirtualMachineConfig_NicType
type VirtualMachineConfig_NicType int32
The type of vNIC driver. Default should be UNSPECIFIED_NIC_TYPE.
VirtualMachineConfig_UNSPECIFIED_NIC_TYPE, VirtualMachineConfig_VIRTIO_NET, VirtualMachineConfig_GVNIC
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) Descriptor() protoreflect.EnumDescriptor
func (VirtualMachineConfig_NicType) Enum
func (x VirtualMachineConfig_NicType) Enum() *VirtualMachineConfig_NicType
func (VirtualMachineConfig_NicType) EnumDescriptor
func (VirtualMachineConfig_NicType) EnumDescriptor() ([]byte, []int)
Deprecated: Use VirtualMachineConfig_NicType.Descriptor instead.
func (VirtualMachineConfig_NicType) Number
func (x VirtualMachineConfig_NicType) Number() protoreflect.EnumNumber
func (VirtualMachineConfig_NicType) String
func (x VirtualMachineConfig_NicType) String() string
func (VirtualMachineConfig_NicType) Type
func (VirtualMachineConfig_NicType) Type() protoreflect.EnumType
VmImage
type VmImage struct {
// Required. The name of the Google Cloud project that this VM image belongs to.
// Format: `{project_id}`
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// The reference to an external Compute Engine VM image.
//
// Types that are assignable to Image:
//
// *VmImage_ImageName
// *VmImage_ImageFamily
Image isVmImage_Image `protobuf_oneof:"image"`
// contains filtered or unexported fields
}
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
func (*VmImage) Descriptor
Deprecated: Use VmImage.ProtoReflect.Descriptor instead.
func (*VmImage) GetImage
func (m *VmImage) GetImage() isVmImage_Image
func (*VmImage) GetImageFamily
func (*VmImage) GetImageName
func (*VmImage) GetProject
func (*VmImage) ProtoMessage
func (*VmImage) ProtoMessage()
func (*VmImage) ProtoReflect
func (x *VmImage) ProtoReflect() protoreflect.Message
func (*VmImage) Reset
func (x *VmImage) Reset()
func (*VmImage) String
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"`
}
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"`
}