Constants
ManagedNotebookService_ListRuntimes_FullMethodName, ManagedNotebookService_GetRuntime_FullMethodName, ManagedNotebookService_CreateRuntime_FullMethodName, ManagedNotebookService_UpdateRuntime_FullMethodName, ManagedNotebookService_DeleteRuntime_FullMethodName, ManagedNotebookService_StartRuntime_FullMethodName, ManagedNotebookService_StopRuntime_FullMethodName, ManagedNotebookService_SwitchRuntime_FullMethodName, ManagedNotebookService_ResetRuntime_FullMethodName, ManagedNotebookService_UpgradeRuntime_FullMethodName, ManagedNotebookService_ReportRuntimeEvent_FullMethodName, ManagedNotebookService_RefreshRuntimeTokenInternal_FullMethodName, ManagedNotebookService_DiagnoseRuntime_FullMethodName
const (
ManagedNotebookService_ListRuntimes_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/ListRuntimes"
ManagedNotebookService_GetRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/GetRuntime"
ManagedNotebookService_CreateRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/CreateRuntime"
ManagedNotebookService_UpdateRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/UpdateRuntime"
ManagedNotebookService_DeleteRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/DeleteRuntime"
ManagedNotebookService_StartRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/StartRuntime"
ManagedNotebookService_StopRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/StopRuntime"
ManagedNotebookService_SwitchRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/SwitchRuntime"
ManagedNotebookService_ResetRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/ResetRuntime"
ManagedNotebookService_UpgradeRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/UpgradeRuntime"
ManagedNotebookService_ReportRuntimeEvent_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/ReportRuntimeEvent"
ManagedNotebookService_RefreshRuntimeTokenInternal_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/RefreshRuntimeTokenInternal"
ManagedNotebookService_DiagnoseRuntime_FullMethodName = "/google.cloud.notebooks.v1.ManagedNotebookService/DiagnoseRuntime"
)NotebookService_ListInstances_FullMethodName, NotebookService_GetInstance_FullMethodName, NotebookService_CreateInstance_FullMethodName, NotebookService_RegisterInstance_FullMethodName, NotebookService_SetInstanceAccelerator_FullMethodName, NotebookService_SetInstanceMachineType_FullMethodName, NotebookService_UpdateInstanceConfig_FullMethodName, NotebookService_UpdateShieldedInstanceConfig_FullMethodName, NotebookService_SetInstanceLabels_FullMethodName, NotebookService_UpdateInstanceMetadataItems_FullMethodName, NotebookService_DeleteInstance_FullMethodName, NotebookService_StartInstance_FullMethodName, NotebookService_StopInstance_FullMethodName, NotebookService_ResetInstance_FullMethodName, NotebookService_ReportInstanceInfo_FullMethodName, NotebookService_IsInstanceUpgradeable_FullMethodName, NotebookService_GetInstanceHealth_FullMethodName, NotebookService_UpgradeInstance_FullMethodName, NotebookService_RollbackInstance_FullMethodName, NotebookService_DiagnoseInstance_FullMethodName, NotebookService_UpgradeInstanceInternal_FullMethodName, NotebookService_ListEnvironments_FullMethodName, NotebookService_GetEnvironment_FullMethodName, NotebookService_CreateEnvironment_FullMethodName, NotebookService_DeleteEnvironment_FullMethodName, NotebookService_ListSchedules_FullMethodName, NotebookService_GetSchedule_FullMethodName, NotebookService_DeleteSchedule_FullMethodName, NotebookService_CreateSchedule_FullMethodName, NotebookService_TriggerSchedule_FullMethodName, NotebookService_ListExecutions_FullMethodName, NotebookService_GetExecution_FullMethodName, NotebookService_DeleteExecution_FullMethodName, NotebookService_CreateExecution_FullMethodName
const (
NotebookService_ListInstances_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/ListInstances"
NotebookService_GetInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/GetInstance"
NotebookService_CreateInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/CreateInstance"
NotebookService_RegisterInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/RegisterInstance"
NotebookService_SetInstanceAccelerator_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/SetInstanceAccelerator"
NotebookService_SetInstanceMachineType_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/SetInstanceMachineType"
NotebookService_UpdateInstanceConfig_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/UpdateInstanceConfig"
NotebookService_UpdateShieldedInstanceConfig_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/UpdateShieldedInstanceConfig"
NotebookService_SetInstanceLabels_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/SetInstanceLabels"
NotebookService_UpdateInstanceMetadataItems_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/UpdateInstanceMetadataItems"
NotebookService_DeleteInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/DeleteInstance"
NotebookService_StartInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/StartInstance"
NotebookService_StopInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/StopInstance"
NotebookService_ResetInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/ResetInstance"
NotebookService_ReportInstanceInfo_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/ReportInstanceInfo"
NotebookService_IsInstanceUpgradeable_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/IsInstanceUpgradeable"
NotebookService_GetInstanceHealth_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/GetInstanceHealth"
NotebookService_UpgradeInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/UpgradeInstance"
NotebookService_RollbackInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/RollbackInstance"
NotebookService_DiagnoseInstance_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/DiagnoseInstance"
NotebookService_UpgradeInstanceInternal_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/UpgradeInstanceInternal"
NotebookService_ListEnvironments_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/ListEnvironments"
NotebookService_GetEnvironment_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/GetEnvironment"
NotebookService_CreateEnvironment_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/CreateEnvironment"
NotebookService_DeleteEnvironment_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/DeleteEnvironment"
NotebookService_ListSchedules_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/ListSchedules"
NotebookService_GetSchedule_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/GetSchedule"
NotebookService_DeleteSchedule_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/DeleteSchedule"
NotebookService_CreateSchedule_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/CreateSchedule"
NotebookService_TriggerSchedule_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/TriggerSchedule"
NotebookService_ListExecutions_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/ListExecutions"
NotebookService_GetExecution_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/GetExecution"
NotebookService_DeleteExecution_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/DeleteExecution"
NotebookService_CreateExecution_FullMethodName = "/google.cloud.notebooks.v1.NotebookService/CreateExecution"
)Variables
Event_EventType_name, Event_EventType_value
var (
Event_EventType_name = map[int32]string{
0: "EVENT_TYPE_UNSPECIFIED",
1: "IDLE",
2: "HEARTBEAT",
3: "HEALTH",
4: "MAINTENANCE",
}
Event_EventType_value = map[string]int32{
"EVENT_TYPE_UNSPECIFIED": 0,
"IDLE": 1,
"HEARTBEAT": 2,
"HEALTH": 3,
"MAINTENANCE": 4,
}
)Enum value maps for Event_EventType.
ExecutionTemplate_ScaleTier_name, ExecutionTemplate_ScaleTier_value
var (
ExecutionTemplate_ScaleTier_name = map[int32]string{
0: "SCALE_TIER_UNSPECIFIED",
1: "BASIC",
2: "STANDARD_1",
3: "PREMIUM_1",
4: "BASIC_GPU",
5: "BASIC_TPU",
6: "CUSTOM",
}
ExecutionTemplate_ScaleTier_value = map[string]int32{
"SCALE_TIER_UNSPECIFIED": 0,
"BASIC": 1,
"STANDARD_1": 2,
"PREMIUM_1": 3,
"BASIC_GPU": 4,
"BASIC_TPU": 5,
"CUSTOM": 6,
}
)Enum value maps for ExecutionTemplate_ScaleTier.
ExecutionTemplate_SchedulerAcceleratorType_name, ExecutionTemplate_SchedulerAcceleratorType_value
var (
ExecutionTemplate_SchedulerAcceleratorType_name = map[int32]string{
0: "SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED",
1: "NVIDIA_TESLA_K80",
2: "NVIDIA_TESLA_P100",
3: "NVIDIA_TESLA_V100",
4: "NVIDIA_TESLA_P4",
5: "NVIDIA_TESLA_T4",
10: "NVIDIA_TESLA_A100",
6: "TPU_V2",
7: "TPU_V3",
}
ExecutionTemplate_SchedulerAcceleratorType_value = map[string]int32{
"SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED": 0,
"NVIDIA_TESLA_K80": 1,
"NVIDIA_TESLA_P100": 2,
"NVIDIA_TESLA_V100": 3,
"NVIDIA_TESLA_P4": 4,
"NVIDIA_TESLA_T4": 5,
"NVIDIA_TESLA_A100": 10,
"TPU_V2": 6,
"TPU_V3": 7,
}
)Enum value maps for ExecutionTemplate_SchedulerAcceleratorType.
ExecutionTemplate_JobType_name, ExecutionTemplate_JobType_value
var (
ExecutionTemplate_JobType_name = map[int32]string{
0: "JOB_TYPE_UNSPECIFIED",
1: "VERTEX_AI",
2: "DATAPROC",
}
ExecutionTemplate_JobType_value = map[string]int32{
"JOB_TYPE_UNSPECIFIED": 0,
"VERTEX_AI": 1,
"DATAPROC": 2,
}
)Enum value maps for ExecutionTemplate_JobType.
Execution_State_name, Execution_State_value
var (
Execution_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "QUEUED",
2: "PREPARING",
3: "RUNNING",
4: "SUCCEEDED",
5: "FAILED",
6: "CANCELLING",
7: "CANCELLED",
9: "EXPIRED",
10: "INITIALIZING",
}
Execution_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"QUEUED": 1,
"PREPARING": 2,
"RUNNING": 3,
"SUCCEEDED": 4,
"FAILED": 5,
"CANCELLING": 6,
"CANCELLED": 7,
"EXPIRED": 9,
"INITIALIZING": 10,
}
)Enum value maps for Execution_State.
ReservationAffinity_Type_name, ReservationAffinity_Type_value
var (
ReservationAffinity_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "NO_RESERVATION",
2: "ANY_RESERVATION",
3: "SPECIFIC_RESERVATION",
}
ReservationAffinity_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"NO_RESERVATION": 1,
"ANY_RESERVATION": 2,
"SPECIFIC_RESERVATION": 3,
}
)Enum value maps for ReservationAffinity_Type.
Instance_AcceleratorType_name, Instance_AcceleratorType_value
var (
Instance_AcceleratorType_name = map[int32]string{
0: "ACCELERATOR_TYPE_UNSPECIFIED",
1: "NVIDIA_TESLA_K80",
2: "NVIDIA_TESLA_P100",
3: "NVIDIA_TESLA_V100",
4: "NVIDIA_TESLA_P4",
5: "NVIDIA_TESLA_T4",
11: "NVIDIA_TESLA_A100",
8: "NVIDIA_TESLA_T4_VWS",
9: "NVIDIA_TESLA_P100_VWS",
10: "NVIDIA_TESLA_P4_VWS",
6: "TPU_V2",
7: "TPU_V3",
}
Instance_AcceleratorType_value = map[string]int32{
"ACCELERATOR_TYPE_UNSPECIFIED": 0,
"NVIDIA_TESLA_K80": 1,
"NVIDIA_TESLA_P100": 2,
"NVIDIA_TESLA_V100": 3,
"NVIDIA_TESLA_P4": 4,
"NVIDIA_TESLA_T4": 5,
"NVIDIA_TESLA_A100": 11,
"NVIDIA_TESLA_T4_VWS": 8,
"NVIDIA_TESLA_P100_VWS": 9,
"NVIDIA_TESLA_P4_VWS": 10,
"TPU_V2": 6,
"TPU_V3": 7,
}
)Enum value maps for Instance_AcceleratorType.
Instance_State_name, Instance_State_value
var (
Instance_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "STARTING",
2: "PROVISIONING",
3: "ACTIVE",
4: "STOPPING",
5: "STOPPED",
6: "DELETED",
7: "UPGRADING",
8: "INITIALIZING",
9: "REGISTERING",
10: "SUSPENDING",
11: "SUSPENDED",
}
Instance_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTING": 1,
"PROVISIONING": 2,
"ACTIVE": 3,
"STOPPING": 4,
"STOPPED": 5,
"DELETED": 6,
"UPGRADING": 7,
"INITIALIZING": 8,
"REGISTERING": 9,
"SUSPENDING": 10,
"SUSPENDED": 11,
}
)Enum value maps for Instance_State.
Instance_DiskType_name, Instance_DiskType_value
var (
Instance_DiskType_name = map[int32]string{
0: "DISK_TYPE_UNSPECIFIED",
1: "PD_STANDARD",
2: "PD_SSD",
3: "PD_BALANCED",
4: "PD_EXTREME",
}
Instance_DiskType_value = map[string]int32{
"DISK_TYPE_UNSPECIFIED": 0,
"PD_STANDARD": 1,
"PD_SSD": 2,
"PD_BALANCED": 3,
"PD_EXTREME": 4,
}
)Enum value maps for Instance_DiskType.
Instance_DiskEncryption_name, Instance_DiskEncryption_value
var (
Instance_DiskEncryption_name = map[int32]string{
0: "DISK_ENCRYPTION_UNSPECIFIED",
1: "GMEK",
2: "CMEK",
}
Instance_DiskEncryption_value = map[string]int32{
"DISK_ENCRYPTION_UNSPECIFIED": 0,
"GMEK": 1,
"CMEK": 2,
}
)Enum value maps for Instance_DiskEncryption.
Instance_NicType_name, Instance_NicType_value
var (
Instance_NicType_name = map[int32]string{
0: "UNSPECIFIED_NIC_TYPE",
1: "VIRTIO_NET",
2: "GVNIC",
}
Instance_NicType_value = map[string]int32{
"UNSPECIFIED_NIC_TYPE": 0,
"VIRTIO_NET": 1,
"GVNIC": 2,
}
)Enum value maps for Instance_NicType.
Instance_UpgradeHistoryEntry_State_name, Instance_UpgradeHistoryEntry_State_value
var (
Instance_UpgradeHistoryEntry_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "STARTED",
2: "SUCCEEDED",
3: "FAILED",
}
Instance_UpgradeHistoryEntry_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTED": 1,
"SUCCEEDED": 2,
"FAILED": 3,
}
)Enum value maps for Instance_UpgradeHistoryEntry_State.
Instance_UpgradeHistoryEntry_Action_name, Instance_UpgradeHistoryEntry_Action_value
var (
Instance_UpgradeHistoryEntry_Action_name = map[int32]string{
0: "ACTION_UNSPECIFIED",
1: "UPGRADE",
2: "ROLLBACK",
}
Instance_UpgradeHistoryEntry_Action_value = map[string]int32{
"ACTION_UNSPECIFIED": 0,
"UPGRADE": 1,
"ROLLBACK": 2,
}
)Enum value maps for Instance_UpgradeHistoryEntry_Action.
Runtime_State_name, Runtime_State_value
var (
Runtime_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "STARTING",
2: "PROVISIONING",
3: "ACTIVE",
4: "STOPPING",
5: "STOPPED",
6: "DELETING",
7: "UPGRADING",
8: "INITIALIZING",
}
Runtime_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTING": 1,
"PROVISIONING": 2,
"ACTIVE": 3,
"STOPPING": 4,
"STOPPED": 5,
"DELETING": 6,
"UPGRADING": 7,
"INITIALIZING": 8,
}
)Enum value maps for Runtime_State.
Runtime_HealthState_name, Runtime_HealthState_value
var (
Runtime_HealthState_name = map[int32]string{
0: "HEALTH_STATE_UNSPECIFIED",
1: "HEALTHY",
2: "UNHEALTHY",
3: "AGENT_NOT_INSTALLED",
4: "AGENT_NOT_RUNNING",
}
Runtime_HealthState_value = map[string]int32{
"HEALTH_STATE_UNSPECIFIED": 0,
"HEALTHY": 1,
"UNHEALTHY": 2,
"AGENT_NOT_INSTALLED": 3,
"AGENT_NOT_RUNNING": 4,
}
)Enum value maps for Runtime_HealthState.
RuntimeAcceleratorConfig_AcceleratorType_name, RuntimeAcceleratorConfig_AcceleratorType_value
var (
RuntimeAcceleratorConfig_AcceleratorType_name = map[int32]string{
0: "ACCELERATOR_TYPE_UNSPECIFIED",
1: "NVIDIA_TESLA_K80",
2: "NVIDIA_TESLA_P100",
3: "NVIDIA_TESLA_V100",
4: "NVIDIA_TESLA_P4",
5: "NVIDIA_TESLA_T4",
6: "NVIDIA_TESLA_A100",
7: "TPU_V2",
8: "TPU_V3",
9: "NVIDIA_TESLA_T4_VWS",
10: "NVIDIA_TESLA_P100_VWS",
11: "NVIDIA_TESLA_P4_VWS",
}
RuntimeAcceleratorConfig_AcceleratorType_value = map[string]int32{
"ACCELERATOR_TYPE_UNSPECIFIED": 0,
"NVIDIA_TESLA_K80": 1,
"NVIDIA_TESLA_P100": 2,
"NVIDIA_TESLA_V100": 3,
"NVIDIA_TESLA_P4": 4,
"NVIDIA_TESLA_T4": 5,
"NVIDIA_TESLA_A100": 6,
"TPU_V2": 7,
"TPU_V3": 8,
"NVIDIA_TESLA_T4_VWS": 9,
"NVIDIA_TESLA_P100_VWS": 10,
"NVIDIA_TESLA_P4_VWS": 11,
}
)Enum value maps for RuntimeAcceleratorConfig_AcceleratorType.
LocalDiskInitializeParams_DiskType_name, LocalDiskInitializeParams_DiskType_value
var (
LocalDiskInitializeParams_DiskType_name = map[int32]string{
0: "DISK_TYPE_UNSPECIFIED",
1: "PD_STANDARD",
2: "PD_SSD",
3: "PD_BALANCED",
4: "PD_EXTREME",
}
LocalDiskInitializeParams_DiskType_value = map[string]int32{
"DISK_TYPE_UNSPECIFIED": 0,
"PD_STANDARD": 1,
"PD_SSD": 2,
"PD_BALANCED": 3,
"PD_EXTREME": 4,
}
)Enum value maps for LocalDiskInitializeParams_DiskType.
RuntimeAccessConfig_RuntimeAccessType_name, RuntimeAccessConfig_RuntimeAccessType_value
var (
RuntimeAccessConfig_RuntimeAccessType_name = map[int32]string{
0: "RUNTIME_ACCESS_TYPE_UNSPECIFIED",
1: "SINGLE_USER",
2: "SERVICE_ACCOUNT",
}
RuntimeAccessConfig_RuntimeAccessType_value = map[string]int32{
"RUNTIME_ACCESS_TYPE_UNSPECIFIED": 0,
"SINGLE_USER": 1,
"SERVICE_ACCOUNT": 2,
}
)Enum value maps for RuntimeAccessConfig_RuntimeAccessType.
RuntimeSoftwareConfig_PostStartupScriptBehavior_name, RuntimeSoftwareConfig_PostStartupScriptBehavior_value
var (
RuntimeSoftwareConfig_PostStartupScriptBehavior_name = map[int32]string{
0: "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED",
1: "RUN_EVERY_START",
2: "DOWNLOAD_AND_RUN_EVERY_START",
}
RuntimeSoftwareConfig_PostStartupScriptBehavior_value = map[string]int32{
"POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED": 0,
"RUN_EVERY_START": 1,
"DOWNLOAD_AND_RUN_EVERY_START": 2,
}
)Enum value maps for RuntimeSoftwareConfig_PostStartupScriptBehavior.
VirtualMachineConfig_NicType_name, VirtualMachineConfig_NicType_value
var (
VirtualMachineConfig_NicType_name = map[int32]string{
0: "UNSPECIFIED_NIC_TYPE",
1: "VIRTIO_NET",
2: "GVNIC",
}
VirtualMachineConfig_NicType_value = map[string]int32{
"UNSPECIFIED_NIC_TYPE": 0,
"VIRTIO_NET": 1,
"GVNIC": 2,
}
)Enum value maps for VirtualMachineConfig_NicType.
Schedule_State_name, Schedule_State_value
var (
Schedule_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ENABLED",
2: "PAUSED",
3: "DISABLED",
4: "UPDATE_FAILED",
5: "INITIALIZING",
6: "DELETING",
}
Schedule_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ENABLED": 1,
"PAUSED": 2,
"DISABLED": 3,
"UPDATE_FAILED": 4,
"INITIALIZING": 5,
"DELETING": 6,
}
)Enum value maps for Schedule_State.
UpgradeType_name, UpgradeType_value
var (
UpgradeType_name = map[int32]string{
0: "UPGRADE_TYPE_UNSPECIFIED",
1: "UPGRADE_FRAMEWORK",
2: "UPGRADE_OS",
3: "UPGRADE_CUDA",
4: "UPGRADE_ALL",
}
UpgradeType_value = map[string]int32{
"UPGRADE_TYPE_UNSPECIFIED": 0,
"UPGRADE_FRAMEWORK": 1,
"UPGRADE_OS": 2,
"UPGRADE_CUDA": 3,
"UPGRADE_ALL": 4,
}
)Enum value maps for UpgradeType.
GetInstanceHealthResponse_HealthState_name, GetInstanceHealthResponse_HealthState_value
var (
GetInstanceHealthResponse_HealthState_name = map[int32]string{
0: "HEALTH_STATE_UNSPECIFIED",
1: "HEALTHY",
2: "UNHEALTHY",
3: "AGENT_NOT_INSTALLED",
4: "AGENT_NOT_RUNNING",
}
GetInstanceHealthResponse_HealthState_value = map[string]int32{
"HEALTH_STATE_UNSPECIFIED": 0,
"HEALTHY": 1,
"UNHEALTHY": 2,
"AGENT_NOT_INSTALLED": 3,
"AGENT_NOT_RUNNING": 4,
}
)Enum value maps for GetInstanceHealthResponse_HealthState.
File_google_cloud_notebooks_v1_diagnostic_config_proto
var File_google_cloud_notebooks_v1_diagnostic_config_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_environment_proto
var File_google_cloud_notebooks_v1_environment_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_event_proto
var File_google_cloud_notebooks_v1_event_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_execution_proto
var File_google_cloud_notebooks_v1_execution_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_instance_config_proto
var File_google_cloud_notebooks_v1_instance_config_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_instance_proto
var File_google_cloud_notebooks_v1_instance_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_managed_service_proto
var File_google_cloud_notebooks_v1_managed_service_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_runtime_proto
var File_google_cloud_notebooks_v1_runtime_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_schedule_proto
var File_google_cloud_notebooks_v1_schedule_proto protoreflect.FileDescriptorFile_google_cloud_notebooks_v1_service_proto
var File_google_cloud_notebooks_v1_service_proto protoreflect.FileDescriptorManagedNotebookService_ServiceDesc
var ManagedNotebookService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.notebooks.v1.ManagedNotebookService",
HandlerType: (*ManagedNotebookServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListRuntimes",
Handler: _ManagedNotebookService_ListRuntimes_Handler,
},
{
MethodName: "GetRuntime",
Handler: _ManagedNotebookService_GetRuntime_Handler,
},
{
MethodName: "CreateRuntime",
Handler: _ManagedNotebookService_CreateRuntime_Handler,
},
{
MethodName: "UpdateRuntime",
Handler: _ManagedNotebookService_UpdateRuntime_Handler,
},
{
MethodName: "DeleteRuntime",
Handler: _ManagedNotebookService_DeleteRuntime_Handler,
},
{
MethodName: "StartRuntime",
Handler: _ManagedNotebookService_StartRuntime_Handler,
},
{
MethodName: "StopRuntime",
Handler: _ManagedNotebookService_StopRuntime_Handler,
},
{
MethodName: "SwitchRuntime",
Handler: _ManagedNotebookService_SwitchRuntime_Handler,
},
{
MethodName: "ResetRuntime",
Handler: _ManagedNotebookService_ResetRuntime_Handler,
},
{
MethodName: "UpgradeRuntime",
Handler: _ManagedNotebookService_UpgradeRuntime_Handler,
},
{
MethodName: "ReportRuntimeEvent",
Handler: _ManagedNotebookService_ReportRuntimeEvent_Handler,
},
{
MethodName: "RefreshRuntimeTokenInternal",
Handler: _ManagedNotebookService_RefreshRuntimeTokenInternal_Handler,
},
{
MethodName: "DiagnoseRuntime",
Handler: _ManagedNotebookService_DiagnoseRuntime_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/notebooks/v1/managed_service.proto",
}ManagedNotebookService_ServiceDesc is the grpc.ServiceDesc for ManagedNotebookService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
NotebookService_ServiceDesc
var NotebookService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.notebooks.v1.NotebookService",
HandlerType: (*NotebookServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListInstances",
Handler: _NotebookService_ListInstances_Handler,
},
{
MethodName: "GetInstance",
Handler: _NotebookService_GetInstance_Handler,
},
{
MethodName: "CreateInstance",
Handler: _NotebookService_CreateInstance_Handler,
},
{
MethodName: "RegisterInstance",
Handler: _NotebookService_RegisterInstance_Handler,
},
{
MethodName: "SetInstanceAccelerator",
Handler: _NotebookService_SetInstanceAccelerator_Handler,
},
{
MethodName: "SetInstanceMachineType",
Handler: _NotebookService_SetInstanceMachineType_Handler,
},
{
MethodName: "UpdateInstanceConfig",
Handler: _NotebookService_UpdateInstanceConfig_Handler,
},
{
MethodName: "UpdateShieldedInstanceConfig",
Handler: _NotebookService_UpdateShieldedInstanceConfig_Handler,
},
{
MethodName: "SetInstanceLabels",
Handler: _NotebookService_SetInstanceLabels_Handler,
},
{
MethodName: "UpdateInstanceMetadataItems",
Handler: _NotebookService_UpdateInstanceMetadataItems_Handler,
},
{
MethodName: "DeleteInstance",
Handler: _NotebookService_DeleteInstance_Handler,
},
{
MethodName: "StartInstance",
Handler: _NotebookService_StartInstance_Handler,
},
{
MethodName: "StopInstance",
Handler: _NotebookService_StopInstance_Handler,
},
{
MethodName: "ResetInstance",
Handler: _NotebookService_ResetInstance_Handler,
},
{
MethodName: "ReportInstanceInfo",
Handler: _NotebookService_ReportInstanceInfo_Handler,
},
{
MethodName: "IsInstanceUpgradeable",
Handler: _NotebookService_IsInstanceUpgradeable_Handler,
},
{
MethodName: "GetInstanceHealth",
Handler: _NotebookService_GetInstanceHealth_Handler,
},
{
MethodName: "UpgradeInstance",
Handler: _NotebookService_UpgradeInstance_Handler,
},
{
MethodName: "RollbackInstance",
Handler: _NotebookService_RollbackInstance_Handler,
},
{
MethodName: "DiagnoseInstance",
Handler: _NotebookService_DiagnoseInstance_Handler,
},
{
MethodName: "UpgradeInstanceInternal",
Handler: _NotebookService_UpgradeInstanceInternal_Handler,
},
{
MethodName: "ListEnvironments",
Handler: _NotebookService_ListEnvironments_Handler,
},
{
MethodName: "GetEnvironment",
Handler: _NotebookService_GetEnvironment_Handler,
},
{
MethodName: "CreateEnvironment",
Handler: _NotebookService_CreateEnvironment_Handler,
},
{
MethodName: "DeleteEnvironment",
Handler: _NotebookService_DeleteEnvironment_Handler,
},
{
MethodName: "ListSchedules",
Handler: _NotebookService_ListSchedules_Handler,
},
{
MethodName: "GetSchedule",
Handler: _NotebookService_GetSchedule_Handler,
},
{
MethodName: "DeleteSchedule",
Handler: _NotebookService_DeleteSchedule_Handler,
},
{
MethodName: "CreateSchedule",
Handler: _NotebookService_CreateSchedule_Handler,
},
{
MethodName: "TriggerSchedule",
Handler: _NotebookService_TriggerSchedule_Handler,
},
{
MethodName: "ListExecutions",
Handler: _NotebookService_ListExecutions_Handler,
},
{
MethodName: "GetExecution",
Handler: _NotebookService_GetExecution_Handler,
},
{
MethodName: "DeleteExecution",
Handler: _NotebookService_DeleteExecution_Handler,
},
{
MethodName: "CreateExecution",
Handler: _NotebookService_CreateExecution_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/notebooks/v1/service.proto",
}NotebookService_ServiceDesc is the grpc.ServiceDesc for NotebookService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterManagedNotebookServiceServer
func RegisterManagedNotebookServiceServer(s grpc.ServiceRegistrar, srv ManagedNotebookServiceServer)func RegisterNotebookServiceServer
func RegisterNotebookServiceServer(s grpc.ServiceRegistrar, 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() stringfunc (*ContainerImage) GetTag
func (x *ContainerImage) GetTag() stringfunc (*ContainerImage) ProtoMessage
func (*ContainerImage) ProtoMessage()func (*ContainerImage) ProtoReflect
func (x *ContainerImage) ProtoReflect() protoreflect.Messagefunc (*ContainerImage) Reset
func (x *ContainerImage) Reset()func (*ContainerImage) String
func (x *ContainerImage) String() stringCreateEnvironmentRequest
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() *Environmentfunc (*CreateEnvironmentRequest) GetEnvironmentId
func (x *CreateEnvironmentRequest) GetEnvironmentId() stringfunc (*CreateEnvironmentRequest) GetParent
func (x *CreateEnvironmentRequest) GetParent() stringfunc (*CreateEnvironmentRequest) ProtoMessage
func (*CreateEnvironmentRequest) ProtoMessage()func (*CreateEnvironmentRequest) ProtoReflect
func (x *CreateEnvironmentRequest) ProtoReflect() protoreflect.Messagefunc (*CreateEnvironmentRequest) Reset
func (x *CreateEnvironmentRequest) Reset()func (*CreateEnvironmentRequest) String
func (x *CreateEnvironmentRequest) String() stringCreateExecutionRequest
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() *Executionfunc (*CreateExecutionRequest) GetExecutionId
func (x *CreateExecutionRequest) GetExecutionId() stringfunc (*CreateExecutionRequest) GetParent
func (x *CreateExecutionRequest) GetParent() stringfunc (*CreateExecutionRequest) ProtoMessage
func (*CreateExecutionRequest) ProtoMessage()func (*CreateExecutionRequest) ProtoReflect
func (x *CreateExecutionRequest) ProtoReflect() protoreflect.Messagefunc (*CreateExecutionRequest) Reset
func (x *CreateExecutionRequest) Reset()func (*CreateExecutionRequest) String
func (x *CreateExecutionRequest) String() stringCreateInstanceRequest
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() *Instancefunc (*CreateInstanceRequest) GetInstanceId
func (x *CreateInstanceRequest) GetInstanceId() stringfunc (*CreateInstanceRequest) GetParent
func (x *CreateInstanceRequest) GetParent() stringfunc (*CreateInstanceRequest) ProtoMessage
func (*CreateInstanceRequest) ProtoMessage()func (*CreateInstanceRequest) ProtoReflect
func (x *CreateInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*CreateInstanceRequest) Reset
func (x *CreateInstanceRequest) Reset()func (*CreateInstanceRequest) String
func (x *CreateInstanceRequest) String() stringCreateRuntimeRequest
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() stringfunc (*CreateRuntimeRequest) GetRequestId
func (x *CreateRuntimeRequest) GetRequestId() stringfunc (*CreateRuntimeRequest) GetRuntime
func (x *CreateRuntimeRequest) GetRuntime() *Runtimefunc (*CreateRuntimeRequest) GetRuntimeId
func (x *CreateRuntimeRequest) GetRuntimeId() stringfunc (*CreateRuntimeRequest) ProtoMessage
func (*CreateRuntimeRequest) ProtoMessage()func (*CreateRuntimeRequest) ProtoReflect
func (x *CreateRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*CreateRuntimeRequest) Reset
func (x *CreateRuntimeRequest) Reset()func (*CreateRuntimeRequest) String
func (x *CreateRuntimeRequest) String() stringCreateScheduleRequest
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() stringfunc (*CreateScheduleRequest) GetSchedule
func (x *CreateScheduleRequest) GetSchedule() *Schedulefunc (*CreateScheduleRequest) GetScheduleId
func (x *CreateScheduleRequest) GetScheduleId() stringfunc (*CreateScheduleRequest) ProtoMessage
func (*CreateScheduleRequest) ProtoMessage()func (*CreateScheduleRequest) ProtoReflect
func (x *CreateScheduleRequest) ProtoReflect() protoreflect.Messagefunc (*CreateScheduleRequest) Reset
func (x *CreateScheduleRequest) Reset()func (*CreateScheduleRequest) String
func (x *CreateScheduleRequest) String() stringDeleteEnvironmentRequest
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() stringfunc (*DeleteEnvironmentRequest) ProtoMessage
func (*DeleteEnvironmentRequest) ProtoMessage()func (*DeleteEnvironmentRequest) ProtoReflect
func (x *DeleteEnvironmentRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteEnvironmentRequest) Reset
func (x *DeleteEnvironmentRequest) Reset()func (*DeleteEnvironmentRequest) String
func (x *DeleteEnvironmentRequest) String() stringDeleteExecutionRequest
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() stringfunc (*DeleteExecutionRequest) ProtoMessage
func (*DeleteExecutionRequest) ProtoMessage()func (*DeleteExecutionRequest) ProtoReflect
func (x *DeleteExecutionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteExecutionRequest) Reset
func (x *DeleteExecutionRequest) Reset()func (*DeleteExecutionRequest) String
func (x *DeleteExecutionRequest) String() stringDeleteInstanceRequest
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() stringfunc (*DeleteInstanceRequest) ProtoMessage
func (*DeleteInstanceRequest) ProtoMessage()func (*DeleteInstanceRequest) ProtoReflect
func (x *DeleteInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteInstanceRequest) Reset
func (x *DeleteInstanceRequest) Reset()func (*DeleteInstanceRequest) String
func (x *DeleteInstanceRequest) String() stringDeleteRuntimeRequest
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() stringfunc (*DeleteRuntimeRequest) GetRequestId
func (x *DeleteRuntimeRequest) GetRequestId() stringfunc (*DeleteRuntimeRequest) ProtoMessage
func (*DeleteRuntimeRequest) ProtoMessage()func (*DeleteRuntimeRequest) ProtoReflect
func (x *DeleteRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteRuntimeRequest) Reset
func (x *DeleteRuntimeRequest) Reset()func (*DeleteRuntimeRequest) String
func (x *DeleteRuntimeRequest) String() stringDeleteScheduleRequest
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() stringfunc (*DeleteScheduleRequest) ProtoMessage
func (*DeleteScheduleRequest) ProtoMessage()func (*DeleteScheduleRequest) ProtoReflect
func (x *DeleteScheduleRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteScheduleRequest) Reset
func (x *DeleteScheduleRequest) Reset()func (*DeleteScheduleRequest) String
func (x *DeleteScheduleRequest) String() stringDiagnoseInstanceRequest
type DiagnoseInstanceRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Defines flags that are used to run the diagnostic tool
DiagnosticConfig *DiagnosticConfig `protobuf:"bytes,2,opt,name=diagnostic_config,json=diagnosticConfig,proto3" json:"diagnostic_config,omitempty"`
// contains filtered or unexported fields
}Request for creating a notebook instance diagnostic file.
func (*DiagnoseInstanceRequest) Descriptor
func (*DiagnoseInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use DiagnoseInstanceRequest.ProtoReflect.Descriptor instead.
func (*DiagnoseInstanceRequest) GetDiagnosticConfig
func (x *DiagnoseInstanceRequest) GetDiagnosticConfig() *DiagnosticConfigfunc (*DiagnoseInstanceRequest) GetName
func (x *DiagnoseInstanceRequest) GetName() stringfunc (*DiagnoseInstanceRequest) ProtoMessage
func (*DiagnoseInstanceRequest) ProtoMessage()func (*DiagnoseInstanceRequest) ProtoReflect
func (x *DiagnoseInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*DiagnoseInstanceRequest) Reset
func (x *DiagnoseInstanceRequest) Reset()func (*DiagnoseInstanceRequest) String
func (x *DiagnoseInstanceRequest) String() stringDiagnoseRuntimeRequest
type DiagnoseRuntimeRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Defines flags that are used to run the diagnostic tool
DiagnosticConfig *DiagnosticConfig `protobuf:"bytes,2,opt,name=diagnostic_config,json=diagnosticConfig,proto3" json:"diagnostic_config,omitempty"`
// contains filtered or unexported fields
}Request for creating a notebook instance diagnostic file.
func (*DiagnoseRuntimeRequest) Descriptor
func (*DiagnoseRuntimeRequest) Descriptor() ([]byte, []int)Deprecated: Use DiagnoseRuntimeRequest.ProtoReflect.Descriptor instead.
func (*DiagnoseRuntimeRequest) GetDiagnosticConfig
func (x *DiagnoseRuntimeRequest) GetDiagnosticConfig() *DiagnosticConfigfunc (*DiagnoseRuntimeRequest) GetName
func (x *DiagnoseRuntimeRequest) GetName() stringfunc (*DiagnoseRuntimeRequest) ProtoMessage
func (*DiagnoseRuntimeRequest) ProtoMessage()func (*DiagnoseRuntimeRequest) ProtoReflect
func (x *DiagnoseRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*DiagnoseRuntimeRequest) Reset
func (x *DiagnoseRuntimeRequest) Reset()func (*DiagnoseRuntimeRequest) String
func (x *DiagnoseRuntimeRequest) String() stringDiagnosticConfig
type DiagnosticConfig struct {
// Required. User Cloud Storage bucket location (REQUIRED).
// Must be formatted with path prefix (`gs://$GCS_BUCKET`).
//
// Permissions:
// User Managed Notebooks:
// - storage.buckets.writer: Must be given to the project's service account
// attached to VM.
//
// Google Managed Notebooks:
// - storage.buckets.writer: Must be given to the project's service account or
// user credentials attached to VM depending on authentication mode.
//
// Cloud Storage bucket Log file will be written to
// `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
GcsBucket string `protobuf:"bytes,1,opt,name=gcs_bucket,json=gcsBucket,proto3" json:"gcs_bucket,omitempty"`
// Optional. Defines the relative storage path in the Cloud Storage bucket
// where the diagnostic logs will be written: Default path will be the root
// directory of the Cloud Storage bucket
// (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
// Example of full path where Log file will be written:
// `gs://$GCS_BUCKET/$RELATIVE_PATH/`
RelativePath string `protobuf:"bytes,2,opt,name=relative_path,json=relativePath,proto3" json:"relative_path,omitempty"`
// Optional. Enables flag to repair service for instance
RepairFlagEnabled bool `protobuf:"varint,3,opt,name=repair_flag_enabled,json=repairFlagEnabled,proto3" json:"repair_flag_enabled,omitempty"`
// Optional. Enables flag to capture packets from the instance for 30 seconds
PacketCaptureFlagEnabled bool `protobuf:"varint,4,opt,name=packet_capture_flag_enabled,json=packetCaptureFlagEnabled,proto3" json:"packet_capture_flag_enabled,omitempty"`
// Optional. Enables flag to copy all `/home/jupyter` folder contents
CopyHomeFilesFlagEnabled bool `protobuf:"varint,5,opt,name=copy_home_files_flag_enabled,json=copyHomeFilesFlagEnabled,proto3" json:"copy_home_files_flag_enabled,omitempty"`
// contains filtered or unexported fields
}Defines flags that are used to run the diagnostic tool
func (*DiagnosticConfig) Descriptor
func (*DiagnosticConfig) Descriptor() ([]byte, []int)Deprecated: Use DiagnosticConfig.ProtoReflect.Descriptor instead.
func (*DiagnosticConfig) GetCopyHomeFilesFlagEnabled
func (x *DiagnosticConfig) GetCopyHomeFilesFlagEnabled() boolfunc (*DiagnosticConfig) GetGcsBucket
func (x *DiagnosticConfig) GetGcsBucket() stringfunc (*DiagnosticConfig) GetPacketCaptureFlagEnabled
func (x *DiagnosticConfig) GetPacketCaptureFlagEnabled() boolfunc (*DiagnosticConfig) GetRelativePath
func (x *DiagnosticConfig) GetRelativePath() stringfunc (*DiagnosticConfig) GetRepairFlagEnabled
func (x *DiagnosticConfig) GetRepairFlagEnabled() boolfunc (*DiagnosticConfig) ProtoMessage
func (*DiagnosticConfig) ProtoMessage()func (*DiagnosticConfig) ProtoReflect
func (x *DiagnosticConfig) ProtoReflect() protoreflect.Messagefunc (*DiagnosticConfig) Reset
func (x *DiagnosticConfig) Reset()func (*DiagnosticConfig) String
func (x *DiagnosticConfig) String() stringEncryptionConfig
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() stringfunc (*EncryptionConfig) ProtoMessage
func (*EncryptionConfig) ProtoMessage()func (*EncryptionConfig) ProtoReflect
func (x *EncryptionConfig) ProtoReflect() protoreflect.Messagefunc (*EncryptionConfig) Reset
func (x *EncryptionConfig) Reset()func (*EncryptionConfig) String
func (x *EncryptionConfig) String() stringEnvironment
type Environment struct {
// Output only. Name of this environment.
// Format:
// `projects/{project_id}/locations/{location}/environments/{environment_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Display name of this environment for the UI.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// A brief description of this environment.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Type of the environment; can be one of VM image, or container image.
//
// Types that are assignable to ImageType:
//
// *Environment_VmImage
// *Environment_ContainerImage
ImageType isEnvironment_ImageType `protobuf_oneof:"image_type"`
// Path to a Bash script that automatically runs after a notebook instance
// fully boots up. The path must be a URL or
// Cloud Storage path. Example: `"gs://path-to-file/file-name"`
PostStartupScript string `protobuf:"bytes,8,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
// Output only. The time at which this environment was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}Definition of a software environment that is used to start a notebook instance.
func (*Environment) Descriptor
func (*Environment) Descriptor() ([]byte, []int)Deprecated: Use Environment.ProtoReflect.Descriptor instead.
func (*Environment) GetContainerImage
func (x *Environment) GetContainerImage() *ContainerImagefunc (*Environment) GetCreateTime
func (x *Environment) GetCreateTime() *timestamppb.Timestampfunc (*Environment) GetDescription
func (x *Environment) GetDescription() stringfunc (*Environment) GetDisplayName
func (x *Environment) GetDisplayName() stringfunc (*Environment) GetImageType
func (m *Environment) GetImageType() isEnvironment_ImageTypefunc (*Environment) GetName
func (x *Environment) GetName() stringfunc (*Environment) GetPostStartupScript
func (x *Environment) GetPostStartupScript() stringfunc (*Environment) GetVmImage
func (x *Environment) GetVmImage() *VmImagefunc (*Environment) ProtoMessage
func (*Environment) ProtoMessage()func (*Environment) ProtoReflect
func (x *Environment) ProtoReflect() protoreflect.Messagefunc (*Environment) Reset
func (x *Environment) Reset()func (*Environment) String
func (x *Environment) String() stringEnvironment_ContainerImage
type Environment_ContainerImage struct {
// Use a container image to start the notebook instance.
ContainerImage *ContainerImage `protobuf:"bytes,7,opt,name=container_image,json=containerImage,proto3,oneof"`
}Environment_VmImage
type Environment_VmImage struct {
// Use a Compute Engine VM image to start the notebook instance.
VmImage *VmImage `protobuf:"bytes,6,opt,name=vm_image,json=vmImage,proto3,oneof"`
}Event
type Event struct {
// Event report time.
ReportTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`
// Event type.
Type Event_EventType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.notebooks.v1.Event_EventType" json:"type,omitempty"`
// Optional. Event details. This field is used to pass event information.
Details map[string]string `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}The definition of an Event for a managed / semi-managed notebook instance.
func (*Event) Descriptor
Deprecated: Use Event.ProtoReflect.Descriptor instead.
func (*Event) GetDetails
func (*Event) GetReportTime
func (x *Event) GetReportTime() *timestamppb.Timestampfunc (*Event) GetType
func (x *Event) GetType() Event_EventTypefunc (*Event) ProtoMessage
func (*Event) ProtoMessage()func (*Event) ProtoReflect
func (x *Event) ProtoReflect() protoreflect.Messagefunc (*Event) Reset
func (x *Event) Reset()func (*Event) String
Event_EventType
type Event_EventType int32The 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.EnumDescriptorfunc (Event_EventType) Enum
func (x Event_EventType) Enum() *Event_EventTypefunc (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.EnumNumberfunc (Event_EventType) String
func (x Event_EventType) String() stringfunc (Event_EventType) Type
func (Event_EventType) Type() protoreflect.EnumTypeExecution
type Execution struct {
// execute metadata including name, hardware spec, region, labels, etc.
ExecutionTemplate *ExecutionTemplate `protobuf:"bytes,1,opt,name=execution_template,json=executionTemplate,proto3" json:"execution_template,omitempty"`
// Output only. The resource name of the execute. Format:
// `projects/{project_id}/locations/{location}/executions/{execution_id}`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Name used for UI purposes.
// Name can only contain alphanumeric characters and underscores '_'.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// A brief description of this execution.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Time the Execution was instantiated.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time the Execution was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. State of the underlying AI Platform job.
State Execution_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.notebooks.v1.Execution_State" json:"state,omitempty"`
// Output notebook file generated by this execution
OutputNotebookFile string `protobuf:"bytes,8,opt,name=output_notebook_file,json=outputNotebookFile,proto3" json:"output_notebook_file,omitempty"`
// Output only. The URI of the external job used to execute the notebook.
JobUri string `protobuf:"bytes,9,opt,name=job_uri,json=jobUri,proto3" json:"job_uri,omitempty"`
// contains filtered or unexported fields
}The definition of a single executed notebook.
func (*Execution) Descriptor
Deprecated: Use Execution.ProtoReflect.Descriptor instead.
func (*Execution) GetCreateTime
func (x *Execution) GetCreateTime() *timestamppb.Timestampfunc (*Execution) GetDescription
func (*Execution) GetDisplayName
func (*Execution) GetExecutionTemplate
func (x *Execution) GetExecutionTemplate() *ExecutionTemplatefunc (*Execution) GetJobUri
func (*Execution) GetName
func (*Execution) GetOutputNotebookFile
func (*Execution) GetState
func (x *Execution) GetState() Execution_Statefunc (*Execution) GetUpdateTime
func (x *Execution) GetUpdateTime() *timestamppb.Timestampfunc (*Execution) ProtoMessage
func (*Execution) ProtoMessage()func (*Execution) ProtoReflect
func (x *Execution) ProtoReflect() protoreflect.Messagefunc (*Execution) Reset
func (x *Execution) Reset()func (*Execution) String
ExecutionTemplate
type ExecutionTemplate struct {
// Required. Scale tier of the hardware used for notebook execution.
// DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
//
// Deprecated: Marked as deprecated in google/cloud/notebooks/v1/execution.proto.
ScaleTier ExecutionTemplate_ScaleTier `protobuf:"varint,1,opt,name=scale_tier,json=scaleTier,proto3,enum=google.cloud.notebooks.v1.ExecutionTemplate_ScaleTier" json:"scale_tier,omitempty"`
// Specifies the type of virtual machine to use for your training
// job's master worker. You must specify this field when `scaleTier` is set to
// `CUSTOM`.
//
// You can use certain Compute Engine machine types directly in this field.
// The following types are supported:
//
// - `n1-standard-4`
// - `n1-standard-8`
// - `n1-standard-16`
// - `n1-standard-32`
// - `n1-standard-64`
// - `n1-standard-96`
// - `n1-highmem-2`
// - `n1-highmem-4`
// - `n1-highmem-8`
// - `n1-highmem-16`
// - `n1-highmem-32`
// - `n1-highmem-64`
// - `n1-highmem-96`
// - `n1-highcpu-16`
// - `n1-highcpu-32`
// - `n1-highcpu-64`
// - `n1-highcpu-96`
//
// Alternatively, you can use the following legacy machine types:
//
// - `standard`
// - `large_model`
// - `complex_model_s`
// - `complex_model_m`
// - `complex_model_l`
// - `standard_gpu`
// - `complex_model_m_gpu`
// - `complex_model_l_gpu`
// - `standard_p100`
// - `complex_model_m_p100`
// - `standard_v100`
// - `large_model_v100`
// - `complex_model_m_v100`
// - `complex_model_l_v100`
//
// Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
// field. Learn more about the [special configuration options for training
// with
// TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
MasterType string `protobuf:"bytes,2,opt,name=master_type,json=masterType,proto3" json:"master_type,omitempty"`
// Configuration (count and accelerator type) for hardware running notebook
// execution.
AcceleratorConfig *ExecutionTemplate_SchedulerAcceleratorConfig `protobuf:"bytes,3,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
// Labels for execution.
// If execution is scheduled, a field included will be 'nbs-scheduled'.
// Otherwise, it is an immediate execution, and an included field will be
// 'nbs-immediate'. Use fields to efficiently index between various types of
// executions.
Labels map[string]string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Path to the notebook file to execute.
// Must be in a Google Cloud Storage bucket.
// Format: `gs://{bucket_name}/{folder}/{notebook_file_name}`
// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
InputNotebookFile string `protobuf:"bytes,5,opt,name=input_notebook_file,json=inputNotebookFile,proto3" json:"input_notebook_file,omitempty"`
// Container Image URI to a DLVM
// Example: 'gcr.io/deeplearning-platform-release/base-cu100'
// More examples can be found at:
// https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
ContainerImageUri string `protobuf:"bytes,6,opt,name=container_image_uri,json=containerImageUri,proto3" json:"container_image_uri,omitempty"`
// Path to the notebook folder to write to.
// Must be in a Google Cloud Storage bucket path.
// Format: `gs://{bucket_name}/{folder}`
// Ex: `gs://notebook_user/scheduled_notebooks`
OutputNotebookFolder string `protobuf:"bytes,7,opt,name=output_notebook_folder,json=outputNotebookFolder,proto3" json:"output_notebook_folder,omitempty"`
// Parameters to be overridden in the notebook during execution.
// Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
// how to specifying parameters in the input notebook and pass them here
// in an YAML file.
// Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
ParamsYamlFile string `protobuf:"bytes,8,opt,name=params_yaml_file,json=paramsYamlFile,proto3" json:"params_yaml_file,omitempty"`
// Parameters used within the 'input_notebook_file' notebook.
Parameters string `protobuf:"bytes,9,opt,name=parameters,proto3" json:"parameters,omitempty"`
// The email address of a service account to use when running the execution.
// You must have the `iam.serviceAccounts.actAs` permission for the specified
// service account.
ServiceAccount string `protobuf:"bytes,10,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
// The type of Job to be used on this execution.
JobType ExecutionTemplate_JobType `protobuf:"varint,11,opt,name=job_type,json=jobType,proto3,enum=google.cloud.notebooks.v1.ExecutionTemplate_JobType" json:"job_type,omitempty"`
// Parameters for an execution type.
// NOTE: There are currently no extra parameters for VertexAI jobs.
//
// Types that are assignable to JobParameters:
//
// *ExecutionTemplate_DataprocParameters_
// *ExecutionTemplate_VertexAiParameters
JobParameters isExecutionTemplate_JobParameters `protobuf_oneof:"job_parameters"`
// Name of the kernel spec to use. This must be specified if the
// kernel spec name on the execution target does not match the name in the
// input notebook file.
KernelSpec string `protobuf:"bytes,14,opt,name=kernel_spec,json=kernelSpec,proto3" json:"kernel_spec,omitempty"`
// The name of a Vertex AI [Tensorboard] resource to which this execution
// will upload Tensorboard logs.
// Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Tensorboard string `protobuf:"bytes,15,opt,name=tensorboard,proto3" json:"tensorboard,omitempty"`
// contains filtered or unexported fields
}The description a notebook execution workload.
func (*ExecutionTemplate) Descriptor
func (*ExecutionTemplate) Descriptor() ([]byte, []int)Deprecated: Use ExecutionTemplate.ProtoReflect.Descriptor instead.
func (*ExecutionTemplate) GetAcceleratorConfig
func (x *ExecutionTemplate) GetAcceleratorConfig() *ExecutionTemplate_SchedulerAcceleratorConfigfunc (*ExecutionTemplate) GetContainerImageUri
func (x *ExecutionTemplate) GetContainerImageUri() stringfunc (*ExecutionTemplate) GetDataprocParameters
func (x *ExecutionTemplate) GetDataprocParameters() *ExecutionTemplate_DataprocParametersfunc (*ExecutionTemplate) GetInputNotebookFile
func (x *ExecutionTemplate) GetInputNotebookFile() stringfunc (*ExecutionTemplate) GetJobParameters
func (m *ExecutionTemplate) GetJobParameters() isExecutionTemplate_JobParametersfunc (*ExecutionTemplate) GetJobType
func (x *ExecutionTemplate) GetJobType() ExecutionTemplate_JobTypefunc (*ExecutionTemplate) GetKernelSpec
func (x *ExecutionTemplate) GetKernelSpec() stringfunc (*ExecutionTemplate) GetLabels
func (x *ExecutionTemplate) GetLabels() map[string]stringfunc (*ExecutionTemplate) GetMasterType
func (x *ExecutionTemplate) GetMasterType() stringfunc (*ExecutionTemplate) GetOutputNotebookFolder
func (x *ExecutionTemplate) GetOutputNotebookFolder() stringfunc (*ExecutionTemplate) GetParameters
func (x *ExecutionTemplate) GetParameters() stringfunc (*ExecutionTemplate) GetParamsYamlFile
func (x *ExecutionTemplate) GetParamsYamlFile() stringfunc (*ExecutionTemplate) GetScaleTier
func (x *ExecutionTemplate) GetScaleTier() ExecutionTemplate_ScaleTierDeprecated: Marked as deprecated in google/cloud/notebooks/v1/execution.proto.
func (*ExecutionTemplate) GetServiceAccount
func (x *ExecutionTemplate) GetServiceAccount() stringfunc (*ExecutionTemplate) GetTensorboard
func (x *ExecutionTemplate) GetTensorboard() stringfunc (*ExecutionTemplate) GetVertexAiParameters
func (x *ExecutionTemplate) GetVertexAiParameters() *ExecutionTemplate_VertexAIParametersfunc (*ExecutionTemplate) ProtoMessage
func (*ExecutionTemplate) ProtoMessage()func (*ExecutionTemplate) ProtoReflect
func (x *ExecutionTemplate) ProtoReflect() protoreflect.Messagefunc (*ExecutionTemplate) Reset
func (x *ExecutionTemplate) Reset()func (*ExecutionTemplate) String
func (x *ExecutionTemplate) String() stringExecutionTemplate_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() stringfunc (*ExecutionTemplate_DataprocParameters) ProtoMessage
func (*ExecutionTemplate_DataprocParameters) ProtoMessage()func (*ExecutionTemplate_DataprocParameters) ProtoReflect
func (x *ExecutionTemplate_DataprocParameters) ProtoReflect() protoreflect.Messagefunc (*ExecutionTemplate_DataprocParameters) Reset
func (x *ExecutionTemplate_DataprocParameters) Reset()func (*ExecutionTemplate_DataprocParameters) String
func (x *ExecutionTemplate_DataprocParameters) String() stringExecutionTemplate_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 int32The 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.EnumDescriptorfunc (ExecutionTemplate_JobType) Enum
func (x ExecutionTemplate_JobType) Enum() *ExecutionTemplate_JobTypefunc (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.EnumNumberfunc (ExecutionTemplate_JobType) String
func (x ExecutionTemplate_JobType) String() stringfunc (ExecutionTemplate_JobType) Type
func (ExecutionTemplate_JobType) Type() protoreflect.EnumTypeExecutionTemplate_ScaleTier
type ExecutionTemplate_ScaleTier int32Required. 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.EnumDescriptorfunc (ExecutionTemplate_ScaleTier) Enum
func (x ExecutionTemplate_ScaleTier) Enum() *ExecutionTemplate_ScaleTierfunc (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.EnumNumberfunc (ExecutionTemplate_ScaleTier) String
func (x ExecutionTemplate_ScaleTier) String() stringfunc (ExecutionTemplate_ScaleTier) Type
func (ExecutionTemplate_ScaleTier) Type() protoreflect.EnumTypeExecutionTemplate_SchedulerAcceleratorConfig
type ExecutionTemplate_SchedulerAcceleratorConfig struct {
// Type of this accelerator.
Type ExecutionTemplate_SchedulerAcceleratorType `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.notebooks.v1.ExecutionTemplate_SchedulerAcceleratorType" 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 (*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() int64func (*ExecutionTemplate_SchedulerAcceleratorConfig) GetType
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) GetType() ExecutionTemplate_SchedulerAcceleratorTypefunc (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoMessage
func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoMessage()func (*ExecutionTemplate_SchedulerAcceleratorConfig) ProtoReflect
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) ProtoReflect() protoreflect.Messagefunc (*ExecutionTemplate_SchedulerAcceleratorConfig) Reset
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) Reset()func (*ExecutionTemplate_SchedulerAcceleratorConfig) String
func (x *ExecutionTemplate_SchedulerAcceleratorConfig) String() stringExecutionTemplate_SchedulerAcceleratorType
type ExecutionTemplate_SchedulerAcceleratorType int32Hardware 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.EnumDescriptorfunc (ExecutionTemplate_SchedulerAcceleratorType) Enum
func (x ExecutionTemplate_SchedulerAcceleratorType) Enum() *ExecutionTemplate_SchedulerAcceleratorTypefunc (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.EnumNumberfunc (ExecutionTemplate_SchedulerAcceleratorType) String
func (x ExecutionTemplate_SchedulerAcceleratorType) String() stringfunc (ExecutionTemplate_SchedulerAcceleratorType) Type
func (ExecutionTemplate_SchedulerAcceleratorType) Type() protoreflect.EnumTypeExecutionTemplate_VertexAIParameters
type ExecutionTemplate_VertexAIParameters struct {
// The full name of the Compute Engine
// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
// to which the Job should be peered. For example,
// `projects/12345/global/networks/myVPC`.
// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert)
// is of the form `projects/{project}/global/networks/{network}`.
// Where `{project}` is a project number, as in `12345`, and `{network}` is
// a network name.
//
// Private services access must already be configured for the network. If
// left unspecified, the job is not peered with any network.
Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
// Environment variables.
// At most 100 environment variables can be specified and unique.
// Example: `GCP_BUCKET=gs://my-bucket/samples/`
Env map[string]string `protobuf:"bytes,2,rep,name=env,proto3" json:"env,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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]stringfunc (*ExecutionTemplate_VertexAIParameters) GetNetwork
func (x *ExecutionTemplate_VertexAIParameters) GetNetwork() stringfunc (*ExecutionTemplate_VertexAIParameters) ProtoMessage
func (*ExecutionTemplate_VertexAIParameters) ProtoMessage()func (*ExecutionTemplate_VertexAIParameters) ProtoReflect
func (x *ExecutionTemplate_VertexAIParameters) ProtoReflect() protoreflect.Messagefunc (*ExecutionTemplate_VertexAIParameters) Reset
func (x *ExecutionTemplate_VertexAIParameters) Reset()func (*ExecutionTemplate_VertexAIParameters) String
func (x *ExecutionTemplate_VertexAIParameters) String() stringExecutionTemplate_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 int32Enum 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.EnumDescriptorfunc (Execution_State) Enum
func (x Execution_State) Enum() *Execution_Statefunc (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.EnumNumberfunc (Execution_State) String
func (x Execution_State) String() stringfunc (Execution_State) Type
func (Execution_State) Type() protoreflect.EnumTypeGetEnvironmentRequest
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() stringfunc (*GetEnvironmentRequest) ProtoMessage
func (*GetEnvironmentRequest) ProtoMessage()func (*GetEnvironmentRequest) ProtoReflect
func (x *GetEnvironmentRequest) ProtoReflect() protoreflect.Messagefunc (*GetEnvironmentRequest) Reset
func (x *GetEnvironmentRequest) Reset()func (*GetEnvironmentRequest) String
func (x *GetEnvironmentRequest) String() stringGetExecutionRequest
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() stringfunc (*GetExecutionRequest) ProtoMessage
func (*GetExecutionRequest) ProtoMessage()func (*GetExecutionRequest) ProtoReflect
func (x *GetExecutionRequest) ProtoReflect() protoreflect.Messagefunc (*GetExecutionRequest) Reset
func (x *GetExecutionRequest) Reset()func (*GetExecutionRequest) String
func (x *GetExecutionRequest) String() stringGetInstanceHealthRequest
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() stringfunc (*GetInstanceHealthRequest) ProtoMessage
func (*GetInstanceHealthRequest) ProtoMessage()func (*GetInstanceHealthRequest) ProtoReflect
func (x *GetInstanceHealthRequest) ProtoReflect() protoreflect.Messagefunc (*GetInstanceHealthRequest) Reset
func (x *GetInstanceHealthRequest) Reset()func (*GetInstanceHealthRequest) String
func (x *GetInstanceHealthRequest) String() stringGetInstanceHealthResponse
type GetInstanceHealthResponse struct {
// Output only. Runtime health_state.
HealthState GetInstanceHealthResponse_HealthState `protobuf:"varint,1,opt,name=health_state,json=healthState,proto3,enum=google.cloud.notebooks.v1.GetInstanceHealthResponse_HealthState" json:"health_state,omitempty"`
// Output only. Additional information about instance health.
// Example:
//
// healthInfo": {
// "docker_proxy_agent_status": "1",
// "docker_status": "1",
// "jupyterlab_api_status": "-1",
// "jupyterlab_status": "-1",
// "updated": "2020-10-18 09:40:03.573409"
// }
HealthInfo map[string]string `protobuf:"bytes,2,rep,name=health_info,json=healthInfo,proto3" json:"health_info,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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]stringfunc (*GetInstanceHealthResponse) GetHealthState
func (x *GetInstanceHealthResponse) GetHealthState() GetInstanceHealthResponse_HealthStatefunc (*GetInstanceHealthResponse) ProtoMessage
func (*GetInstanceHealthResponse) ProtoMessage()func (*GetInstanceHealthResponse) ProtoReflect
func (x *GetInstanceHealthResponse) ProtoReflect() protoreflect.Messagefunc (*GetInstanceHealthResponse) Reset
func (x *GetInstanceHealthResponse) Reset()func (*GetInstanceHealthResponse) String
func (x *GetInstanceHealthResponse) String() stringGetInstanceHealthResponse_HealthState
type GetInstanceHealthResponse_HealthState int32If 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.EnumDescriptorfunc (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.EnumNumberfunc (GetInstanceHealthResponse_HealthState) String
func (x GetInstanceHealthResponse_HealthState) String() stringfunc (GetInstanceHealthResponse_HealthState) Type
func (GetInstanceHealthResponse_HealthState) Type() protoreflect.EnumTypeGetInstanceRequest
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() stringfunc (*GetInstanceRequest) ProtoMessage
func (*GetInstanceRequest) ProtoMessage()func (*GetInstanceRequest) ProtoReflect
func (x *GetInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*GetInstanceRequest) Reset
func (x *GetInstanceRequest) Reset()func (*GetInstanceRequest) String
func (x *GetInstanceRequest) String() stringGetRuntimeRequest
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() stringfunc (*GetRuntimeRequest) ProtoMessage
func (*GetRuntimeRequest) ProtoMessage()func (*GetRuntimeRequest) ProtoReflect
func (x *GetRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*GetRuntimeRequest) Reset
func (x *GetRuntimeRequest) Reset()func (*GetRuntimeRequest) String
func (x *GetRuntimeRequest) String() stringGetScheduleRequest
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() stringfunc (*GetScheduleRequest) ProtoMessage
func (*GetScheduleRequest) ProtoMessage()func (*GetScheduleRequest) ProtoReflect
func (x *GetScheduleRequest) ProtoReflect() protoreflect.Messagefunc (*GetScheduleRequest) Reset
func (x *GetScheduleRequest) Reset()func (*GetScheduleRequest) String
func (x *GetScheduleRequest) String() stringInstance
type Instance struct {
// Output only. The name of this notebook instance. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Type of the environment; can be one of VM image, or container image.
//
// Types that are assignable to Environment:
//
// *Instance_VmImage
// *Instance_ContainerImage
Environment isInstance_Environment `protobuf_oneof:"environment"`
// Path to a Bash script that automatically runs after a notebook instance
// fully boots up. The path must be a URL or
// Cloud Storage path (`gs://path-to-file/file-name`).
PostStartupScript string `protobuf:"bytes,4,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
// Output only. The proxy endpoint that is used to access the Jupyter notebook.
ProxyUri string `protobuf:"bytes,5,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
// Input only. The owner of this instance after creation. Format: `alias@example.com`
//
// Currently supports one owner only. If not specified, all of the service
// account users of your VM instance's service account can use
// the instance.
InstanceOwners []string `protobuf:"bytes,6,rep,name=instance_owners,json=instanceOwners,proto3" json:"instance_owners,omitempty"`
// The service account on this instance, giving access to other Google
// Cloud services.
// You can use any service account within the same project, but you
// must have the service account user permission to use the instance.
//
// If not specified, the [Compute Engine default service
// account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
// is used.
ServiceAccount string `protobuf:"bytes,7,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
// Optional. The URIs of service account scopes to be included in
// Compute Engine instances.
//
// If not specified, the following
// [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
// are defined:
// - https://www.googleapis.com/auth/cloud-platform
// - https://www.googleapis.com/auth/userinfo.email
//
// If not using default scopes, you need at least:
//
// https://www.googleapis.com/auth/compute
ServiceAccountScopes []string `protobuf:"bytes,31,rep,name=service_account_scopes,json=serviceAccountScopes,proto3" json:"service_account_scopes,omitempty"`
// Required. The [Compute Engine machine
// type](https://cloud.google.com/compute/docs/machine-types) of this
// instance.
MachineType string `protobuf:"bytes,8,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
// The hardware accelerator used on this instance. If you use
// accelerators, make sure that your configuration has
// [enough vCPUs and memory to support the `machine_type` you have
// selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
AcceleratorConfig *Instance_AcceleratorConfig `protobuf:"bytes,9,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
// Output only. The state of this instance.
State Instance_State `protobuf:"varint,10,opt,name=state,proto3,enum=google.cloud.notebooks.v1.Instance_State" json:"state,omitempty"`
// Whether the end user authorizes Google Cloud to install GPU driver
// on this instance.
// If this field is empty or set to false, the GPU driver won't be installed.
// Only applicable to instances with GPUs.
InstallGpuDriver bool `protobuf:"varint,11,opt,name=install_gpu_driver,json=installGpuDriver,proto3" json:"install_gpu_driver,omitempty"`
// Specify a custom Cloud Storage path where the GPU driver is stored.
// If not specified, we'll automatically choose from official GPU drivers.
CustomGpuDriverPath string `protobuf:"bytes,12,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
// Input only. The type of the boot disk attached to this instance, defaults to
// standard persistent disk (`PD_STANDARD`).
BootDiskType Instance_DiskType `protobuf:"varint,13,opt,name=boot_disk_type,json=bootDiskType,proto3,enum=google.cloud.notebooks.v1.Instance_DiskType" json:"boot_disk_type,omitempty"`
// Input only. The size of the boot disk in GB attached to this instance, up to a maximum
// of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not
// specified, this defaults to 100.
BootDiskSizeGb int64 `protobuf:"varint,14,opt,name=boot_disk_size_gb,json=bootDiskSizeGb,proto3" json:"boot_disk_size_gb,omitempty"`
// Input only. The type of the data disk attached to this instance, defaults to
// standard persistent disk (`PD_STANDARD`).
DataDiskType Instance_DiskType `protobuf:"varint,25,opt,name=data_disk_type,json=dataDiskType,proto3,enum=google.cloud.notebooks.v1.Instance_DiskType" json:"data_disk_type,omitempty"`
// Input only. The size of the data disk in GB attached to this instance, up to a maximum
// of 64000 GB (64 TB). You can choose the size of the data disk based on how
// big your notebooks and data are. If not specified, this defaults to 100.
DataDiskSizeGb int64 `protobuf:"varint,26,opt,name=data_disk_size_gb,json=dataDiskSizeGb,proto3" json:"data_disk_size_gb,omitempty"`
// Input only. If true, the data disk will not be auto deleted when deleting the instance.
NoRemoveDataDisk bool `protobuf:"varint,27,opt,name=no_remove_data_disk,json=noRemoveDataDisk,proto3" json:"no_remove_data_disk,omitempty"`
// Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
DiskEncryption Instance_DiskEncryption `protobuf:"varint,15,opt,name=disk_encryption,json=diskEncryption,proto3,enum=google.cloud.notebooks.v1.Instance_DiskEncryption" json:"disk_encryption,omitempty"`
// Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption
// is CMEK.
// Format:
// `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`
//
// Learn more about [using your own encryption keys](/kms/docs/quickstart).
KmsKey string `protobuf:"bytes,16,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
// Output only. Attached disks to notebook instance.
Disks []*Instance_Disk `protobuf:"bytes,28,rep,name=disks,proto3" json:"disks,omitempty"`
// Optional. Shielded VM configuration.
// [Images using supported Shielded VM
// features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
ShieldedInstanceConfig *Instance_ShieldedInstanceConfig `protobuf:"bytes,30,opt,name=shielded_instance_config,json=shieldedInstanceConfig,proto3" json:"shielded_instance_config,omitempty"`
// If true, no public IP will be assigned to this instance.
NoPublicIp bool `protobuf:"varint,17,opt,name=no_public_ip,json=noPublicIp,proto3" json:"no_public_ip,omitempty"`
// If true, the notebook instance will not register with the proxy.
NoProxyAccess bool `protobuf:"varint,18,opt,name=no_proxy_access,json=noProxyAccess,proto3" json:"no_proxy_access,omitempty"`
// The name of the VPC that this instance is in.
// Format:
// `projects/{project_id}/global/networks/{network_id}`
Network string `protobuf:"bytes,19,opt,name=network,proto3" json:"network,omitempty"`
// The name of the subnet that this instance is in.
// Format:
// `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
Subnet string `protobuf:"bytes,20,opt,name=subnet,proto3" json:"subnet,omitempty"`
// Labels to apply to this instance.
// These can be later modified by the setLabels method.
Labels map[string]string `protobuf:"bytes,21,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Custom metadata to apply to this instance.
Metadata map[string]string `protobuf:"bytes,22,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The Compute Engine tags to add to runtime (see [Tagging
// instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Tags []string `protobuf:"bytes,32,rep,name=tags,proto3" json:"tags,omitempty"`
// The upgrade history of this instance.
UpgradeHistory []*Instance_UpgradeHistoryEntry `protobuf:"bytes,29,rep,name=upgrade_history,json=upgradeHistory,proto3" json:"upgrade_history,omitempty"`
// Optional. The type of vNIC to be used on this interface. This may be gVNIC or
// VirtioNet.
NicType Instance_NicType `protobuf:"varint,33,opt,name=nic_type,json=nicType,proto3,enum=google.cloud.notebooks.v1.Instance_NicType" json:"nic_type,omitempty"`
// Optional. The optional reservation affinity. Setting this field will apply
// the specified [Zonal Compute
// Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
// to this notebook instance.
ReservationAffinity *ReservationAffinity `protobuf:"bytes,34,opt,name=reservation_affinity,json=reservationAffinity,proto3" json:"reservation_affinity,omitempty"`
// Output only. Email address of entity that sent original CreateInstance request.
Creator string `protobuf:"bytes,36,opt,name=creator,proto3" json:"creator,omitempty"`
// Optional. Flag to enable ip forwarding or not, default false/off.
// https://cloud.google.com/vpc/docs/using-routes#canipforward
CanIpForward bool `protobuf:"varint,39,opt,name=can_ip_forward,json=canIpForward,proto3" json:"can_ip_forward,omitempty"`
// Output only. Instance creation time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,23,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Instance update time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,24,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}The definition of a notebook instance.
func (*Instance) Descriptor
Deprecated: Use Instance.ProtoReflect.Descriptor instead.
func (*Instance) GetAcceleratorConfig
func (x *Instance) GetAcceleratorConfig() *Instance_AcceleratorConfigfunc (*Instance) GetBootDiskSizeGb
func (*Instance) GetBootDiskType
func (x *Instance) GetBootDiskType() Instance_DiskTypefunc (*Instance) GetCanIpForward
func (*Instance) GetContainerImage
func (x *Instance) GetContainerImage() *ContainerImagefunc (*Instance) GetCreateTime
func (x *Instance) GetCreateTime() *timestamppb.Timestampfunc (*Instance) GetCreator
func (*Instance) GetCustomGpuDriverPath
func (*Instance) GetDataDiskSizeGb
func (*Instance) GetDataDiskType
func (x *Instance) GetDataDiskType() Instance_DiskTypefunc (*Instance) GetDiskEncryption
func (x *Instance) GetDiskEncryption() Instance_DiskEncryptionfunc (*Instance) GetDisks
func (x *Instance) GetDisks() []*Instance_Diskfunc (*Instance) GetEnvironment
func (m *Instance) GetEnvironment() isInstance_Environmentfunc (*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_NicTypefunc (*Instance) GetNoProxyAccess
func (*Instance) GetNoPublicIp
func (*Instance) GetNoRemoveDataDisk
func (*Instance) GetPostStartupScript
func (*Instance) GetProxyUri
func (*Instance) GetReservationAffinity
func (x *Instance) GetReservationAffinity() *ReservationAffinityfunc (*Instance) GetServiceAccount
func (*Instance) GetServiceAccountScopes
func (*Instance) GetShieldedInstanceConfig
func (x *Instance) GetShieldedInstanceConfig() *Instance_ShieldedInstanceConfigfunc (*Instance) GetState
func (x *Instance) GetState() Instance_Statefunc (*Instance) GetSubnet
func (*Instance) GetTags
func (*Instance) GetUpdateTime
func (x *Instance) GetUpdateTime() *timestamppb.Timestampfunc (*Instance) GetUpgradeHistory
func (x *Instance) GetUpgradeHistory() []*Instance_UpgradeHistoryEntryfunc (*Instance) GetVmImage
func (*Instance) ProtoMessage
func (*Instance) ProtoMessage()func (*Instance) ProtoReflect
func (x *Instance) ProtoReflect() protoreflect.Messagefunc (*Instance) Reset
func (x *Instance) Reset()func (*Instance) String
InstanceConfig
type InstanceConfig struct {
// Cron expression in UTC timezone, used to schedule instance auto upgrade.
// Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
NotebookUpgradeSchedule string `protobuf:"bytes,1,opt,name=notebook_upgrade_schedule,json=notebookUpgradeSchedule,proto3" json:"notebook_upgrade_schedule,omitempty"`
// Verifies core internal services are running.
EnableHealthMonitoring bool `protobuf:"varint,2,opt,name=enable_health_monitoring,json=enableHealthMonitoring,proto3" json:"enable_health_monitoring,omitempty"`
// contains filtered or unexported fields
}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() boolfunc (*InstanceConfig) GetNotebookUpgradeSchedule
func (x *InstanceConfig) GetNotebookUpgradeSchedule() stringfunc (*InstanceConfig) ProtoMessage
func (*InstanceConfig) ProtoMessage()func (*InstanceConfig) ProtoReflect
func (x *InstanceConfig) ProtoReflect() protoreflect.Messagefunc (*InstanceConfig) Reset
func (x *InstanceConfig) Reset()func (*InstanceConfig) String
func (x *InstanceConfig) String() stringInstance_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() int64func (*Instance_AcceleratorConfig) GetType
func (x *Instance_AcceleratorConfig) GetType() Instance_AcceleratorTypefunc (*Instance_AcceleratorConfig) ProtoMessage
func (*Instance_AcceleratorConfig) ProtoMessage()func (*Instance_AcceleratorConfig) ProtoReflect
func (x *Instance_AcceleratorConfig) ProtoReflect() protoreflect.Messagefunc (*Instance_AcceleratorConfig) Reset
func (x *Instance_AcceleratorConfig) Reset()func (*Instance_AcceleratorConfig) String
func (x *Instance_AcceleratorConfig) String() stringInstance_AcceleratorType
type Instance_AcceleratorType int32Definition 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.EnumDescriptorfunc (Instance_AcceleratorType) Enum
func (x Instance_AcceleratorType) Enum() *Instance_AcceleratorTypefunc (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.EnumNumberfunc (Instance_AcceleratorType) String
func (x Instance_AcceleratorType) String() stringfunc (Instance_AcceleratorType) Type
func (Instance_AcceleratorType) Type() protoreflect.EnumTypeInstance_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() boolfunc (*Instance_Disk) GetBoot
func (x *Instance_Disk) GetBoot() boolfunc (*Instance_Disk) GetDeviceName
func (x *Instance_Disk) GetDeviceName() stringfunc (*Instance_Disk) GetDiskSizeGb
func (x *Instance_Disk) GetDiskSizeGb() int64func (*Instance_Disk) GetGuestOsFeatures
func (x *Instance_Disk) GetGuestOsFeatures() []*Instance_Disk_GuestOsFeaturefunc (*Instance_Disk) GetIndex
func (x *Instance_Disk) GetIndex() int64func (*Instance_Disk) GetInterface
func (x *Instance_Disk) GetInterface() stringfunc (*Instance_Disk) GetKind
func (x *Instance_Disk) GetKind() stringfunc (*Instance_Disk) GetLicenses
func (x *Instance_Disk) GetLicenses() []stringfunc (*Instance_Disk) GetMode
func (x *Instance_Disk) GetMode() stringfunc (*Instance_Disk) GetSource
func (x *Instance_Disk) GetSource() stringfunc (*Instance_Disk) GetType
func (x *Instance_Disk) GetType() stringfunc (*Instance_Disk) ProtoMessage
func (*Instance_Disk) ProtoMessage()func (*Instance_Disk) ProtoReflect
func (x *Instance_Disk) ProtoReflect() protoreflect.Messagefunc (*Instance_Disk) Reset
func (x *Instance_Disk) Reset()func (*Instance_Disk) String
func (x *Instance_Disk) String() stringInstance_DiskEncryption
type Instance_DiskEncryption int32Definition 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.EnumDescriptorfunc (Instance_DiskEncryption) Enum
func (x Instance_DiskEncryption) Enum() *Instance_DiskEncryptionfunc (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.EnumNumberfunc (Instance_DiskEncryption) String
func (x Instance_DiskEncryption) String() stringfunc (Instance_DiskEncryption) Type
func (Instance_DiskEncryption) Type() protoreflect.EnumTypeInstance_DiskType
type Instance_DiskType int32Possible 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.EnumDescriptorfunc (Instance_DiskType) Enum
func (x Instance_DiskType) Enum() *Instance_DiskTypefunc (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.EnumNumberfunc (Instance_DiskType) String
func (x Instance_DiskType) String() stringfunc (Instance_DiskType) Type
func (Instance_DiskType) Type() protoreflect.EnumTypeInstance_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() stringfunc (*Instance_Disk_GuestOsFeature) ProtoMessage
func (*Instance_Disk_GuestOsFeature) ProtoMessage()func (*Instance_Disk_GuestOsFeature) ProtoReflect
func (x *Instance_Disk_GuestOsFeature) ProtoReflect() protoreflect.Messagefunc (*Instance_Disk_GuestOsFeature) Reset
func (x *Instance_Disk_GuestOsFeature) Reset()func (*Instance_Disk_GuestOsFeature) String
func (x *Instance_Disk_GuestOsFeature) String() stringInstance_NicType
type Instance_NicType int32The 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.EnumDescriptorfunc (Instance_NicType) Enum
func (x Instance_NicType) Enum() *Instance_NicTypefunc (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.EnumNumberfunc (Instance_NicType) String
func (x Instance_NicType) String() stringfunc (Instance_NicType) Type
func (Instance_NicType) Type() protoreflect.EnumTypeInstance_ShieldedInstanceConfig
type Instance_ShieldedInstanceConfig struct {
// Defines whether the instance has Secure Boot enabled.
//
// Secure Boot helps ensure that the system only runs authentic software by
// verifying the digital signature of all boot components, and halting the
// boot process if signature verification fails. Disabled by default.
EnableSecureBoot bool `protobuf:"varint,1,opt,name=enable_secure_boot,json=enableSecureBoot,proto3" json:"enable_secure_boot,omitempty"`
// Defines whether the instance has the vTPM enabled. Enabled by default.
EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
// Defines whether the instance has integrity monitoring enabled.
//
// Enables monitoring and attestation of the boot integrity of the instance.
// The attestation is performed against the integrity policy baseline. This
// baseline is initially derived from the implicitly trusted boot image when
// the instance is created. Enabled by default.
EnableIntegrityMonitoring bool `protobuf:"varint,3,opt,name=enable_integrity_monitoring,json=enableIntegrityMonitoring,proto3" json:"enable_integrity_monitoring,omitempty"`
// contains filtered or unexported fields
}A set of Shielded Instance options. 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() boolfunc (*Instance_ShieldedInstanceConfig) GetEnableSecureBoot
func (x *Instance_ShieldedInstanceConfig) GetEnableSecureBoot() boolfunc (*Instance_ShieldedInstanceConfig) GetEnableVtpm
func (x *Instance_ShieldedInstanceConfig) GetEnableVtpm() boolfunc (*Instance_ShieldedInstanceConfig) ProtoMessage
func (*Instance_ShieldedInstanceConfig) ProtoMessage()func (*Instance_ShieldedInstanceConfig) ProtoReflect
func (x *Instance_ShieldedInstanceConfig) ProtoReflect() protoreflect.Messagefunc (*Instance_ShieldedInstanceConfig) Reset
func (x *Instance_ShieldedInstanceConfig) Reset()func (*Instance_ShieldedInstanceConfig) String
func (x *Instance_ShieldedInstanceConfig) String() stringInstance_State
type Instance_State int32The 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.EnumDescriptorfunc (Instance_State) Enum
func (x Instance_State) Enum() *Instance_Statefunc (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.EnumNumberfunc (Instance_State) String
func (x Instance_State) String() stringfunc (Instance_State) Type
func (Instance_State) Type() protoreflect.EnumTypeInstance_UpgradeHistoryEntry
type Instance_UpgradeHistoryEntry struct {
// The snapshot of the boot disk of this notebook instance before upgrade.
Snapshot string `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// The VM image before this instance upgrade.
VmImage string `protobuf:"bytes,2,opt,name=vm_image,json=vmImage,proto3" json:"vm_image,omitempty"`
// The container image before this instance upgrade.
ContainerImage string `protobuf:"bytes,3,opt,name=container_image,json=containerImage,proto3" json:"container_image,omitempty"`
// The framework of this notebook instance.
Framework string `protobuf:"bytes,4,opt,name=framework,proto3" json:"framework,omitempty"`
// The version of the notebook instance before this upgrade.
Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
// The state of this instance upgrade history entry.
State Instance_UpgradeHistoryEntry_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.notebooks.v1.Instance_UpgradeHistoryEntry_State" json:"state,omitempty"`
// The time that this instance upgrade history entry is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
//
// Deprecated: Marked as deprecated in google/cloud/notebooks/v1/instance.proto.
TargetImage string `protobuf:"bytes,8,opt,name=target_image,json=targetImage,proto3" json:"target_image,omitempty"`
// Action. Rolloback or Upgrade.
Action Instance_UpgradeHistoryEntry_Action `protobuf:"varint,9,opt,name=action,proto3,enum=google.cloud.notebooks.v1.Instance_UpgradeHistoryEntry_Action" json:"action,omitempty"`
// Target VM Version, like m63.
TargetVersion string `protobuf:"bytes,10,opt,name=target_version,json=targetVersion,proto3" json:"target_version,omitempty"`
// contains filtered or unexported fields
}The entry of VM image upgrade history.
func (*Instance_UpgradeHistoryEntry) 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_Actionfunc (*Instance_UpgradeHistoryEntry) GetContainerImage
func (x *Instance_UpgradeHistoryEntry) GetContainerImage() stringfunc (*Instance_UpgradeHistoryEntry) GetCreateTime
func (x *Instance_UpgradeHistoryEntry) GetCreateTime() *timestamppb.Timestampfunc (*Instance_UpgradeHistoryEntry) GetFramework
func (x *Instance_UpgradeHistoryEntry) GetFramework() stringfunc (*Instance_UpgradeHistoryEntry) GetSnapshot
func (x *Instance_UpgradeHistoryEntry) GetSnapshot() stringfunc (*Instance_UpgradeHistoryEntry) GetState
func (x *Instance_UpgradeHistoryEntry) GetState() Instance_UpgradeHistoryEntry_Statefunc (*Instance_UpgradeHistoryEntry) GetTargetImage
func (x *Instance_UpgradeHistoryEntry) GetTargetImage() stringDeprecated: Marked as deprecated in google/cloud/notebooks/v1/instance.proto.
func (*Instance_UpgradeHistoryEntry) GetTargetVersion
func (x *Instance_UpgradeHistoryEntry) GetTargetVersion() stringfunc (*Instance_UpgradeHistoryEntry) GetVersion
func (x *Instance_UpgradeHistoryEntry) GetVersion() stringfunc (*Instance_UpgradeHistoryEntry) GetVmImage
func (x *Instance_UpgradeHistoryEntry) GetVmImage() stringfunc (*Instance_UpgradeHistoryEntry) ProtoMessage
func (*Instance_UpgradeHistoryEntry) ProtoMessage()func (*Instance_UpgradeHistoryEntry) ProtoReflect
func (x *Instance_UpgradeHistoryEntry) ProtoReflect() protoreflect.Messagefunc (*Instance_UpgradeHistoryEntry) Reset
func (x *Instance_UpgradeHistoryEntry) Reset()func (*Instance_UpgradeHistoryEntry) String
func (x *Instance_UpgradeHistoryEntry) String() stringInstance_UpgradeHistoryEntry_Action
type Instance_UpgradeHistoryEntry_Action int32The 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.EnumDescriptorfunc (Instance_UpgradeHistoryEntry_Action) Enum
func (x Instance_UpgradeHistoryEntry_Action) Enum() *Instance_UpgradeHistoryEntry_Actionfunc (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.EnumNumberfunc (Instance_UpgradeHistoryEntry_Action) String
func (x Instance_UpgradeHistoryEntry_Action) String() stringfunc (Instance_UpgradeHistoryEntry_Action) Type
func (Instance_UpgradeHistoryEntry_Action) Type() protoreflect.EnumTypeInstance_UpgradeHistoryEntry_State
type Instance_UpgradeHistoryEntry_State int32The 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.EnumDescriptorfunc (Instance_UpgradeHistoryEntry_State) Enum
func (x Instance_UpgradeHistoryEntry_State) Enum() *Instance_UpgradeHistoryEntry_Statefunc (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.EnumNumberfunc (Instance_UpgradeHistoryEntry_State) String
func (x Instance_UpgradeHistoryEntry_State) String() stringfunc (Instance_UpgradeHistoryEntry_State) Type
func (Instance_UpgradeHistoryEntry_State) Type() protoreflect.EnumTypeInstance_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() stringfunc (*IsInstanceUpgradeableRequest) GetType
func (x *IsInstanceUpgradeableRequest) GetType() UpgradeTypefunc (*IsInstanceUpgradeableRequest) ProtoMessage
func (*IsInstanceUpgradeableRequest) ProtoMessage()func (*IsInstanceUpgradeableRequest) ProtoReflect
func (x *IsInstanceUpgradeableRequest) ProtoReflect() protoreflect.Messagefunc (*IsInstanceUpgradeableRequest) Reset
func (x *IsInstanceUpgradeableRequest) Reset()func (*IsInstanceUpgradeableRequest) String
func (x *IsInstanceUpgradeableRequest) String() stringIsInstanceUpgradeableResponse
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() stringfunc (*IsInstanceUpgradeableResponse) GetUpgradeInfo
func (x *IsInstanceUpgradeableResponse) GetUpgradeInfo() stringfunc (*IsInstanceUpgradeableResponse) GetUpgradeVersion
func (x *IsInstanceUpgradeableResponse) GetUpgradeVersion() stringfunc (*IsInstanceUpgradeableResponse) GetUpgradeable
func (x *IsInstanceUpgradeableResponse) GetUpgradeable() boolfunc (*IsInstanceUpgradeableResponse) ProtoMessage
func (*IsInstanceUpgradeableResponse) ProtoMessage()func (*IsInstanceUpgradeableResponse) ProtoReflect
func (x *IsInstanceUpgradeableResponse) ProtoReflect() protoreflect.Messagefunc (*IsInstanceUpgradeableResponse) Reset
func (x *IsInstanceUpgradeableResponse) Reset()func (*IsInstanceUpgradeableResponse) String
func (x *IsInstanceUpgradeableResponse) String() stringListEnvironmentsRequest
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() int32func (*ListEnvironmentsRequest) GetPageToken
func (x *ListEnvironmentsRequest) GetPageToken() stringfunc (*ListEnvironmentsRequest) GetParent
func (x *ListEnvironmentsRequest) GetParent() stringfunc (*ListEnvironmentsRequest) ProtoMessage
func (*ListEnvironmentsRequest) ProtoMessage()func (*ListEnvironmentsRequest) ProtoReflect
func (x *ListEnvironmentsRequest) ProtoReflect() protoreflect.Messagefunc (*ListEnvironmentsRequest) Reset
func (x *ListEnvironmentsRequest) Reset()func (*ListEnvironmentsRequest) String
func (x *ListEnvironmentsRequest) String() stringListEnvironmentsResponse
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() []*Environmentfunc (*ListEnvironmentsResponse) GetNextPageToken
func (x *ListEnvironmentsResponse) GetNextPageToken() stringfunc (*ListEnvironmentsResponse) GetUnreachable
func (x *ListEnvironmentsResponse) GetUnreachable() []stringfunc (*ListEnvironmentsResponse) ProtoMessage
func (*ListEnvironmentsResponse) ProtoMessage()func (*ListEnvironmentsResponse) ProtoReflect
func (x *ListEnvironmentsResponse) ProtoReflect() protoreflect.Messagefunc (*ListEnvironmentsResponse) Reset
func (x *ListEnvironmentsResponse) Reset()func (*ListEnvironmentsResponse) String
func (x *ListEnvironmentsResponse) String() stringListExecutionsRequest
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() stringfunc (*ListExecutionsRequest) GetOrderBy
func (x *ListExecutionsRequest) GetOrderBy() stringfunc (*ListExecutionsRequest) GetPageSize
func (x *ListExecutionsRequest) GetPageSize() int32func (*ListExecutionsRequest) GetPageToken
func (x *ListExecutionsRequest) GetPageToken() stringfunc (*ListExecutionsRequest) GetParent
func (x *ListExecutionsRequest) GetParent() stringfunc (*ListExecutionsRequest) ProtoMessage
func (*ListExecutionsRequest) ProtoMessage()func (*ListExecutionsRequest) ProtoReflect
func (x *ListExecutionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListExecutionsRequest) Reset
func (x *ListExecutionsRequest) Reset()func (*ListExecutionsRequest) String
func (x *ListExecutionsRequest) String() stringListExecutionsResponse
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() []*Executionfunc (*ListExecutionsResponse) GetNextPageToken
func (x *ListExecutionsResponse) GetNextPageToken() stringfunc (*ListExecutionsResponse) GetUnreachable
func (x *ListExecutionsResponse) GetUnreachable() []stringfunc (*ListExecutionsResponse) ProtoMessage
func (*ListExecutionsResponse) ProtoMessage()func (*ListExecutionsResponse) ProtoReflect
func (x *ListExecutionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListExecutionsResponse) Reset
func (x *ListExecutionsResponse) Reset()func (*ListExecutionsResponse) String
func (x *ListExecutionsResponse) String() stringListInstancesRequest
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() int32func (*ListInstancesRequest) GetPageToken
func (x *ListInstancesRequest) GetPageToken() stringfunc (*ListInstancesRequest) GetParent
func (x *ListInstancesRequest) GetParent() stringfunc (*ListInstancesRequest) ProtoMessage
func (*ListInstancesRequest) ProtoMessage()func (*ListInstancesRequest) ProtoReflect
func (x *ListInstancesRequest) ProtoReflect() protoreflect.Messagefunc (*ListInstancesRequest) Reset
func (x *ListInstancesRequest) Reset()func (*ListInstancesRequest) String
func (x *ListInstancesRequest) String() stringListInstancesResponse
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() []*Instancefunc (*ListInstancesResponse) GetNextPageToken
func (x *ListInstancesResponse) GetNextPageToken() stringfunc (*ListInstancesResponse) GetUnreachable
func (x *ListInstancesResponse) GetUnreachable() []stringfunc (*ListInstancesResponse) ProtoMessage
func (*ListInstancesResponse) ProtoMessage()func (*ListInstancesResponse) ProtoReflect
func (x *ListInstancesResponse) ProtoReflect() protoreflect.Messagefunc (*ListInstancesResponse) Reset
func (x *ListInstancesResponse) Reset()func (*ListInstancesResponse) String
func (x *ListInstancesResponse) String() stringListRuntimesRequest
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() int32func (*ListRuntimesRequest) GetPageToken
func (x *ListRuntimesRequest) GetPageToken() stringfunc (*ListRuntimesRequest) GetParent
func (x *ListRuntimesRequest) GetParent() stringfunc (*ListRuntimesRequest) ProtoMessage
func (*ListRuntimesRequest) ProtoMessage()func (*ListRuntimesRequest) ProtoReflect
func (x *ListRuntimesRequest) ProtoReflect() protoreflect.Messagefunc (*ListRuntimesRequest) Reset
func (x *ListRuntimesRequest) Reset()func (*ListRuntimesRequest) String
func (x *ListRuntimesRequest) String() stringListRuntimesResponse
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() stringfunc (*ListRuntimesResponse) GetRuntimes
func (x *ListRuntimesResponse) GetRuntimes() []*Runtimefunc (*ListRuntimesResponse) GetUnreachable
func (x *ListRuntimesResponse) GetUnreachable() []stringfunc (*ListRuntimesResponse) ProtoMessage
func (*ListRuntimesResponse) ProtoMessage()func (*ListRuntimesResponse) ProtoReflect
func (x *ListRuntimesResponse) ProtoReflect() protoreflect.Messagefunc (*ListRuntimesResponse) Reset
func (x *ListRuntimesResponse) Reset()func (*ListRuntimesResponse) String
func (x *ListRuntimesResponse) String() stringListSchedulesRequest
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() stringfunc (*ListSchedulesRequest) GetOrderBy
func (x *ListSchedulesRequest) GetOrderBy() stringfunc (*ListSchedulesRequest) GetPageSize
func (x *ListSchedulesRequest) GetPageSize() int32func (*ListSchedulesRequest) GetPageToken
func (x *ListSchedulesRequest) GetPageToken() stringfunc (*ListSchedulesRequest) GetParent
func (x *ListSchedulesRequest) GetParent() stringfunc (*ListSchedulesRequest) ProtoMessage
func (*ListSchedulesRequest) ProtoMessage()func (*ListSchedulesRequest) ProtoReflect
func (x *ListSchedulesRequest) ProtoReflect() protoreflect.Messagefunc (*ListSchedulesRequest) Reset
func (x *ListSchedulesRequest) Reset()func (*ListSchedulesRequest) String
func (x *ListSchedulesRequest) String() stringListSchedulesResponse
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() stringfunc (*ListSchedulesResponse) GetSchedules
func (x *ListSchedulesResponse) GetSchedules() []*Schedulefunc (*ListSchedulesResponse) GetUnreachable
func (x *ListSchedulesResponse) GetUnreachable() []stringfunc (*ListSchedulesResponse) ProtoMessage
func (*ListSchedulesResponse) ProtoMessage()func (*ListSchedulesResponse) ProtoReflect
func (x *ListSchedulesResponse) ProtoReflect() protoreflect.Messagefunc (*ListSchedulesResponse) Reset
func (x *ListSchedulesResponse) Reset()func (*ListSchedulesResponse) String
func (x *ListSchedulesResponse) String() stringLocalDisk
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_RuntimeGuestOsFeaturefunc (*LocalDisk) GetIndex
func (*LocalDisk) GetInitializeParams
func (x *LocalDisk) GetInitializeParams() *LocalDiskInitializeParamsfunc (*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.Messagefunc (*LocalDisk) Reset
func (x *LocalDisk) Reset()func (*LocalDisk) String
LocalDiskInitializeParams
type LocalDiskInitializeParams struct {
// Optional. Provide this property when creating the disk.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Specifies the disk name. If not specified, the default is to use the name
// of the instance. If the disk with the instance name exists already in the
// given zone/region, a new name will be automatically generated.
DiskName string `protobuf:"bytes,2,opt,name=disk_name,json=diskName,proto3" json:"disk_name,omitempty"`
// Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk
// will be the same size as the image (usually 10GB). If specified, the size
// must be equal to or larger than 10GB. Default 100 GB.
DiskSizeGb int64 `protobuf:"varint,3,opt,name=disk_size_gb,json=diskSizeGb,proto3" json:"disk_size_gb,omitempty"`
// Input only. The type of the boot disk attached to this instance, defaults to
// standard persistent disk (`PD_STANDARD`).
DiskType LocalDiskInitializeParams_DiskType `protobuf:"varint,4,opt,name=disk_type,json=diskType,proto3,enum=google.cloud.notebooks.v1.LocalDiskInitializeParams_DiskType" json:"disk_type,omitempty"`
// Optional. Labels to apply to this disk. These can be later modified by the
// disks.setLabels method. This field is only applicable for persistent disks.
Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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() stringfunc (*LocalDiskInitializeParams) GetDiskName
func (x *LocalDiskInitializeParams) GetDiskName() stringfunc (*LocalDiskInitializeParams) GetDiskSizeGb
func (x *LocalDiskInitializeParams) GetDiskSizeGb() int64func (*LocalDiskInitializeParams) GetDiskType
func (x *LocalDiskInitializeParams) GetDiskType() LocalDiskInitializeParams_DiskTypefunc (*LocalDiskInitializeParams) GetLabels
func (x *LocalDiskInitializeParams) GetLabels() map[string]stringfunc (*LocalDiskInitializeParams) ProtoMessage
func (*LocalDiskInitializeParams) ProtoMessage()func (*LocalDiskInitializeParams) ProtoReflect
func (x *LocalDiskInitializeParams) ProtoReflect() protoreflect.Messagefunc (*LocalDiskInitializeParams) Reset
func (x *LocalDiskInitializeParams) Reset()func (*LocalDiskInitializeParams) String
func (x *LocalDiskInitializeParams) String() stringLocalDiskInitializeParams_DiskType
type LocalDiskInitializeParams_DiskType int32Possible 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.EnumDescriptorfunc (LocalDiskInitializeParams_DiskType) Enum
func (x LocalDiskInitializeParams_DiskType) Enum() *LocalDiskInitializeParams_DiskTypefunc (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.EnumNumberfunc (LocalDiskInitializeParams_DiskType) String
func (x LocalDiskInitializeParams_DiskType) String() stringfunc (LocalDiskInitializeParams_DiskType) Type
func (LocalDiskInitializeParams_DiskType) Type() protoreflect.EnumTypeLocalDisk_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() stringfunc (*LocalDisk_RuntimeGuestOsFeature) ProtoMessage
func (*LocalDisk_RuntimeGuestOsFeature) ProtoMessage()func (*LocalDisk_RuntimeGuestOsFeature) ProtoReflect
func (x *LocalDisk_RuntimeGuestOsFeature) ProtoReflect() protoreflect.Messagefunc (*LocalDisk_RuntimeGuestOsFeature) Reset
func (x *LocalDisk_RuntimeGuestOsFeature) Reset()func (*LocalDisk_RuntimeGuestOsFeature) String
func (x *LocalDisk_RuntimeGuestOsFeature) String() stringManagedNotebookServiceClient
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) (*longrunningpb.Operation, error)
// Update Notebook Runtime configuration.
UpdateRuntime(ctx context.Context, in *UpdateRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a single Runtime.
DeleteRuntime(ctx context.Context, in *DeleteRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Switch a Managed Notebook Runtime.
SwitchRuntime(ctx context.Context, in *SwitchRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Resets a Managed Notebook Runtime.
ResetRuntime(ctx context.Context, in *ResetRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Upgrades a Managed Notebook Runtime to the latest version.
UpgradeRuntime(ctx context.Context, in *UpgradeRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Report and process a runtime event.
ReportRuntimeEvent(ctx context.Context, in *ReportRuntimeEventRequest, opts ...grpc.CallOption) (*longrunningpb.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)
// Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
DiagnoseRuntime(ctx context.Context, in *DiagnoseRuntimeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}ManagedNotebookServiceClient is the client API for ManagedNotebookService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewManagedNotebookServiceClient
func NewManagedNotebookServiceClient(cc grpc.ClientConnInterface) ManagedNotebookServiceClientManagedNotebookServiceServer
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) (*longrunningpb.Operation, error)
// Update Notebook Runtime configuration.
UpdateRuntime(context.Context, *UpdateRuntimeRequest) (*longrunningpb.Operation, error)
// Deletes a single Runtime.
DeleteRuntime(context.Context, *DeleteRuntimeRequest) (*longrunningpb.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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Switch a Managed Notebook Runtime.
SwitchRuntime(context.Context, *SwitchRuntimeRequest) (*longrunningpb.Operation, error)
// Resets a Managed Notebook Runtime.
ResetRuntime(context.Context, *ResetRuntimeRequest) (*longrunningpb.Operation, error)
// Upgrades a Managed Notebook Runtime to the latest version.
UpgradeRuntime(context.Context, *UpgradeRuntimeRequest) (*longrunningpb.Operation, error)
// Report and process a runtime event.
ReportRuntimeEvent(context.Context, *ReportRuntimeEventRequest) (*longrunningpb.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)
// Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.
DiagnoseRuntime(context.Context, *DiagnoseRuntimeRequest) (*longrunningpb.Operation, error)
}ManagedNotebookServiceServer is the server API for ManagedNotebookService service. All implementations should embed UnimplementedManagedNotebookServiceServer for forward compatibility
NotebookServiceClient
type NotebookServiceClient interface {
// Lists instances in a given project and location.
ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
// Gets details of a single Instance.
GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
// Creates a new Instance in a given project and location.
CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// 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) (*longrunningpb.Operation, error)
// Updates the guest accelerators of a single Instance.
SetInstanceAccelerator(ctx context.Context, in *SetInstanceAcceleratorRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the machine type of a single Instance.
SetInstanceMachineType(ctx context.Context, in *SetInstanceMachineTypeRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Update Notebook Instance configurations.
UpdateInstanceConfig(ctx context.Context, in *UpdateInstanceConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the Shielded instance configuration of a single Instance.
UpdateShieldedInstanceConfig(ctx context.Context, in *UpdateShieldedInstanceConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Replaces all the labels of an Instance.
SetInstanceLabels(ctx context.Context, in *SetInstanceLabelsRequest, opts ...grpc.CallOption) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Starts a notebook instance.
StartInstance(ctx context.Context, in *StartInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Stops a notebook instance.
StopInstance(ctx context.Context, in *StopInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Resets a notebook instance.
ResetInstance(ctx context.Context, in *ResetInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// 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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Rollbacks a notebook instance to the previous version.
RollbackInstance(ctx context.Context, in *RollbackInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
DiagnoseInstance(ctx context.Context, in *DiagnoseInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// 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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Deletes a single Environment.
DeleteEnvironment(ctx context.Context, in *DeleteEnvironmentRequest, opts ...grpc.CallOption) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Creates a new Scheduled Notebook in a given project and location.
CreateSchedule(ctx context.Context, in *CreateScheduleRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Triggers execution of an existing schedule.
TriggerSchedule(ctx context.Context, in *TriggerScheduleRequest, opts ...grpc.CallOption) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Creates a new Execution in a given project and location.
CreateExecution(ctx context.Context, in *CreateExecutionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}NotebookServiceClient is the client API for NotebookService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewNotebookServiceClient
func NewNotebookServiceClient(cc grpc.ClientConnInterface) NotebookServiceClientNotebookServiceServer
type NotebookServiceServer interface {
// Lists instances in a given project and location.
ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
// Gets details of a single Instance.
GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
// Creates a new Instance in a given project and location.
CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
// 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) (*longrunningpb.Operation, error)
// Updates the guest accelerators of a single Instance.
SetInstanceAccelerator(context.Context, *SetInstanceAcceleratorRequest) (*longrunningpb.Operation, error)
// Updates the machine type of a single Instance.
SetInstanceMachineType(context.Context, *SetInstanceMachineTypeRequest) (*longrunningpb.Operation, error)
// Update Notebook Instance configurations.
UpdateInstanceConfig(context.Context, *UpdateInstanceConfigRequest) (*longrunningpb.Operation, error)
// Updates the Shielded instance configuration of a single Instance.
UpdateShieldedInstanceConfig(context.Context, *UpdateShieldedInstanceConfigRequest) (*longrunningpb.Operation, error)
// Replaces all the labels of an Instance.
SetInstanceLabels(context.Context, *SetInstanceLabelsRequest) (*longrunningpb.Operation, error)
// Add/update metadata items for an instance.
UpdateInstanceMetadataItems(context.Context, *UpdateInstanceMetadataItemsRequest) (*UpdateInstanceMetadataItemsResponse, error)
// Deletes a single Instance.
DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)
// Starts a notebook instance.
StartInstance(context.Context, *StartInstanceRequest) (*longrunningpb.Operation, error)
// Stops a notebook instance.
StopInstance(context.Context, *StopInstanceRequest) (*longrunningpb.Operation, error)
// Resets a notebook instance.
ResetInstance(context.Context, *ResetInstanceRequest) (*longrunningpb.Operation, error)
// 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) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Rollbacks a notebook instance to the previous version.
RollbackInstance(context.Context, *RollbackInstanceRequest) (*longrunningpb.Operation, error)
// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
DiagnoseInstance(context.Context, *DiagnoseInstanceRequest) (*longrunningpb.Operation, error)
// Allows notebook instances to
// call this endpoint to upgrade themselves. Do not use this method directly.
UpgradeInstanceInternal(context.Context, *UpgradeInstanceInternalRequest) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Deletes a single Environment.
DeleteEnvironment(context.Context, *DeleteEnvironmentRequest) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Creates a new Scheduled Notebook in a given project and location.
CreateSchedule(context.Context, *CreateScheduleRequest) (*longrunningpb.Operation, error)
// Triggers execution of an existing schedule.
TriggerSchedule(context.Context, *TriggerScheduleRequest) (*longrunningpb.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) (*longrunningpb.Operation, error)
// Creates a new Execution in a given project and location.
CreateExecution(context.Context, *CreateExecutionRequest) (*longrunningpb.Operation, error)
}NotebookServiceServer is the server API for NotebookService service. All implementations should embed UnimplementedNotebookServiceServer for forward compatibility
OperationMetadata
type OperationMetadata struct {
// The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Server-defined resource path for the target of the operation.
Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Name of the verb executed by the operation.
Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Human-readable status of the operation, if any.
StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
// have [Operation.error][] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// API version used to start the operation.
ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// API endpoint name of this operation.
Endpoint string `protobuf:"bytes,8,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
// contains filtered or unexported fields
}Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
func (*OperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() stringfunc (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndpoint
func (x *OperationMetadata) GetEndpoint() stringfunc (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() boolfunc (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() stringfunc (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() stringfunc (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() stringfunc (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()func (*OperationMetadata) String
func (x *OperationMetadata) String() stringRefreshRuntimeTokenInternalRequest
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() stringfunc (*RefreshRuntimeTokenInternalRequest) GetVmId
func (x *RefreshRuntimeTokenInternalRequest) GetVmId() stringfunc (*RefreshRuntimeTokenInternalRequest) ProtoMessage
func (*RefreshRuntimeTokenInternalRequest) ProtoMessage()func (*RefreshRuntimeTokenInternalRequest) ProtoReflect
func (x *RefreshRuntimeTokenInternalRequest) ProtoReflect() protoreflect.Messagefunc (*RefreshRuntimeTokenInternalRequest) Reset
func (x *RefreshRuntimeTokenInternalRequest) Reset()func (*RefreshRuntimeTokenInternalRequest) String
func (x *RefreshRuntimeTokenInternalRequest) String() stringRefreshRuntimeTokenInternalResponse
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 *timestamppb.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() stringfunc (*RefreshRuntimeTokenInternalResponse) GetExpireTime
func (x *RefreshRuntimeTokenInternalResponse) GetExpireTime() *timestamppb.Timestampfunc (*RefreshRuntimeTokenInternalResponse) ProtoMessage
func (*RefreshRuntimeTokenInternalResponse) ProtoMessage()func (*RefreshRuntimeTokenInternalResponse) ProtoReflect
func (x *RefreshRuntimeTokenInternalResponse) ProtoReflect() protoreflect.Messagefunc (*RefreshRuntimeTokenInternalResponse) Reset
func (x *RefreshRuntimeTokenInternalResponse) Reset()func (*RefreshRuntimeTokenInternalResponse) String
func (x *RefreshRuntimeTokenInternalResponse) String() stringRegisterInstanceRequest
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() stringfunc (*RegisterInstanceRequest) GetParent
func (x *RegisterInstanceRequest) GetParent() stringfunc (*RegisterInstanceRequest) ProtoMessage
func (*RegisterInstanceRequest) ProtoMessage()func (*RegisterInstanceRequest) ProtoReflect
func (x *RegisterInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*RegisterInstanceRequest) Reset
func (x *RegisterInstanceRequest) Reset()func (*RegisterInstanceRequest) String
func (x *RegisterInstanceRequest) String() stringReportInstanceInfoRequest
type ReportInstanceInfoRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The VM hardware token for authenticating the VM.
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
VmId string `protobuf:"bytes,2,opt,name=vm_id,json=vmId,proto3" json:"vm_id,omitempty"`
// The metadata reported to Notebooks API. This will be merged to the instance
// metadata store
Metadata map[string]string `protobuf:"bytes,3,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Request for notebook instances to report information to Notebooks API.
func (*ReportInstanceInfoRequest) Descriptor
func (*ReportInstanceInfoRequest) Descriptor() ([]byte, []int)Deprecated: Use ReportInstanceInfoRequest.ProtoReflect.Descriptor instead.
func (*ReportInstanceInfoRequest) GetMetadata
func (x *ReportInstanceInfoRequest) GetMetadata() map[string]stringfunc (*ReportInstanceInfoRequest) GetName
func (x *ReportInstanceInfoRequest) GetName() stringfunc (*ReportInstanceInfoRequest) GetVmId
func (x *ReportInstanceInfoRequest) GetVmId() stringfunc (*ReportInstanceInfoRequest) ProtoMessage
func (*ReportInstanceInfoRequest) ProtoMessage()func (*ReportInstanceInfoRequest) ProtoReflect
func (x *ReportInstanceInfoRequest) ProtoReflect() protoreflect.Messagefunc (*ReportInstanceInfoRequest) Reset
func (x *ReportInstanceInfoRequest) Reset()func (*ReportInstanceInfoRequest) String
func (x *ReportInstanceInfoRequest) String() stringReportRuntimeEventRequest
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() *Eventfunc (*ReportRuntimeEventRequest) GetName
func (x *ReportRuntimeEventRequest) GetName() stringfunc (*ReportRuntimeEventRequest) GetVmId
func (x *ReportRuntimeEventRequest) GetVmId() stringfunc (*ReportRuntimeEventRequest) ProtoMessage
func (*ReportRuntimeEventRequest) ProtoMessage()func (*ReportRuntimeEventRequest) ProtoReflect
func (x *ReportRuntimeEventRequest) ProtoReflect() protoreflect.Messagefunc (*ReportRuntimeEventRequest) Reset
func (x *ReportRuntimeEventRequest) Reset()func (*ReportRuntimeEventRequest) String
func (x *ReportRuntimeEventRequest) String() stringReservationAffinity
type ReservationAffinity struct {
// Optional. Type of reservation to consume
ConsumeReservationType ReservationAffinity_Type `protobuf:"varint,1,opt,name=consume_reservation_type,json=consumeReservationType,proto3,enum=google.cloud.notebooks.v1.ReservationAffinity_Type" json:"consume_reservation_type,omitempty"`
// Optional. Corresponds to the label key of reservation resource.
Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
// Optional. Corresponds to the label values of reservation resource.
Values []string `protobuf:"bytes,3,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}Reservation Affinity for consuming Zonal reservation.
func (*ReservationAffinity) Descriptor
func (*ReservationAffinity) Descriptor() ([]byte, []int)Deprecated: Use ReservationAffinity.ProtoReflect.Descriptor instead.
func (*ReservationAffinity) GetConsumeReservationType
func (x *ReservationAffinity) GetConsumeReservationType() ReservationAffinity_Typefunc (*ReservationAffinity) GetKey
func (x *ReservationAffinity) GetKey() stringfunc (*ReservationAffinity) GetValues
func (x *ReservationAffinity) GetValues() []stringfunc (*ReservationAffinity) ProtoMessage
func (*ReservationAffinity) ProtoMessage()func (*ReservationAffinity) ProtoReflect
func (x *ReservationAffinity) ProtoReflect() protoreflect.Messagefunc (*ReservationAffinity) Reset
func (x *ReservationAffinity) Reset()func (*ReservationAffinity) String
func (x *ReservationAffinity) String() stringReservationAffinity_Type
type ReservationAffinity_Type int32Indicates 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.EnumDescriptorfunc (ReservationAffinity_Type) Enum
func (x ReservationAffinity_Type) Enum() *ReservationAffinity_Typefunc (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.EnumNumberfunc (ReservationAffinity_Type) String
func (x ReservationAffinity_Type) String() stringfunc (ReservationAffinity_Type) Type
func (ReservationAffinity_Type) Type() protoreflect.EnumTypeResetInstanceRequest
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() stringfunc (*ResetInstanceRequest) ProtoMessage
func (*ResetInstanceRequest) ProtoMessage()func (*ResetInstanceRequest) ProtoReflect
func (x *ResetInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*ResetInstanceRequest) Reset
func (x *ResetInstanceRequest) Reset()func (*ResetInstanceRequest) String
func (x *ResetInstanceRequest) String() stringResetRuntimeRequest
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() stringfunc (*ResetRuntimeRequest) GetRequestId
func (x *ResetRuntimeRequest) GetRequestId() stringfunc (*ResetRuntimeRequest) ProtoMessage
func (*ResetRuntimeRequest) ProtoMessage()func (*ResetRuntimeRequest) ProtoReflect
func (x *ResetRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*ResetRuntimeRequest) Reset
func (x *ResetRuntimeRequest) Reset()func (*ResetRuntimeRequest) String
func (x *ResetRuntimeRequest) String() stringRollbackInstanceRequest
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() stringfunc (*RollbackInstanceRequest) GetTargetSnapshot
func (x *RollbackInstanceRequest) GetTargetSnapshot() stringfunc (*RollbackInstanceRequest) ProtoMessage
func (*RollbackInstanceRequest) ProtoMessage()func (*RollbackInstanceRequest) ProtoReflect
func (x *RollbackInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*RollbackInstanceRequest) Reset
func (x *RollbackInstanceRequest) Reset()func (*RollbackInstanceRequest) String
func (x *RollbackInstanceRequest) String() stringRuntime
type Runtime struct {
// Output only. The resource name of the runtime.
// Format:
// `projects/{project}/locations/{location}/runtimes/{runtimeId}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Type of the runtime; currently only supports Compute Engine VM.
//
// Types that are assignable to RuntimeType:
//
// *Runtime_VirtualMachine
RuntimeType isRuntime_RuntimeType `protobuf_oneof:"runtime_type"`
// Output only. Runtime state.
State Runtime_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.notebooks.v1.Runtime_State" json:"state,omitempty"`
// Output only. Runtime health_state.
HealthState Runtime_HealthState `protobuf:"varint,4,opt,name=health_state,json=healthState,proto3,enum=google.cloud.notebooks.v1.Runtime_HealthState" json:"health_state,omitempty"`
// The config settings for accessing runtime.
AccessConfig *RuntimeAccessConfig `protobuf:"bytes,5,opt,name=access_config,json=accessConfig,proto3" json:"access_config,omitempty"`
// The config settings for software inside the runtime.
SoftwareConfig *RuntimeSoftwareConfig `protobuf:"bytes,6,opt,name=software_config,json=softwareConfig,proto3" json:"software_config,omitempty"`
// Output only. Contains Runtime daemon metrics such as Service status and JupyterLab
// stats.
Metrics *RuntimeMetrics `protobuf:"bytes,7,opt,name=metrics,proto3" json:"metrics,omitempty"`
// Output only. Runtime creation time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Runtime update time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}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() *RuntimeAccessConfigfunc (*Runtime) GetCreateTime
func (x *Runtime) GetCreateTime() *timestamppb.Timestampfunc (*Runtime) GetHealthState
func (x *Runtime) GetHealthState() Runtime_HealthStatefunc (*Runtime) GetMetrics
func (x *Runtime) GetMetrics() *RuntimeMetricsfunc (*Runtime) GetName
func (*Runtime) GetRuntimeType
func (m *Runtime) GetRuntimeType() isRuntime_RuntimeTypefunc (*Runtime) GetSoftwareConfig
func (x *Runtime) GetSoftwareConfig() *RuntimeSoftwareConfigfunc (*Runtime) GetState
func (x *Runtime) GetState() Runtime_Statefunc (*Runtime) GetUpdateTime
func (x *Runtime) GetUpdateTime() *timestamppb.Timestampfunc (*Runtime) GetVirtualMachine
func (x *Runtime) GetVirtualMachine() *VirtualMachinefunc (*Runtime) ProtoMessage
func (*Runtime) ProtoMessage()func (*Runtime) ProtoReflect
func (x *Runtime) ProtoReflect() protoreflect.Messagefunc (*Runtime) Reset
func (x *Runtime) Reset()func (*Runtime) String
RuntimeAcceleratorConfig
type RuntimeAcceleratorConfig struct {
// Accelerator model.
Type RuntimeAcceleratorConfig_AcceleratorType `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.notebooks.v1.RuntimeAcceleratorConfig_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 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-k80nvidia-tesla-p100nvidia-tesla-v100nvidia-tesla-p4nvidia-tesla-t4nvidia-tesla-a100
func (*RuntimeAcceleratorConfig) Descriptor
func (*RuntimeAcceleratorConfig) Descriptor() ([]byte, []int)Deprecated: Use RuntimeAcceleratorConfig.ProtoReflect.Descriptor instead.
func (*RuntimeAcceleratorConfig) GetCoreCount
func (x *RuntimeAcceleratorConfig) GetCoreCount() int64func (*RuntimeAcceleratorConfig) GetType
func (x *RuntimeAcceleratorConfig) GetType() RuntimeAcceleratorConfig_AcceleratorTypefunc (*RuntimeAcceleratorConfig) ProtoMessage
func (*RuntimeAcceleratorConfig) ProtoMessage()func (*RuntimeAcceleratorConfig) ProtoReflect
func (x *RuntimeAcceleratorConfig) ProtoReflect() protoreflect.Messagefunc (*RuntimeAcceleratorConfig) Reset
func (x *RuntimeAcceleratorConfig) Reset()func (*RuntimeAcceleratorConfig) String
func (x *RuntimeAcceleratorConfig) String() stringRuntimeAcceleratorConfig_AcceleratorType
type RuntimeAcceleratorConfig_AcceleratorType int32Type 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.
//
// Deprecated: Marked as deprecated in google/cloud/notebooks/v1/runtime.proto.
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.EnumDescriptorfunc (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.EnumNumberfunc (RuntimeAcceleratorConfig_AcceleratorType) String
func (x RuntimeAcceleratorConfig_AcceleratorType) String() stringfunc (RuntimeAcceleratorConfig_AcceleratorType) Type
func (RuntimeAcceleratorConfig_AcceleratorType) Type() protoreflect.EnumTypeRuntimeAccessConfig
type RuntimeAccessConfig struct {
// The type of access mode this instance.
AccessType RuntimeAccessConfig_RuntimeAccessType `protobuf:"varint,1,opt,name=access_type,json=accessType,proto3,enum=google.cloud.notebooks.v1.RuntimeAccessConfig_RuntimeAccessType" json:"access_type,omitempty"`
// The owner of this runtime after creation. Format: `alias@example.com`
// Currently supports one owner only.
RuntimeOwner string `protobuf:"bytes,2,opt,name=runtime_owner,json=runtimeOwner,proto3" json:"runtime_owner,omitempty"`
// Output only. The proxy endpoint that is used to access the runtime.
ProxyUri string `protobuf:"bytes,3,opt,name=proxy_uri,json=proxyUri,proto3" json:"proxy_uri,omitempty"`
// contains filtered or unexported fields
}Specifies the login configuration for Runtime
func (*RuntimeAccessConfig) Descriptor
func (*RuntimeAccessConfig) Descriptor() ([]byte, []int)Deprecated: Use RuntimeAccessConfig.ProtoReflect.Descriptor instead.
func (*RuntimeAccessConfig) GetAccessType
func (x *RuntimeAccessConfig) GetAccessType() RuntimeAccessConfig_RuntimeAccessTypefunc (*RuntimeAccessConfig) GetProxyUri
func (x *RuntimeAccessConfig) GetProxyUri() stringfunc (*RuntimeAccessConfig) GetRuntimeOwner
func (x *RuntimeAccessConfig) GetRuntimeOwner() stringfunc (*RuntimeAccessConfig) ProtoMessage
func (*RuntimeAccessConfig) ProtoMessage()func (*RuntimeAccessConfig) ProtoReflect
func (x *RuntimeAccessConfig) ProtoReflect() protoreflect.Messagefunc (*RuntimeAccessConfig) Reset
func (x *RuntimeAccessConfig) Reset()func (*RuntimeAccessConfig) String
func (x *RuntimeAccessConfig) String() stringRuntimeAccessConfig_RuntimeAccessType
type RuntimeAccessConfig_RuntimeAccessType int32Possible 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.EnumDescriptorfunc (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.EnumNumberfunc (RuntimeAccessConfig_RuntimeAccessType) String
func (x RuntimeAccessConfig_RuntimeAccessType) String() stringfunc (RuntimeAccessConfig_RuntimeAccessType) Type
func (RuntimeAccessConfig_RuntimeAccessType) Type() protoreflect.EnumTypeRuntimeMetrics
type RuntimeMetrics struct {
// Output only. The system metrics.
SystemMetrics map[string]string `protobuf:"bytes,1,rep,name=system_metrics,json=systemMetrics,proto3" json:"system_metrics,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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]stringfunc (*RuntimeMetrics) ProtoMessage
func (*RuntimeMetrics) ProtoMessage()func (*RuntimeMetrics) ProtoReflect
func (x *RuntimeMetrics) ProtoReflect() protoreflect.Messagefunc (*RuntimeMetrics) Reset
func (x *RuntimeMetrics) Reset()func (*RuntimeMetrics) String
func (x *RuntimeMetrics) String() stringRuntimeShieldedInstanceConfig
type RuntimeShieldedInstanceConfig struct {
// Defines whether the instance has Secure Boot enabled.
//
// Secure Boot helps ensure that the system only runs authentic software by
// verifying the digital signature of all boot components, and halting the
// boot process if signature verification fails. Disabled by default.
EnableSecureBoot bool `protobuf:"varint,1,opt,name=enable_secure_boot,json=enableSecureBoot,proto3" json:"enable_secure_boot,omitempty"`
// Defines whether the instance has the vTPM enabled. Enabled by default.
EnableVtpm bool `protobuf:"varint,2,opt,name=enable_vtpm,json=enableVtpm,proto3" json:"enable_vtpm,omitempty"`
// Defines whether the instance has integrity monitoring enabled.
//
// Enables monitoring and attestation of the boot integrity of the instance.
// The attestation is performed against the integrity policy baseline. This
// baseline is initially derived from the implicitly trusted boot image when
// the instance is created. Enabled by default.
EnableIntegrityMonitoring bool `protobuf:"varint,3,opt,name=enable_integrity_monitoring,json=enableIntegrityMonitoring,proto3" json:"enable_integrity_monitoring,omitempty"`
// contains filtered or unexported fields
}A set of Shielded Instance options. 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() boolfunc (*RuntimeShieldedInstanceConfig) GetEnableSecureBoot
func (x *RuntimeShieldedInstanceConfig) GetEnableSecureBoot() boolfunc (*RuntimeShieldedInstanceConfig) GetEnableVtpm
func (x *RuntimeShieldedInstanceConfig) GetEnableVtpm() boolfunc (*RuntimeShieldedInstanceConfig) ProtoMessage
func (*RuntimeShieldedInstanceConfig) ProtoMessage()func (*RuntimeShieldedInstanceConfig) ProtoReflect
func (x *RuntimeShieldedInstanceConfig) ProtoReflect() protoreflect.Messagefunc (*RuntimeShieldedInstanceConfig) Reset
func (x *RuntimeShieldedInstanceConfig) Reset()func (*RuntimeShieldedInstanceConfig) String
func (x *RuntimeShieldedInstanceConfig) String() stringRuntimeSoftwareConfig
type RuntimeSoftwareConfig struct {
// Cron expression in UTC timezone, used to schedule instance auto upgrade.
// Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
NotebookUpgradeSchedule string `protobuf:"bytes,1,opt,name=notebook_upgrade_schedule,json=notebookUpgradeSchedule,proto3" json:"notebook_upgrade_schedule,omitempty"`
// Verifies core internal services are running.
// Default: True
EnableHealthMonitoring *bool `protobuf:"varint,2,opt,name=enable_health_monitoring,json=enableHealthMonitoring,proto3,oneof" json:"enable_health_monitoring,omitempty"`
// Runtime will automatically shutdown after idle_shutdown_time.
// Default: True
IdleShutdown *bool `protobuf:"varint,3,opt,name=idle_shutdown,json=idleShutdown,proto3,oneof" json:"idle_shutdown,omitempty"`
// Time in minutes to wait before shutting down runtime. Default: 180 minutes
IdleShutdownTimeout int32 `protobuf:"varint,4,opt,name=idle_shutdown_timeout,json=idleShutdownTimeout,proto3" json:"idle_shutdown_timeout,omitempty"`
// Install Nvidia Driver automatically.
// Default: True
InstallGpuDriver bool `protobuf:"varint,5,opt,name=install_gpu_driver,json=installGpuDriver,proto3" json:"install_gpu_driver,omitempty"`
// Specify a custom Cloud Storage path where the GPU driver is stored.
// If not specified, we'll automatically choose from official GPU drivers.
CustomGpuDriverPath string `protobuf:"bytes,6,opt,name=custom_gpu_driver_path,json=customGpuDriverPath,proto3" json:"custom_gpu_driver_path,omitempty"`
// Path to a Bash script that automatically runs after a notebook instance
// fully boots up. The path must be a URL or
// Cloud Storage path (`gs://path-to-file/file-name`).
PostStartupScript string `protobuf:"bytes,7,opt,name=post_startup_script,json=postStartupScript,proto3" json:"post_startup_script,omitempty"`
// Optional. Use a list of container images to use as Kernels in the notebook instance.
Kernels []*ContainerImage `protobuf:"bytes,8,rep,name=kernels,proto3" json:"kernels,omitempty"`
// Output only. Bool indicating whether an newer image is available in an image family.
Upgradeable *bool `protobuf:"varint,9,opt,name=upgradeable,proto3,oneof" json:"upgradeable,omitempty"`
// Behavior for the post startup script.
PostStartupScriptBehavior RuntimeSoftwareConfig_PostStartupScriptBehavior `protobuf:"varint,10,opt,name=post_startup_script_behavior,json=postStartupScriptBehavior,proto3,enum=google.cloud.notebooks.v1.RuntimeSoftwareConfig_PostStartupScriptBehavior" json:"post_startup_script_behavior,omitempty"`
// Bool indicating whether JupyterLab terminal will be available or not.
// Default: False
DisableTerminal *bool `protobuf:"varint,11,opt,name=disable_terminal,json=disableTerminal,proto3,oneof" json:"disable_terminal,omitempty"`
// Output only. version of boot image such as M100, from release label of the image.
Version *string `protobuf:"bytes,12,opt,name=version,proto3,oneof" json:"version,omitempty"`
// contains filtered or unexported fields
}Specifies the selection and configuration of software inside the runtime.
The properties to set on runtime.
Properties keys are specified in key:value format, for example:
idle_shutdown: trueidle_shutdown_timeout: 180enable_health_monitoring: true
func (*RuntimeSoftwareConfig) Descriptor
func (*RuntimeSoftwareConfig) Descriptor() ([]byte, []int)Deprecated: Use RuntimeSoftwareConfig.ProtoReflect.Descriptor instead.
func (*RuntimeSoftwareConfig) GetCustomGpuDriverPath
func (x *RuntimeSoftwareConfig) GetCustomGpuDriverPath() stringfunc (*RuntimeSoftwareConfig) GetDisableTerminal
func (x *RuntimeSoftwareConfig) GetDisableTerminal() boolfunc (*RuntimeSoftwareConfig) GetEnableHealthMonitoring
func (x *RuntimeSoftwareConfig) GetEnableHealthMonitoring() boolfunc (*RuntimeSoftwareConfig) GetIdleShutdown
func (x *RuntimeSoftwareConfig) GetIdleShutdown() boolfunc (*RuntimeSoftwareConfig) GetIdleShutdownTimeout
func (x *RuntimeSoftwareConfig) GetIdleShutdownTimeout() int32func (*RuntimeSoftwareConfig) GetInstallGpuDriver
func (x *RuntimeSoftwareConfig) GetInstallGpuDriver() boolfunc (*RuntimeSoftwareConfig) GetKernels
func (x *RuntimeSoftwareConfig) GetKernels() []*ContainerImagefunc (*RuntimeSoftwareConfig) GetNotebookUpgradeSchedule
func (x *RuntimeSoftwareConfig) GetNotebookUpgradeSchedule() stringfunc (*RuntimeSoftwareConfig) GetPostStartupScript
func (x *RuntimeSoftwareConfig) GetPostStartupScript() stringfunc (*RuntimeSoftwareConfig) GetPostStartupScriptBehavior
func (x *RuntimeSoftwareConfig) GetPostStartupScriptBehavior() RuntimeSoftwareConfig_PostStartupScriptBehaviorfunc (*RuntimeSoftwareConfig) GetUpgradeable
func (x *RuntimeSoftwareConfig) GetUpgradeable() boolfunc (*RuntimeSoftwareConfig) GetVersion
func (x *RuntimeSoftwareConfig) GetVersion() stringfunc (*RuntimeSoftwareConfig) ProtoMessage
func (*RuntimeSoftwareConfig) ProtoMessage()func (*RuntimeSoftwareConfig) ProtoReflect
func (x *RuntimeSoftwareConfig) ProtoReflect() protoreflect.Messagefunc (*RuntimeSoftwareConfig) Reset
func (x *RuntimeSoftwareConfig) Reset()func (*RuntimeSoftwareConfig) String
func (x *RuntimeSoftwareConfig) String() stringRuntimeSoftwareConfig_PostStartupScriptBehavior
type RuntimeSoftwareConfig_PostStartupScriptBehavior int32Behavior for the post startup script.
RuntimeSoftwareConfig_POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, RuntimeSoftwareConfig_RUN_EVERY_START, RuntimeSoftwareConfig_DOWNLOAD_AND_RUN_EVERY_START
const (
// Unspecified post startup script behavior. Will run only once at creation.
RuntimeSoftwareConfig_POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED RuntimeSoftwareConfig_PostStartupScriptBehavior = 0
// Runs the post startup script provided during creation at every start.
RuntimeSoftwareConfig_RUN_EVERY_START RuntimeSoftwareConfig_PostStartupScriptBehavior = 1
// Downloads and runs the provided post startup script at every start.
RuntimeSoftwareConfig_DOWNLOAD_AND_RUN_EVERY_START RuntimeSoftwareConfig_PostStartupScriptBehavior = 2
)func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Descriptor
func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Descriptor() protoreflect.EnumDescriptorfunc (RuntimeSoftwareConfig_PostStartupScriptBehavior) Enum
func (x RuntimeSoftwareConfig_PostStartupScriptBehavior) Enum() *RuntimeSoftwareConfig_PostStartupScriptBehaviorfunc (RuntimeSoftwareConfig_PostStartupScriptBehavior) EnumDescriptor
func (RuntimeSoftwareConfig_PostStartupScriptBehavior) EnumDescriptor() ([]byte, []int)Deprecated: Use RuntimeSoftwareConfig_PostStartupScriptBehavior.Descriptor instead.
func (RuntimeSoftwareConfig_PostStartupScriptBehavior) Number
func (x RuntimeSoftwareConfig_PostStartupScriptBehavior) Number() protoreflect.EnumNumberfunc (RuntimeSoftwareConfig_PostStartupScriptBehavior) String
func (x RuntimeSoftwareConfig_PostStartupScriptBehavior) String() stringfunc (RuntimeSoftwareConfig_PostStartupScriptBehavior) Type
Runtime_HealthState
type Runtime_HealthState int32The 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.EnumDescriptorfunc (Runtime_HealthState) Enum
func (x Runtime_HealthState) Enum() *Runtime_HealthStatefunc (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.EnumNumberfunc (Runtime_HealthState) String
func (x Runtime_HealthState) String() stringfunc (Runtime_HealthState) Type
func (Runtime_HealthState) Type() protoreflect.EnumTypeRuntime_State
type Runtime_State int32The 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.EnumDescriptorfunc (Runtime_State) Enum
func (x Runtime_State) Enum() *Runtime_Statefunc (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.EnumNumberfunc (Runtime_State) String
func (x Runtime_State) String() stringfunc (Runtime_State) Type
func (Runtime_State) Type() protoreflect.EnumTypeRuntime_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 *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time the schedule was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Notebook Execution Template corresponding to this schedule.
ExecutionTemplate *ExecutionTemplate `protobuf:"bytes,9,opt,name=execution_template,json=executionTemplate,proto3" json:"execution_template,omitempty"`
// Output only. The most recent execution names triggered from this schedule and their
// corresponding states.
RecentExecutions []*Execution `protobuf:"bytes,10,rep,name=recent_executions,json=recentExecutions,proto3" json:"recent_executions,omitempty"`
// contains filtered or unexported fields
}The definition of a schedule.
func (*Schedule) Descriptor
Deprecated: Use Schedule.ProtoReflect.Descriptor instead.
func (*Schedule) GetCreateTime
func (x *Schedule) GetCreateTime() *timestamppb.Timestampfunc (*Schedule) GetCronSchedule
func (*Schedule) GetDescription
func (*Schedule) GetDisplayName
func (*Schedule) GetExecutionTemplate
func (x *Schedule) GetExecutionTemplate() *ExecutionTemplatefunc (*Schedule) GetName
func (*Schedule) GetRecentExecutions
func (*Schedule) GetState
func (x *Schedule) GetState() Schedule_Statefunc (*Schedule) GetTimeZone
func (*Schedule) GetUpdateTime
func (x *Schedule) GetUpdateTime() *timestamppb.Timestampfunc (*Schedule) ProtoMessage
func (*Schedule) ProtoMessage()func (*Schedule) ProtoReflect
func (x *Schedule) ProtoReflect() protoreflect.Messagefunc (*Schedule) Reset
func (x *Schedule) Reset()func (*Schedule) String
Schedule_State
type Schedule_State int32State 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.EnumDescriptorfunc (Schedule_State) Enum
func (x Schedule_State) Enum() *Schedule_Statefunc (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.EnumNumberfunc (Schedule_State) String
func (x Schedule_State) String() stringfunc (Schedule_State) Type
func (Schedule_State) Type() protoreflect.EnumTypeSetInstanceAcceleratorRequest
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() int64func (*SetInstanceAcceleratorRequest) GetName
func (x *SetInstanceAcceleratorRequest) GetName() stringfunc (*SetInstanceAcceleratorRequest) GetType
func (x *SetInstanceAcceleratorRequest) GetType() Instance_AcceleratorTypefunc (*SetInstanceAcceleratorRequest) ProtoMessage
func (*SetInstanceAcceleratorRequest) ProtoMessage()func (*SetInstanceAcceleratorRequest) ProtoReflect
func (x *SetInstanceAcceleratorRequest) ProtoReflect() protoreflect.Messagefunc (*SetInstanceAcceleratorRequest) Reset
func (x *SetInstanceAcceleratorRequest) Reset()func (*SetInstanceAcceleratorRequest) String
func (x *SetInstanceAcceleratorRequest) String() stringSetInstanceLabelsRequest
type SetInstanceLabelsRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Labels to apply to this instance.
// These can be later modified by the setLabels method
Labels map[string]string `protobuf:"bytes,2,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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]stringfunc (*SetInstanceLabelsRequest) GetName
func (x *SetInstanceLabelsRequest) GetName() stringfunc (*SetInstanceLabelsRequest) ProtoMessage
func (*SetInstanceLabelsRequest) ProtoMessage()func (*SetInstanceLabelsRequest) ProtoReflect
func (x *SetInstanceLabelsRequest) ProtoReflect() protoreflect.Messagefunc (*SetInstanceLabelsRequest) Reset
func (x *SetInstanceLabelsRequest) Reset()func (*SetInstanceLabelsRequest) String
func (x *SetInstanceLabelsRequest) String() stringSetInstanceMachineTypeRequest
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() stringfunc (*SetInstanceMachineTypeRequest) GetName
func (x *SetInstanceMachineTypeRequest) GetName() stringfunc (*SetInstanceMachineTypeRequest) ProtoMessage
func (*SetInstanceMachineTypeRequest) ProtoMessage()func (*SetInstanceMachineTypeRequest) ProtoReflect
func (x *SetInstanceMachineTypeRequest) ProtoReflect() protoreflect.Messagefunc (*SetInstanceMachineTypeRequest) Reset
func (x *SetInstanceMachineTypeRequest) Reset()func (*SetInstanceMachineTypeRequest) String
func (x *SetInstanceMachineTypeRequest) String() stringStartInstanceRequest
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() stringfunc (*StartInstanceRequest) ProtoMessage
func (*StartInstanceRequest) ProtoMessage()func (*StartInstanceRequest) ProtoReflect
func (x *StartInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*StartInstanceRequest) Reset
func (x *StartInstanceRequest) Reset()func (*StartInstanceRequest) String
func (x *StartInstanceRequest) String() stringStartRuntimeRequest
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() stringfunc (*StartRuntimeRequest) GetRequestId
func (x *StartRuntimeRequest) GetRequestId() stringfunc (*StartRuntimeRequest) ProtoMessage
func (*StartRuntimeRequest) ProtoMessage()func (*StartRuntimeRequest) ProtoReflect
func (x *StartRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*StartRuntimeRequest) Reset
func (x *StartRuntimeRequest) Reset()func (*StartRuntimeRequest) String
func (x *StartRuntimeRequest) String() stringStopInstanceRequest
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() stringfunc (*StopInstanceRequest) ProtoMessage
func (*StopInstanceRequest) ProtoMessage()func (*StopInstanceRequest) ProtoReflect
func (x *StopInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*StopInstanceRequest) Reset
func (x *StopInstanceRequest) Reset()func (*StopInstanceRequest) String
func (x *StopInstanceRequest) String() stringStopRuntimeRequest
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() stringfunc (*StopRuntimeRequest) GetRequestId
func (x *StopRuntimeRequest) GetRequestId() stringfunc (*StopRuntimeRequest) ProtoMessage
func (*StopRuntimeRequest) ProtoMessage()func (*StopRuntimeRequest) ProtoReflect
func (x *StopRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*StopRuntimeRequest) Reset
func (x *StopRuntimeRequest) Reset()func (*StopRuntimeRequest) String
func (x *StopRuntimeRequest) String() stringSwitchRuntimeRequest
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() *RuntimeAcceleratorConfigfunc (*SwitchRuntimeRequest) GetMachineType
func (x *SwitchRuntimeRequest) GetMachineType() stringfunc (*SwitchRuntimeRequest) GetName
func (x *SwitchRuntimeRequest) GetName() stringfunc (*SwitchRuntimeRequest) GetRequestId
func (x *SwitchRuntimeRequest) GetRequestId() stringfunc (*SwitchRuntimeRequest) ProtoMessage
func (*SwitchRuntimeRequest) ProtoMessage()func (*SwitchRuntimeRequest) ProtoReflect
func (x *SwitchRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*SwitchRuntimeRequest) Reset
func (x *SwitchRuntimeRequest) Reset()func (*SwitchRuntimeRequest) String
func (x *SwitchRuntimeRequest) String() stringTriggerScheduleRequest
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() stringfunc (*TriggerScheduleRequest) ProtoMessage
func (*TriggerScheduleRequest) ProtoMessage()func (*TriggerScheduleRequest) ProtoReflect
func (x *TriggerScheduleRequest) ProtoReflect() protoreflect.Messagefunc (*TriggerScheduleRequest) Reset
func (x *TriggerScheduleRequest) Reset()func (*TriggerScheduleRequest) String
func (x *TriggerScheduleRequest) String() stringUnimplementedManagedNotebookServiceServer
type UnimplementedManagedNotebookServiceServer struct {
}UnimplementedManagedNotebookServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedManagedNotebookServiceServer) CreateRuntime
func (UnimplementedManagedNotebookServiceServer) CreateRuntime(context.Context, *CreateRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) DeleteRuntime
func (UnimplementedManagedNotebookServiceServer) DeleteRuntime(context.Context, *DeleteRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) DiagnoseRuntime
func (UnimplementedManagedNotebookServiceServer) DiagnoseRuntime(context.Context, *DiagnoseRuntimeRequest) (*longrunningpb.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) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) ResetRuntime
func (UnimplementedManagedNotebookServiceServer) ResetRuntime(context.Context, *ResetRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) StartRuntime
func (UnimplementedManagedNotebookServiceServer) StartRuntime(context.Context, *StartRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) StopRuntime
func (UnimplementedManagedNotebookServiceServer) StopRuntime(context.Context, *StopRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) SwitchRuntime
func (UnimplementedManagedNotebookServiceServer) SwitchRuntime(context.Context, *SwitchRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) UpdateRuntime
func (UnimplementedManagedNotebookServiceServer) UpdateRuntime(context.Context, *UpdateRuntimeRequest) (*longrunningpb.Operation, error)func (UnimplementedManagedNotebookServiceServer) UpgradeRuntime
func (UnimplementedManagedNotebookServiceServer) UpgradeRuntime(context.Context, *UpgradeRuntimeRequest) (*longrunningpb.Operation, error)UnimplementedNotebookServiceServer
type UnimplementedNotebookServiceServer struct {
}UnimplementedNotebookServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedNotebookServiceServer) CreateEnvironment
func (UnimplementedNotebookServiceServer) CreateEnvironment(context.Context, *CreateEnvironmentRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) CreateExecution
func (UnimplementedNotebookServiceServer) CreateExecution(context.Context, *CreateExecutionRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) CreateInstance
func (UnimplementedNotebookServiceServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) CreateSchedule
func (UnimplementedNotebookServiceServer) CreateSchedule(context.Context, *CreateScheduleRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) DeleteEnvironment
func (UnimplementedNotebookServiceServer) DeleteEnvironment(context.Context, *DeleteEnvironmentRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) DeleteExecution
func (UnimplementedNotebookServiceServer) DeleteExecution(context.Context, *DeleteExecutionRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) DeleteInstance
func (UnimplementedNotebookServiceServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) DeleteSchedule
func (UnimplementedNotebookServiceServer) DeleteSchedule(context.Context, *DeleteScheduleRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) DiagnoseInstance
func (UnimplementedNotebookServiceServer) DiagnoseInstance(context.Context, *DiagnoseInstanceRequest) (*longrunningpb.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) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) ReportInstanceInfo
func (UnimplementedNotebookServiceServer) ReportInstanceInfo(context.Context, *ReportInstanceInfoRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) ResetInstance
func (UnimplementedNotebookServiceServer) ResetInstance(context.Context, *ResetInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) RollbackInstance
func (UnimplementedNotebookServiceServer) RollbackInstance(context.Context, *RollbackInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) SetInstanceAccelerator
func (UnimplementedNotebookServiceServer) SetInstanceAccelerator(context.Context, *SetInstanceAcceleratorRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) SetInstanceLabels
func (UnimplementedNotebookServiceServer) SetInstanceLabels(context.Context, *SetInstanceLabelsRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) SetInstanceMachineType
func (UnimplementedNotebookServiceServer) SetInstanceMachineType(context.Context, *SetInstanceMachineTypeRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) StartInstance
func (UnimplementedNotebookServiceServer) StartInstance(context.Context, *StartInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) StopInstance
func (UnimplementedNotebookServiceServer) StopInstance(context.Context, *StopInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) TriggerSchedule
func (UnimplementedNotebookServiceServer) TriggerSchedule(context.Context, *TriggerScheduleRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) UpdateInstanceConfig
func (UnimplementedNotebookServiceServer) UpdateInstanceConfig(context.Context, *UpdateInstanceConfigRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) UpdateInstanceMetadataItems
func (UnimplementedNotebookServiceServer) UpdateInstanceMetadataItems(context.Context, *UpdateInstanceMetadataItemsRequest) (*UpdateInstanceMetadataItemsResponse, error)func (UnimplementedNotebookServiceServer) UpdateShieldedInstanceConfig
func (UnimplementedNotebookServiceServer) UpdateShieldedInstanceConfig(context.Context, *UpdateShieldedInstanceConfigRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) UpgradeInstance
func (UnimplementedNotebookServiceServer) UpgradeInstance(context.Context, *UpgradeInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedNotebookServiceServer) UpgradeInstanceInternal
func (UnimplementedNotebookServiceServer) UpgradeInstanceInternal(context.Context, *UpgradeInstanceInternalRequest) (*longrunningpb.Operation, error)UnsafeManagedNotebookServiceServer
type UnsafeManagedNotebookServiceServer interface {
// contains filtered or unexported methods
}UnsafeManagedNotebookServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ManagedNotebookServiceServer will result in compilation errors.
UnsafeNotebookServiceServer
type UnsafeNotebookServiceServer interface {
// contains filtered or unexported methods
}UnsafeNotebookServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotebookServiceServer will result in compilation errors.
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() *InstanceConfigfunc (*UpdateInstanceConfigRequest) GetName
func (x *UpdateInstanceConfigRequest) GetName() stringfunc (*UpdateInstanceConfigRequest) ProtoMessage
func (*UpdateInstanceConfigRequest) ProtoMessage()func (*UpdateInstanceConfigRequest) ProtoReflect
func (x *UpdateInstanceConfigRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateInstanceConfigRequest) Reset
func (x *UpdateInstanceConfigRequest) Reset()func (*UpdateInstanceConfigRequest) String
func (x *UpdateInstanceConfigRequest) String() stringUpdateInstanceMetadataItemsRequest
type UpdateInstanceMetadataItemsRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Metadata items to add/update for the instance.
Items map[string]string `protobuf:"bytes,2,rep,name=items,proto3" json:"items,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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]stringfunc (*UpdateInstanceMetadataItemsRequest) GetName
func (x *UpdateInstanceMetadataItemsRequest) GetName() stringfunc (*UpdateInstanceMetadataItemsRequest) ProtoMessage
func (*UpdateInstanceMetadataItemsRequest) ProtoMessage()func (*UpdateInstanceMetadataItemsRequest) ProtoReflect
func (x *UpdateInstanceMetadataItemsRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateInstanceMetadataItemsRequest) Reset
func (x *UpdateInstanceMetadataItemsRequest) Reset()func (*UpdateInstanceMetadataItemsRequest) String
func (x *UpdateInstanceMetadataItemsRequest) String() stringUpdateInstanceMetadataItemsResponse
type UpdateInstanceMetadataItemsResponse struct {
// Map of items that were added/updated to/in the metadata.
Items map[string]string `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}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]stringfunc (*UpdateInstanceMetadataItemsResponse) ProtoMessage
func (*UpdateInstanceMetadataItemsResponse) ProtoMessage()func (*UpdateInstanceMetadataItemsResponse) ProtoReflect
func (x *UpdateInstanceMetadataItemsResponse) ProtoReflect() protoreflect.Messagefunc (*UpdateInstanceMetadataItemsResponse) Reset
func (x *UpdateInstanceMetadataItemsResponse) Reset()func (*UpdateInstanceMetadataItemsResponse) String
func (x *UpdateInstanceMetadataItemsResponse) String() stringUpdateRuntimeRequest
type UpdateRuntimeRequest struct {
// Required. The Runtime to be updated.
Runtime *Runtime `protobuf:"bytes,1,opt,name=runtime,proto3" json:"runtime,omitempty"`
// Required. Specifies the path, relative to `Runtime`, of
// the field to update. For example, to change the software configuration
// kernels, the `update_mask` parameter would be
// specified as `software_config.kernels`,
// and the `PATCH` request body would specify the new value, as follows:
//
// {
// "software_config":{
// "kernels": [{
// 'repository':
// 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
// 'latest' }],
// }
// }
//
// Currently, only the following fields can be updated:
// - `software_config.kernels`
// - `software_config.post_startup_script`
// - `software_config.custom_gpu_driver_path`
// - `software_config.idle_shutdown`
// - `software_config.idle_shutdown_timeout`
// - `software_config.disable_terminal`
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Idempotent request UUID.
RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}Request for updating a Managed Notebook configuration.
func (*UpdateRuntimeRequest) Descriptor
func (*UpdateRuntimeRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateRuntimeRequest.ProtoReflect.Descriptor instead.
func (*UpdateRuntimeRequest) GetRequestId
func (x *UpdateRuntimeRequest) GetRequestId() stringfunc (*UpdateRuntimeRequest) GetRuntime
func (x *UpdateRuntimeRequest) GetRuntime() *Runtimefunc (*UpdateRuntimeRequest) GetUpdateMask
func (x *UpdateRuntimeRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateRuntimeRequest) ProtoMessage
func (*UpdateRuntimeRequest) ProtoMessage()func (*UpdateRuntimeRequest) ProtoReflect
func (x *UpdateRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateRuntimeRequest) Reset
func (x *UpdateRuntimeRequest) Reset()func (*UpdateRuntimeRequest) String
func (x *UpdateRuntimeRequest) String() stringUpdateShieldedInstanceConfigRequest
type UpdateShieldedInstanceConfigRequest struct {
// Required. Format:
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// ShieldedInstance configuration to be updated.
ShieldedInstanceConfig *Instance_ShieldedInstanceConfig `protobuf:"bytes,2,opt,name=shielded_instance_config,json=shieldedInstanceConfig,proto3" json:"shielded_instance_config,omitempty"`
// contains filtered or unexported fields
}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() stringfunc (*UpdateShieldedInstanceConfigRequest) GetShieldedInstanceConfig
func (x *UpdateShieldedInstanceConfigRequest) GetShieldedInstanceConfig() *Instance_ShieldedInstanceConfigfunc (*UpdateShieldedInstanceConfigRequest) ProtoMessage
func (*UpdateShieldedInstanceConfigRequest) ProtoMessage()func (*UpdateShieldedInstanceConfigRequest) ProtoReflect
func (x *UpdateShieldedInstanceConfigRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateShieldedInstanceConfigRequest) Reset
func (x *UpdateShieldedInstanceConfigRequest) Reset()func (*UpdateShieldedInstanceConfigRequest) String
func (x *UpdateShieldedInstanceConfigRequest) String() stringUpgradeInstanceInternalRequest
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() stringfunc (*UpgradeInstanceInternalRequest) GetType
func (x *UpgradeInstanceInternalRequest) GetType() UpgradeTypefunc (*UpgradeInstanceInternalRequest) GetVmId
func (x *UpgradeInstanceInternalRequest) GetVmId() stringfunc (*UpgradeInstanceInternalRequest) ProtoMessage
func (*UpgradeInstanceInternalRequest) ProtoMessage()func (*UpgradeInstanceInternalRequest) ProtoReflect
func (x *UpgradeInstanceInternalRequest) ProtoReflect() protoreflect.Messagefunc (*UpgradeInstanceInternalRequest) Reset
func (x *UpgradeInstanceInternalRequest) Reset()func (*UpgradeInstanceInternalRequest) String
func (x *UpgradeInstanceInternalRequest) String() stringUpgradeInstanceRequest
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() stringfunc (*UpgradeInstanceRequest) GetType
func (x *UpgradeInstanceRequest) GetType() UpgradeTypefunc (*UpgradeInstanceRequest) ProtoMessage
func (*UpgradeInstanceRequest) ProtoMessage()func (*UpgradeInstanceRequest) ProtoReflect
func (x *UpgradeInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*UpgradeInstanceRequest) Reset
func (x *UpgradeInstanceRequest) Reset()func (*UpgradeInstanceRequest) String
func (x *UpgradeInstanceRequest) String() stringUpgradeRuntimeRequest
type UpgradeRuntimeRequest 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 upgrading a Managed Notebook Runtime to the latest version. option (google.api.message_visibility).restriction =
"TRUSTED_TESTER,SPECIAL_TESTER";
func (*UpgradeRuntimeRequest) Descriptor
func (*UpgradeRuntimeRequest) Descriptor() ([]byte, []int)Deprecated: Use UpgradeRuntimeRequest.ProtoReflect.Descriptor instead.
func (*UpgradeRuntimeRequest) GetName
func (x *UpgradeRuntimeRequest) GetName() stringfunc (*UpgradeRuntimeRequest) GetRequestId
func (x *UpgradeRuntimeRequest) GetRequestId() stringfunc (*UpgradeRuntimeRequest) ProtoMessage
func (*UpgradeRuntimeRequest) ProtoMessage()func (*UpgradeRuntimeRequest) ProtoReflect
func (x *UpgradeRuntimeRequest) ProtoReflect() protoreflect.Messagefunc (*UpgradeRuntimeRequest) Reset
func (x *UpgradeRuntimeRequest) Reset()func (*UpgradeRuntimeRequest) String
func (x *UpgradeRuntimeRequest) String() stringUpgradeType
type UpgradeType int32Definition 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.EnumDescriptorfunc (UpgradeType) Enum
func (x UpgradeType) Enum() *UpgradeTypefunc (UpgradeType) EnumDescriptor
func (UpgradeType) EnumDescriptor() ([]byte, []int)Deprecated: Use UpgradeType.Descriptor instead.
func (UpgradeType) Number
func (x UpgradeType) Number() protoreflect.EnumNumberfunc (UpgradeType) String
func (x UpgradeType) String() stringfunc (UpgradeType) Type
func (UpgradeType) Type() protoreflect.EnumTypeVirtualMachine
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() stringfunc (*VirtualMachine) GetInstanceName
func (x *VirtualMachine) GetInstanceName() stringfunc (*VirtualMachine) GetVirtualMachineConfig
func (x *VirtualMachine) GetVirtualMachineConfig() *VirtualMachineConfigfunc (*VirtualMachine) ProtoMessage
func (*VirtualMachine) ProtoMessage()func (*VirtualMachine) ProtoReflect
func (x *VirtualMachine) ProtoReflect() protoreflect.Messagefunc (*VirtualMachine) Reset
func (x *VirtualMachine) Reset()func (*VirtualMachine) String
func (x *VirtualMachine) String() stringVirtualMachineConfig
type VirtualMachineConfig struct {
// Output only. The zone where the virtual machine is located.
// If using regional request, the notebooks service will pick a location
// in the corresponding runtime region.
// On a get request, zone will always be present. Example:
// * `us-central1-b`
Zone string `protobuf:"bytes,1,opt,name=zone,proto3" json:"zone,omitempty"`
// Required. The Compute Engine machine type used for runtimes.
// Short name is valid. Examples:
// * `n1-standard-2`
// * `e2-standard-8`
MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
// Optional. Use a list of container images to use as Kernels in the notebook instance.
ContainerImages []*ContainerImage `protobuf:"bytes,3,rep,name=container_images,json=containerImages,proto3" json:"container_images,omitempty"`
// Required. Data disk option configuration settings.
DataDisk *LocalDisk `protobuf:"bytes,4,opt,name=data_disk,json=dataDisk,proto3" json:"data_disk,omitempty"`
// Optional. Encryption settings for virtual machine data disk.
EncryptionConfig *EncryptionConfig `protobuf:"bytes,5,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
// Optional. Shielded VM Instance configuration settings.
ShieldedInstanceConfig *RuntimeShieldedInstanceConfig `protobuf:"bytes,6,opt,name=shielded_instance_config,json=shieldedInstanceConfig,proto3" json:"shielded_instance_config,omitempty"`
// Optional. The Compute Engine accelerator configuration for this runtime.
AcceleratorConfig *RuntimeAcceleratorConfig `protobuf:"bytes,7,opt,name=accelerator_config,json=acceleratorConfig,proto3" json:"accelerator_config,omitempty"`
// Optional. The Compute Engine network to be used for machine
// communications. Cannot be specified with subnetwork. If neither
// `network` nor `subnet` is specified, the "default" network of
// the project is used, if it exists.
//
// A full URL or partial URI. Examples:
//
// * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default`
// * `projects/[project_id]/global/networks/default`
//
// Runtimes are managed resources inside Google Infrastructure.
// Runtimes support the following network configurations:
//
// * Google Managed Network (Network & subnet are empty)
// * Consumer Project VPC (network & subnet are required). Requires
// configuring Private Service Access.
// * Shared VPC (network & subnet are required). Requires configuring Private
// Service Access.
Network string `protobuf:"bytes,8,opt,name=network,proto3" json:"network,omitempty"`
// Optional. The Compute Engine subnetwork to be used for machine
// communications. Cannot be specified with network.
//
// A full URL or partial URI are valid. Examples:
//
// * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0`
// * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
Subnet string `protobuf:"bytes,9,opt,name=subnet,proto3" json:"subnet,omitempty"`
// Optional. If true, runtime will only have internal IP
// addresses. By default, runtimes are not restricted to internal IP
// addresses, and will have ephemeral external IP addresses assigned to each
// vm. This `internal_ip_only` restriction can only be enabled for
// subnetwork enabled networks, and all dependencies must be
// configured to be accessible without external IP addresses.
InternalIpOnly bool `protobuf:"varint,10,opt,name=internal_ip_only,json=internalIpOnly,proto3" json:"internal_ip_only,omitempty"`
// Optional. The Compute Engine tags to add to runtime (see [Tagging
// instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Tags []string `protobuf:"bytes,13,rep,name=tags,proto3" json:"tags,omitempty"`
// Output only. The Compute Engine guest attributes. (see
// [Project and instance
// guest
// attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
GuestAttributes map[string]string `protobuf:"bytes,14,rep,name=guest_attributes,json=guestAttributes,proto3" json:"guest_attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The Compute Engine metadata entries to add to virtual machine. (see
// [Project and instance
// metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Metadata map[string]string `protobuf:"bytes,15,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The labels to associate with this runtime.
// Label **keys** must contain 1 to 63 characters, and must conform to
// [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
// Label **values** may be empty, but, if present, must contain 1 to 63
// characters, and must conform to [RFC
// 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
// associated with a cluster.
Labels map[string]string `protobuf:"bytes,16,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. The type of vNIC to be used on this interface. This may be gVNIC or
// VirtioNet.
NicType VirtualMachineConfig_NicType `protobuf:"varint,17,opt,name=nic_type,json=nicType,proto3,enum=google.cloud.notebooks.v1.VirtualMachineConfig_NicType" json:"nic_type,omitempty"`
// Optional. Reserved IP Range name is used for VPC Peering.
// The subnetwork allocation will use the range *name* if it's assigned.
//
// Example: managed-notebooks-range-c
//
// PEERING_RANGE_NAME_3=managed-notebooks-range-c
// gcloud compute addresses create $PEERING_RANGE_NAME_3 \
// --global \
// --prefix-length=24 \
// --description="Google Cloud Managed Notebooks Range 24 c" \
// --network=$NETWORK \
// --addresses=192.168.0.0 \
// --purpose=VPC_PEERING
//
// Field value will be: `managed-notebooks-range-c`
ReservedIpRange string `protobuf:"bytes,18,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_ip_range,omitempty"`
// Optional. Boot image metadata used for runtime upgradeability.
BootImage *VirtualMachineConfig_BootImage `protobuf:"bytes,19,opt,name=boot_image,json=bootImage,proto3" json:"boot_image,omitempty"`
// contains filtered or unexported fields
}The config settings for virtual machine.
func (*VirtualMachineConfig) Descriptor
func (*VirtualMachineConfig) Descriptor() ([]byte, []int)Deprecated: Use VirtualMachineConfig.ProtoReflect.Descriptor instead.
func (*VirtualMachineConfig) GetAcceleratorConfig
func (x *VirtualMachineConfig) GetAcceleratorConfig() *RuntimeAcceleratorConfigfunc (*VirtualMachineConfig) GetBootImage
func (x *VirtualMachineConfig) GetBootImage() *VirtualMachineConfig_BootImagefunc (*VirtualMachineConfig) GetContainerImages
func (x *VirtualMachineConfig) GetContainerImages() []*ContainerImagefunc (*VirtualMachineConfig) GetDataDisk
func (x *VirtualMachineConfig) GetDataDisk() *LocalDiskfunc (*VirtualMachineConfig) GetEncryptionConfig
func (x *VirtualMachineConfig) GetEncryptionConfig() *EncryptionConfigfunc (*VirtualMachineConfig) GetGuestAttributes
func (x *VirtualMachineConfig) GetGuestAttributes() map[string]stringfunc (*VirtualMachineConfig) GetInternalIpOnly
func (x *VirtualMachineConfig) GetInternalIpOnly() boolfunc (*VirtualMachineConfig) GetLabels
func (x *VirtualMachineConfig) GetLabels() map[string]stringfunc (*VirtualMachineConfig) GetMachineType
func (x *VirtualMachineConfig) GetMachineType() stringfunc (*VirtualMachineConfig) GetMetadata
func (x *VirtualMachineConfig) GetMetadata() map[string]stringfunc (*VirtualMachineConfig) GetNetwork
func (x *VirtualMachineConfig) GetNetwork() stringfunc (*VirtualMachineConfig) GetNicType
func (x *VirtualMachineConfig) GetNicType() VirtualMachineConfig_NicTypefunc (*VirtualMachineConfig) GetReservedIpRange
func (x *VirtualMachineConfig) GetReservedIpRange() stringfunc (*VirtualMachineConfig) GetShieldedInstanceConfig
func (x *VirtualMachineConfig) GetShieldedInstanceConfig() *RuntimeShieldedInstanceConfigfunc (*VirtualMachineConfig) GetSubnet
func (x *VirtualMachineConfig) GetSubnet() stringfunc (*VirtualMachineConfig) GetTags
func (x *VirtualMachineConfig) GetTags() []stringfunc (*VirtualMachineConfig) GetZone
func (x *VirtualMachineConfig) GetZone() stringfunc (*VirtualMachineConfig) ProtoMessage
func (*VirtualMachineConfig) ProtoMessage()func (*VirtualMachineConfig) ProtoReflect
func (x *VirtualMachineConfig) ProtoReflect() protoreflect.Messagefunc (*VirtualMachineConfig) Reset
func (x *VirtualMachineConfig) Reset()func (*VirtualMachineConfig) String
func (x *VirtualMachineConfig) String() stringVirtualMachineConfig_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.Messagefunc (*VirtualMachineConfig_BootImage) Reset
func (x *VirtualMachineConfig_BootImage) Reset()func (*VirtualMachineConfig_BootImage) String
func (x *VirtualMachineConfig_BootImage) String() stringVirtualMachineConfig_NicType
type VirtualMachineConfig_NicType int32The 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.EnumDescriptorfunc (VirtualMachineConfig_NicType) Enum
func (x VirtualMachineConfig_NicType) Enum() *VirtualMachineConfig_NicTypefunc (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.EnumNumberfunc (VirtualMachineConfig_NicType) String
func (x VirtualMachineConfig_NicType) String() stringfunc (VirtualMachineConfig_NicType) Type
func (VirtualMachineConfig_NicType) Type() protoreflect.EnumTypeVmImage
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_Imagefunc (*VmImage) GetImageFamily
func (*VmImage) GetImageName
func (*VmImage) GetProject
func (*VmImage) ProtoMessage
func (*VmImage) ProtoMessage()func (*VmImage) ProtoReflect
func (x *VmImage) ProtoReflect() protoreflect.Messagefunc (*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"`
}