Package google.cloud.notebooks.v1

Index

• ManagedNotebookService (Schnittstelle)
• NotebookService (Schnittstelle)
• ContainerImage (Meldung)
• CreateEnvironmentRequest (Meldung)
• CreateExecutionRequest (Meldung)
• CreateInstanceRequest (Meldung)
• CreateRuntimeRequest (Meldung)
• CreateScheduleRequest (Meldung)
• DeleteEnvironmentRequest (Meldung)
• DeleteExecutionRequest (Meldung)
• DeleteInstanceRequest (Meldung)
• DeleteRuntimeRequest (Meldung)
• DeleteScheduleRequest (Meldung)
• DiagnoseInstanceRequest (Meldung)
• DiagnosticConfig (Meldung)
• EncryptionConfig (Meldung)
• Environment (Meldung)
• Event (Meldung)
• Event.EventType (Aufzählung)
• Execution (Meldung)
• Execution.State (Aufzählung)
• ExecutionTemplate (Meldung)
• ExecutionTemplate.DataprocParameters (Meldung)
• ExecutionTemplate.JobType (enum)
• ExecutionTemplate.ScaleTier (enum)
• ExecutionTemplate.SchedulerAcceleratorConfig (Meldung)
• ExecutionTemplate.SchedulerAcceleratorType (Aufzählung)
• ExecutionTemplate.VertexAIParameters (Meldung)
• GetEnvironmentRequest (Meldung)
• GetExecutionRequest (Meldung)
• GetInstanceHealthRequest (Meldung)
• GetInstanceHealthResponse (Meldung)
• GetInstanceHealthResponse.HealthState (Aufzählung)
• GetInstanceRequest (Meldung)
• GetRuntimeRequest (Meldung)
• GetScheduleRequest (Meldung)
• Instance (Meldung)
• Instance.AcceleratorConfig (Meldung)
• Instance.AcceleratorType (Aufzählung)
• Instance.Disk (Meldung)
• Instance.Disk.GuestOsFeature (Meldung)
• Instance.DiskEncryption (enum)
• Instance.DiskType (enum)
• Instance.NicType (enum)
• Instance.ShieldedInstanceConfig (Meldung)
• Instance.State (Aufzählung)
• Instance.UpgradeHistoryEntry (Meldung)
• Instance.UpgradeHistoryEntry.Action (enum)
• Instance.UpgradeHistoryEntry.State (enum)
• InstanceConfig (Meldung)
• InstanceMigrationEligibility (Meldung)
• InstanceMigrationEligibility.Error (enum)
• InstanceMigrationEligibility.Warning (enum)
• IsInstanceUpgradeableRequest (Meldung)
• IsInstanceUpgradeableResponse (Meldung)
• ListEnvironmentsRequest (Meldung)
• ListEnvironmentsResponse (Meldung)
• ListExecutionsRequest (Meldung)
• ListExecutionsResponse (Meldung)
• ListInstancesRequest (Meldung)
• ListInstancesResponse (Meldung)
• ListRuntimesRequest (Meldung)
• ListRuntimesResponse (Meldung)
• ListSchedulesRequest (Meldung)
• ListSchedulesResponse (Meldung)
• LocalDisk (Meldung)
• LocalDisk.RuntimeGuestOsFeature (Meldung)
• LocalDiskInitializeParams (Meldung)
• LocalDiskInitializeParams.DiskType (Aufzählung)
• MigrateInstanceRequest (Meldung)
• MigrateInstanceRequest.PostStartupScriptOption (Aufzählung)
• MigrateInstanceResponse (Meldung)
• MigrateRuntimeRequest (Meldung)
• MigrateRuntimeRequest.PostStartupScriptOption (Aufzählung)
• OperationMetadata (Meldung)
• RegisterInstanceRequest (Meldung)
• ReportInstanceInfoRequest (Meldung)
• ReportRuntimeEventRequest (Meldung)
• ReservationAffinity (Meldung)
• ReservationAffinity.Type (Aufzählung)
• ResetInstanceRequest (Meldung)
• ResetRuntimeRequest (Meldung)
• RollbackInstanceRequest (Meldung)
• Runtime (Meldung)
• Runtime.HealthState (enum)
• Runtime.State (enum)
• RuntimeAcceleratorConfig (Meldung)
• RuntimeAcceleratorConfig.AcceleratorType (Aufzählung)
• RuntimeAccessConfig (Meldung)
• RuntimeAccessConfig.RuntimeAccessType (Aufzählung)
• RuntimeMetrics (Meldung)
• RuntimeMigrationEligibility (Meldung)
• RuntimeMigrationEligibility.Error (enum)
• RuntimeMigrationEligibility.Warning (enum)
• RuntimeShieldedInstanceConfig (Meldung)
• RuntimeSoftwareConfig (Meldung)
• RuntimeSoftwareConfig.PostStartupScriptBehavior (Aufzählung)
• Schedule (Meldung)
• Schedule.State (Aufzählung)
• SetInstanceAcceleratorRequest (Meldung)
• SetInstanceLabelsRequest (Meldung)
• SetInstanceMachineTypeRequest (Meldung)
• StartInstanceRequest (Meldung)
• StartRuntimeRequest (Meldung)
• StopInstanceRequest (Meldung)
• StopRuntimeRequest (Meldung)
• SwitchRuntimeRequest (Meldung)
• UpdateInstanceConfigRequest (Meldung)
• UpdateInstanceMetadataItemsRequest (Meldung)
• UpdateInstanceMetadataItemsResponse (Meldung)
• UpdateRuntimeRequest (Meldung)
• UpdateShieldedInstanceConfigRequest (Meldung)
• UpgradeInstanceRequest (Meldung)
• UpgradeType (Aufzählung)
• VirtualMachine (Meldung)
• VirtualMachineConfig (Meldung)
• VirtualMachineConfig.BootImage (Meldung)
• VirtualMachineConfig.NicType (Aufzählung)
• VmImage (Meldung)

ManagedNotebookService

API v1-Dienst für Managed Notebooks.

CreateRuntime
rpc CreateRuntime(CreateRuntimeRequest) returns (Operation) Erstellt eine neue Laufzeit in einem bestimmten Projekt und an einem bestimmten Standort. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

DeleteRuntime
rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation) Löscht eine einzelne Laufzeit. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

GetRuntime
rpc GetRuntime(GetRuntimeRequest) returns (Runtime) Ruft Details zu einer einzelnen Laufzeit ab. Der Standort muss ein regionaler Endpunkt und kein zonenbasierter Endpunkt sein. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ListRuntimes
rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse) Listet Runtimes in einem angegebenen Projekt und an einem angegebenen Standort auf. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

MigrateRuntime
rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation) Vorhandene Laufzeit zu einer neuen Workbench-Instanz migrieren Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ReportRuntimeEvent
rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation) Meldet und verarbeitet ein Laufzeitereignis. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ResetRuntime
rpc ResetRuntime(ResetRuntimeRequest) returns (Operation) Setzt eine verwaltete Notebook-Laufzeit zurück. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

StartRuntime

rpc StartRuntime(StartRuntimeRequest) returns (Operation) Startet eine Laufzeit für verwaltete Notebooks. Führen Sie „Start“ für GPU-Instanzen und „Fortsetzen“ für CPU-Instanzen aus. Weitere Informationen finden Sie unter https://cloud.google.com/compute/docs/instances/stop-start-instance und https://cloud.google.com/compute/docs/instances/suspend-resume-instance. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

StopRuntime

rpc StopRuntime(StopRuntimeRequest) returns (Operation) Beendet eine Managed Notebook Runtime. Führen Sie „Stop“ für GPU-Instanzen und „Suspend“ für CPU-Instanzen aus. Weitere Informationen finden Sie unter https://cloud.google.com/compute/docs/instances/stop-start-instance und https://cloud.google.com/compute/docs/instances/suspend-resume-instance. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

SwitchRuntime
rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation) Laufzeit eines verwalteten Notebooks wechseln Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

UpdateRuntime
rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation) Aktualisieren Sie die Notebook-Laufzeitkonfiguration. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

NotebookService

API v1-Dienst für Cloud AI Platform Notebooks.

CreateEnvironment
rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation) Erstellt eine neue Umgebung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

CreateExecution
rpc CreateExecution(CreateExecutionRequest) returns (Operation) Erstellt eine neue Ausführung in einem bestimmten Projekt und an einem bestimmten Standort. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

CreateInstance
rpc CreateInstance(CreateInstanceRequest) returns (Operation) Erstellt eine neue Instanz in einem angegebenen Projekt und an einem angegebenen Ort. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

CreateSchedule
rpc CreateSchedule(CreateScheduleRequest) returns (Operation) Erstellt ein neues geplantes Notebook in einem bestimmten Projekt und an einem bestimmten Standort. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

DeleteEnvironment
rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation) Löscht eine einzelne Umgebung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

DeleteExecution
rpc DeleteExecution(DeleteExecutionRequest) returns (Operation) Ausführung löschen Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

DeleteInstance
rpc DeleteInstance(DeleteInstanceRequest) returns (Operation) Löscht eine einzelne Instanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

DeleteSchedule
rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation) Löscht den Zeitplan und alle zugrunde liegenden Jobs Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

DiagnoseInstance
rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation) Erstellt eine Diagnosedatei und führt das Diagnosetool für eine Instanz aus. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

GetEnvironment
rpc GetEnvironment(GetEnvironmentRequest) returns (Environment) Ruft Details zu einer einzelnen Umgebung ab. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

GetExecution
rpc GetExecution(GetExecutionRequest) returns (Execution) Details zu Ausführungen abrufen Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

GetInstance
rpc GetInstance(GetInstanceRequest) returns (Instance) Ruft Details zu einer einzelnen Instanz ab. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

GetInstanceHealth
rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse) Prüft, ob eine Notebook-Instanz fehlerfrei ist. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

GetSchedule
rpc GetSchedule(GetScheduleRequest) returns (Schedule) Ruft Details zum Zeitplan ab Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

IsInstanceUpgradeable
rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse) Prüft, ob eine Notebook-Instanz aktualisiert werden kann. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ListEnvironments
rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) Listet Umgebungen in einem Projekt auf. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ListExecutions
rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse) Listet Ausführungen in einem bestimmten Projekt und an einem bestimmten Standort auf Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ListInstances
rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) Listet Instanzen in einem angegebenen Projekt und an einem angegebenen Standort auf. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ListSchedules
rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse) Listet Zeitpläne in einem angegebenen Projekt und an einem angegebenen Standort auf. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

MigrateInstance
rpc MigrateInstance(MigrateInstanceRequest) returns (Operation) Migriert ein vorhandenes nutzerverwaltetes Notebook zu Workbench-Instanzen. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

RegisterInstance

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation) Registriert eine vorhandene Legacy-Notebookinstanz beim Notebooks API-Server. Legacy-Instanzen sind Instanzen, die mit den Legacy-Compute Engine-Aufrufen erstellt wurden. Sie können nicht direkt über die Notebooks API verwaltet werden. Durch diesen Aufruf können diese Instanzen mit der Notebooks API verwaltet werden. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ReportInstanceInfo

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation) Ermöglicht es Notebook-Instanzen, ihre neuesten Instanzinformationen an den Notebooks API-Server zu senden. Der Server führt die gemeldeten Informationen mit dem Instanzmetadatenspeicher zusammen. Verwenden Sie diese Methode nicht direkt. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ResetInstance
rpc ResetInstance(ResetInstanceRequest) returns (Operation) Setzt eine Notebookinstanz zurück. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

RollbackInstance
rpc RollbackInstance(RollbackInstanceRequest) returns (Operation) Führt ein Rollback einer Notebook-Instanz auf die vorherige Version durch. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

SetInstanceAccelerator
rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation) Aktualisiert die Gastbeschleuniger einer einzelnen Instanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

SetInstanceLabels
rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation) Ersetzt alle Labels einer Instanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

SetInstanceMachineType
rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation) Aktualisiert den Maschinentyp einer einzelnen Instanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

StartInstance
rpc StartInstance(StartInstanceRequest) returns (Operation) Startet eine Notebook-Instanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

StopInstance
rpc StopInstance(StopInstanceRequest) returns (Operation) Beendet eine Notebookinstanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

UpdateInstanceConfig
rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation) Notebook-Instanzkonfigurationen aktualisieren. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

UpdateInstanceMetadataItems
rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse) Metadatenelemente für eine Instanz hinzufügen oder aktualisieren. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

UpdateShieldedInstanceConfig
rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation) Aktualisiert die Konfiguration der abgeschirmten Instanz einer einzelnen Instanz. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

UpgradeInstance
rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation) Führt ein Upgrade einer Notebook-Instanz auf die neueste Version durch. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/cloud-platform Weitere Informationen finden Sie unter Authentication Overview.

ContainerImage

Definition eines Container-Images zum Starten einer Notebook-Instanz mit der in einem Container installierten Umgebung.

Felder
repository	string Erforderlich. Der Pfad zum Container-Image-Repository. Beispiel: gcr.io/{project_id}/{image_name}
tag	string Das Tag des Container-Images. Wenn nichts angegeben ist, wird standardmäßig das neueste Tag verwendet.

CreateEnvironmentRequest

Anfrage zum Erstellen einer Notebook-Umgebung.

Felder
parent	string Erforderlich. Format: projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.environments.create
environment_id	string Erforderlich. Benutzerdefinierte eindeutige ID dieser Umgebung. Der Parameter environment_id muss 1 bis 63 Zeichen lang sein und darf nur Kleinbuchstaben, numerische Zeichen und Bindestriche enthalten. Das erste Zeichen muss ein Kleinbuchstabe und das letzte Zeichen darf kein Bindestrich sein.
environment	Environment Erforderlich. Die Umgebung, die erstellt werden soll.

CreateExecutionRequest

Anfrage zum Erstellen einer Notebook-Ausführung

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.executions.create
execution_id	string Erforderlich. Benutzerdefinierte eindeutige ID dieser Ausführung.
execution	Execution Erforderlich. Die zu erstellende Ausführung.

CreateInstanceRequest

Anfrage zum Erstellen einer Notebook-Instanz.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.instances.create
instance_id	string Erforderlich. Benutzerdefinierte eindeutige ID dieser Instanz.
instance	Instance Erforderlich. Die zu erstellende Instanz.

CreateRuntimeRequest

Anfrage zum Erstellen einer verwalteten Notebook-Laufzeit.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.runtimes.create
runtime_id	string Erforderlich. Die benutzerdefinierte eindeutige ID dieser Laufzeit.
runtime	Runtime Erforderlich. Die zu erstellende Laufzeit.
request_id	string UUID für idempotente Anfrage.

CreateScheduleRequest

Anfrage für erstellte geplante Notebooks

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.schedules.create
schedule_id	string Erforderlich. Die benutzerdefinierte eindeutige ID dieses Zeitplans.
schedule	Schedule Erforderlich. Der zu erstellende Zeitplan.

DeleteEnvironmentRequest

Anfrage zum Löschen einer Notebook-Umgebung.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/environments/{environment_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.environments.delete

DeleteExecutionRequest

Anfrage zum Löschen einer geplanten Notebook-Ausführung

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/executions/{execution_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.executions.delete

DeleteInstanceRequest

Anfrage zum Löschen einer Notebook-Instanz.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.delete

DeleteRuntimeRequest

Anfrage zum Löschen einer Managed Notebook-Laufzeit.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.runtimes.delete
request_id	string UUID für idempotente Anfrage.

DeleteScheduleRequest

Löschen eines Zeitplans anfordern

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.schedules.delete

DiagnoseInstanceRequest

Anfrage zum Erstellen einer Diagnosedatei für Notebook-Instanzen.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
diagnostic_config	DiagnosticConfig Erforderlich. Definiert Flags, die zum Ausführen des Diagnosetools verwendet werden
timeout_minutes	int32 Optional. Maximale Zeit in Minuten, bevor für den Vorgang ein Zeitlimit überschritten wird.

DiagnosticConfig

Definiert Flags, die zum Ausführen des Diagnosetools verwendet werden

Felder
gcs_bucket	string Erforderlich. Speicherort des Cloud Storage-Bucket des Nutzers (ERFORDERLICH). Muss mit dem Pfadpräfix (gs://$GCS_BUCKET) formatiert werden. Berechtigungen: User-Managed Notebooks: - storage.buckets.writer: Muss dem Dienstkonto des Projekts zugewiesen werden, das an die VM angehängt ist. Google Managed Notebooks: - storage.buckets.writer: Muss dem Dienstkonto des Projekts oder den Nutzeranmeldedaten, die an die VM angehängt sind, je nach Authentifizierungsmodus zugewiesen werden. Cloud Storage-Bucket: Logdatei wird in gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz geschrieben
relative_path	string Optional. Definiert den relativen Speicherpfad im Cloud Storage-Bucket, in den die Diagnoselogs geschrieben werden. Der Standardpfad ist das Stammverzeichnis des Cloud Storage-Buckets (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Beispiel für den vollständigen Pfad, in den die Logdatei geschrieben wird: gs://$GCS_BUCKET/$RELATIVE_PATH/
repair_flag_enabled	bool Optional. Aktiviert das Flag zum Reparieren des Dienstes für die Instanz.
packet_capture_flag_enabled	bool Optional. Aktiviert das Flag, um 30 Sekunden lang Pakete von der Instanz zu erfassen.
copy_home_files_flag_enabled	bool Optional. Ermöglicht das Kopieren aller Inhalte des Ordners /home/jupyter

EncryptionConfig

Stellt eine benutzerdefinierte Verschlüsselungsschlüsselkonfiguration dar, die auf eine Ressource angewendet werden kann. Dadurch werden alle Festplatten in der virtuellen Maschine verschlüsselt.

Felder
kms_key	string Die Cloud KMS-Ressourcen-ID des kundenverwalteten Verschlüsselungsschlüssels, der zum Schutz einer Ressource verwendet wird, z. B. für ein Laufwerk. Sie hat folgendes Format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

Umgebung

Definition einer Softwareumgebung, die zum Starten einer Notebook-Instanz verwendet wird.

Felder
name	string Nur Ausgabe. Name dieser Umgebung. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
display_name	string Anzeigename dieser Umgebung für die Benutzeroberfläche.
description	string Eine kurze Beschreibung dieser Umgebung.
post_startup_script	string Pfad zu einem Bash-Script, das automatisch ausgeführt wird, nachdem eine Notebook-Instanz vollständig hochgefahren wurde. Der Pfad muss eine URL oder ein Cloud Storage-Pfad sein. Beispiel: "gs://path-to-file/file-name"
create_time	Timestamp Nur Ausgabe. Der Zeitpunkt, zu dem diese Umgebung erstellt wurde.
Union-Feld image_type. Typ der Umgebung; kann „VM-Image“ oder „Container-Image“ sein. Für image_type ist nur einer der folgenden Werte zulässig:
vm_image	VmImage Verwenden Sie ein Compute Engine-VM-Image, um die Notebook-Instanz zu starten.
container_image	ContainerImage Verwenden Sie ein Container-Image, um die Notebook-Instanz zu starten.

Ereignis

Die Definition eines Ereignisses für eine verwaltete / teilweise verwaltete Notebook-Instanz.

Felder
report_time	Timestamp Zeit des Ereignisberichts.
type	EventType Ereignistyp.
details	map<string, string> Optional. Termindetails Dieses Feld wird verwendet, um Ereignisinformationen zu übergeben.

EventType

Die Definition der Ereignistypen.

Enums
EVENT_TYPE_UNSPECIFIED	Ereignis nicht angegeben.
IDLE	Die Instanz / Laufzeit ist inaktiv
HEARTBEAT	Die Instanz / Laufzeit ist verfügbar. Dieses Ereignis gibt an, dass die zugrunde liegende Rechenleistung der Instanz / Laufzeit betriebsbereit ist.
HEALTH	Der Systemstatus der Instanz / Laufzeit ist verfügbar. Dieses Ereignis gibt Informationen zum Status der Instanz / Laufzeit an.
MAINTENANCE	Die Instanz / Laufzeit ist verfügbar. Mit diesem Ereignis kann die Instanz / Laufzeit Informationen zur Hostwartung an die Steuerungsebene senden. https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

Ausführung

Die Definition eines einzelnen ausgeführten Notebooks.

Felder
execution_template	ExecutionTemplate Metadaten zur Ausführung, einschließlich Name, Hardwarespezifikation, Region, Labels usw.
name	string Nur Ausgabe. Der Ressourcenname der Ausführung. Format: projects/{project_id}/locations/{location}/executions/{execution_id}
display_name	string Nur Ausgabe. Name, der für die Benutzeroberfläche verwendet wird. Der Name darf nur alphanumerische Zeichen und Unterstriche „_“ enthalten.
description	string Eine kurze Beschreibung dieser Ausführung.
create_time	Timestamp Nur Ausgabe. Zeitpunkt, zu dem die Ausführung instanziiert wurde.
update_time	Timestamp Nur Ausgabe. Zeitpunkt der letzten Aktualisierung der Ausführung.
state	State Nur Ausgabe. Status des zugrunde liegenden AI Platform-Jobs.
output_notebook_file	string Ausgabe-Notebook-Datei, die bei dieser Ausführung generiert wurde
job_uri	string Nur Ausgabe. Der URI des externen Jobs, der zum Ausführen des Notebooks verwendet wurde.

Bundesland

Enum-Beschreibung des Status des zugrunde liegenden AIP-Jobs.

Enums
STATE_UNSPECIFIED	Der Jobstatus ist nicht angegeben.
QUEUED	Der Job wurde gerade erstellt und die Verarbeitung hat noch nicht begonnen.
PREPARING	Der Dienst bereitet die Ausführung des Jobs vor.
RUNNING	Der Job wird bearbeitet.
SUCCEEDED	Der Job wurde erfolgreich abgeschlossen.
FAILED	Der Job ist fehlgeschlagen. error_message sollte die Details des Fehlers enthalten.
CANCELLING	Der Job wird abgebrochen. error_message sollte den Grund für den Abbruch beschreiben.
CANCELLED	Der Job wurde abgebrochen. error_message sollte den Grund für den Abbruch beschreiben.
EXPIRED	Der Job ist abgelaufen (relevant für Agent Platform-Jobs) https://cloud.google.com/gemini-enterprise-agent-platform/reference/rest/v1/JobState
INITIALIZING	Die Ausführung wird erstellt.

ExecutionTemplate

Die Beschreibung einer Arbeitslast für die Notebook-Ausführung.

Felder
scale_tier (deprecated)	ScaleTier Dieses Element wird nicht mehr unterstützt. Erforderlich. Skalierungsstufe der Hardware, die für die Notebook-Ausführung verwendet wird. VERALTET Wird eingestellt. Derzeit wird nur CUSTOM unterstützt.
master_type	string Gibt den Typ der virtuellen Maschine an, die für den Master-Worker Ihres Trainingsjobs verwendet werden soll. Dieses Feld müssen Sie angeben, wenn scaleTier auf CUSTOM gesetzt ist. Bestimmte Compute Engine-Maschinentypen können Sie direkt in diesem Feld verwenden. Die folgenden Typen werden unterstützt: 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 Alternativ können Sie die folgenden Legacy-Maschinentypen verwenden: 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 Wenn Sie eine TPU für das Training verwenden möchten, geben Sie in diesem Feld cloud_tpu an. Weitere Informationen zu den speziellen Konfigurationsoptionen für das Training mit TPU
accelerator_config	SchedulerAcceleratorConfig Konfiguration (Anzahl und Beschleunigertyp) für die Hardware, auf der die Notebookausführung erfolgt.
labels	map<string, string> Labels für die Ausführung. Wenn die Ausführung geplant ist, wird das Feld „nbs-scheduled“ eingefügt. Andernfalls erfolgt die Ausführung sofort und das Feld „nbs-immediate“ ist enthalten. Mit Feldern können Sie verschiedene Arten von Ausführungen effizient indexieren.
input_notebook_file	string Pfad zur auszuführenden Notebook-Datei. Die Datei muss in einem Google Cloud Storage-Bucket gespeichert sein. Format: gs://{bucket_name}/{folder}/{notebook_file_name} Beispiel: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
container_image_uri	string URI des Container-Images für eine DLVM, z. B. „gcr.io/deeplearning-platform-release/base-cu100“. Weitere Beispiele finden Sie unter https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container.
output_notebook_folder	string Pfad zum Notebook-Ordner, in den geschrieben werden soll. Muss sich in einem Google Cloud Storage-Bucket-Pfad befinden. Format: gs://{bucket_name}/{folder} Beispiel: gs://notebook_user/scheduled_notebooks
params_yaml_file	string Parameter, die während der Ausführung im Notebook überschrieben werden sollen. Unter https://papermill.readthedocs.io/en/latest/usage-parameterize.html finden Sie Informationen dazu, wie Sie Parameter im Eingabe-Notebook angeben und hier in einer YAML-Datei übergeben. Beispiel: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters	string Parameter, die im Notebook „input_notebook_file“ verwendet werden.
service_account	string Die E-Mail-Adresse eines Dienstkontos, das beim Ausführen der Ausführung verwendet werden soll. Sie benötigen die Berechtigung iam.serviceAccounts.actAs für das angegebene Dienstkonto.
job_type	JobType Der Jobtyp, der für diese Ausführung verwendet werden soll.
kernel_spec	string Name der zu verwendenden Kernelspezifikation. Dies muss angegeben werden, wenn der Name der Kernelspezifikation auf dem Ausführungsziel nicht mit dem Namen in der Eingabe-Notebookdatei übereinstimmt.
tensorboard	string Der Name einer [Tensorboard]-Ressource der Agent Platform, in die bei dieser Ausführung TensorBoard-Logs hochgeladen werden. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
Union-Feld job_parameters. Parameter für einen Ausführungstyp. HINWEIS: Derzeit gibt es keine zusätzlichen Parameter für Vertex AI-Jobs. Für job_parameters ist nur einer der folgenden Werte zulässig:
dataproc_parameters	DataprocParameters Parameter, die in Dataproc JobType-Ausführungen verwendet werden.
vertex_ai_parameters	VertexAIParameters Parameter, die in Agent Platform JobType-Ausführungen verwendet werden.

DataprocParameters

Parameter, die in Dataproc JobType-Ausführungen verwendet werden.

Felder
cluster	string URI für den Cluster, der zum Ausführen der Dataproc-Ausführung verwendet wird. Format: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

Das für diese Ausführung verwendete Backend.

Enums
JOB_TYPE_UNSPECIFIED	Kein Typ angegeben
VERTEX_AI	Benutzerdefinierter Job in aiplatform.googleapis.com. Standardwert für eine Ausführung.
DATAPROC	Ausführung auf einem Cluster mit Dataproc als Job ausführen. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

Erforderlich. Gibt die Maschinentypen, die Anzahl der Replikate für Worker und Parameterserver an.

Enums
SCALE_TIER_UNSPECIFIED	Nicht angegebene Skalierungsstufe.
BASIC	Eine einzelne Worker-Instanz. Diese Stufe eignet sich zum Kennenlernen der Funktionsweise von Cloud ML und zum Experimentieren mit neuen Modellen unter Verwendung kleiner Datasets.
STANDARD_1	Viele Worker und einige Parameterserver
PREMIUM_1	Eine große Anzahl von Workern mit vielen Parameterservern
BASIC_GPU	Eine einzelne Worker-Instanz mit einer K80-GPU.
BASIC_TPU	Eine einzelne Worker-Instanz mit einer Cloud TPU.
CUSTOM	Die Skalierungsstufe CUSTOM ist keine vordefinierte Stufe, sondern ermöglicht Ihnen vielmehr, Ihre eigene Clusterspezifikation zu verwenden. Orientieren Sie sich bei Verwendung dieser Stufe an den folgenden Richtlinien, um Werte zur Konfiguration des Verarbeitungsclusters festzulegen: Sie müssen ExecutionTemplate.masterType festlegen, um den Maschinentyp anzugeben, der für den Masterknoten verwendet werden soll. Dies ist die einzige erforderliche Einstellung.

SchedulerAcceleratorConfig

Definition eines Hardwarebeschleunigers. Nicht alle Kombinationen von type und core_count sind gültig. Eine gültige Kombination finden Sie unter GPUs in Compute Engine. TPUs werden nicht unterstützt.

Felder
type	SchedulerAcceleratorType Typ dieses Beschleunigers.
core_count	int64 Anzahl der Kerne dieses Beschleunigers.

SchedulerAcceleratorType

Hardwarebeschleunigertypen für AI Platform Training-Jobs.

Enums
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED	Nicht angegebener Beschleunigertyp. Standardeinstellung ist "GPU".
NVIDIA_TESLA_K80	Nvidia Tesla K80 GPU
NVIDIA_TESLA_P100	Nvidia Tesla P100 GPU
NVIDIA_TESLA_V100	Nvidia Tesla V100 GPU
NVIDIA_TESLA_P4	Nvidia Tesla P4 GPU
NVIDIA_TESLA_T4	Nvidia Tesla T4 GPU
NVIDIA_TESLA_A100	Nvidia Tesla A100 GPU
TPU_V2	TPU v2
TPU_V3	TPU v3.

VertexAIParameters

Parameter, die in Agent Platform JobType-Ausführungen verwendet werden.

Felder
network	string Der vollständige Name des Compute Engine-Netzwerks, mit dem der Job per Peering verbunden werden soll. Beispiel: projects/12345/global/networks/myVPC. Format hat das Format projects/{project}/global/networks/{network}. Dabei ist {project} eine Projektnummer wie in 12345 und {network} ein Netzwerkname. Der Zugriff auf private Dienste muss bereits für das Netzwerk konfiguriert sein. Wenn nicht angegeben, wird der Job nicht über Peering mit einem Netzwerk verbunden.
env	map<string, string> Umgebungsvariablen. Es können maximal 100 Umgebungsvariablen angegeben werden, die eindeutig sein müssen. Beispiel: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

Anfrage zum Abrufen einer Notebook-Umgebung.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/environments/{environment_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.environments.get

GetExecutionRequest

Anfrage zum Abrufen der geplanten Notebook-Ausführung

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/executions/{execution_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.executions.get

GetInstanceHealthRequest

Anfrage zum Prüfen, ob eine Notebook-Instanz fehlerfrei ist.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.getHealth

GetInstanceHealthResponse

Antwort auf die Anfrage, ob eine Notebook-Instanz fehlerfrei ist.

Felder
health_state	HealthState Nur Ausgabe. Laufzeit-health_state.
health_info	map<string, string> Nur Ausgabe. Zusätzliche Informationen zum Instanzzustand. 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" }

HealthState

Gibt an, ob eine Instanz fehlerfrei ist.

Enums
HEALTH_STATE_UNSPECIFIED	Der Unterstatus der Instanz ist unbekannt.
HEALTHY	Die Instanz ist bekanntermaßen in einem fehlerfreien Zustand (z. B. werden kritische Daemons ausgeführt). Gilt für den Status „ACTIVE“.
UNHEALTHY	Die Instanz ist bekanntermaßen fehlerhaft (z. B. werden kritische Daemons nicht ausgeführt). Gilt für den Status „ACTIVE“.
AGENT_NOT_INSTALLED	Auf der Instanz ist kein Agent zur Zustandsüberwachung installiert. Gilt für den Status AKTIV.
AGENT_NOT_RUNNING	Der Agent für die Zustandsüberwachung der Instanz wird nicht ausgeführt. Gilt für den Status AKTIV.

GetInstanceRequest

Anfrage zum Abrufen einer Notebook-Instanz.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.get

GetRuntimeRequest

Anfrage zum Abrufen einer Managed Notebook-Laufzeit.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.runtimes.get

GetScheduleRequest

Anfrage zum Abrufen eines geplanten Notebooks.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.schedules.get

Instanz

Die Definition einer Notebook-Instanz.

Felder
name	string Nur Ausgabe. Der Name dieser Notebook-Instanz. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
post_startup_script	string Pfad zu einem Bash-Script, das automatisch ausgeführt wird, nachdem eine Notebook-Instanz vollständig hochgefahren wurde. Der Pfad muss eine URL oder ein Cloud Storage-Pfad (gs://path-to-file/file-name) sein.
proxy_uri	string Nur Ausgabe. Der Proxy-Endpunkt, der für den Zugriff auf das Jupyter-Notebook verwendet wird.
instance_owners[]	string Nur Eingabe. Der Inhaber dieser Instanz nach der Erstellung. Format: [e-mail] Derzeit wird nur ein Eigentümer unterstützt. Wenn nicht angegeben, können alle Dienstkontonutzer des Dienstkontos Ihrer VM-Instanz die Instanz verwenden.
service_account	string Das Dienstkonto auf dieser Instanz, das Zugriff auf andere Google Cloud-Dienste bietet. Sie können jedes Dienstkonto innerhalb desselben Projekts verwenden, allerdings benötigen Sie die Berechtigung als Dienstkontonutzer, um die Instanz verwenden zu können. Wenn nicht angegeben, wird das Compute Engine-Standarddienstkonto verwendet.
service_account_scopes[]	string Optional. Die URIs der Dienstkontobereiche, die in Compute Engine-Instanzen enthalten sein sollen. Wenn nicht angegeben, werden die folgenden Bereiche definiert: – https://www.googleapis.com/auth/cloud-platform – https://www.googleapis.com/auth/userinfo.email Wenn Sie keine Standardbereiche verwenden, benötigen Sie mindestens: https://www.googleapis.com/auth/compute
machine_type	string Erforderlich. Der Compute Engine-Maschinentyp dieser Instanz.
accelerator_config	AcceleratorConfig Der auf dieser Instanz verwendete Hardwarebeschleuniger. Wenn Sie Beschleuniger verwenden, muss Ihre Konfiguration genügend vCPUs und Arbeitsspeicher zur Unterstützung der ausgewählten machine_type haben.
state	State Nur Ausgabe. Der Status dieser Instanz.
install_gpu_driver	bool Gibt an, ob der Endnutzer Google Cloud autorisiert, den GPU-Treiber auf dieser Instanz zu installieren. Wenn dieses Feld leer ist oder auf „false“ gesetzt ist, wird der GPU-Treiber nicht installiert. Gilt nur für Instanzen mit GPUs.
custom_gpu_driver_path	string Geben Sie einen benutzerdefinierten Cloud Storage-Pfad an, in dem der GPU-Treiber gespeichert ist. Wenn nichts angegeben ist, wählen wir automatisch aus offiziellen GPU-Treibern aus.
boot_disk_type	DiskType Nur Eingabe. Der Typ des Bootlaufwerks, das an diese Instanz angehängt ist. Der Standardwert ist ein nichtflüchtiger Standardspeicher (PD_STANDARD).
boot_disk_size_gb	int64 Nur Eingabe. Die Größe des Bootlaufwerks in GB, das an diese Instanz angehängt ist, bis zu einem Maximum von 64.000 GB (64 TB). Der empfohlene Mindestwert beträgt 100 GB. Wenn keine Angabe erfolgt, wird standardmäßig 100 verwendet.
data_disk_type	DiskType Nur Eingabe. Der Typ des an diese Instanz angehängten Datenträgers. Der Standardwert ist ein nichtflüchtiger Standardspeicher (PD_STANDARD).
data_disk_size_gb	int64 Nur Eingabe. Die Größe des Datenlaufwerks in GB, das an diese Instanz angehängt ist, bis zu einem Maximum von 64.000 GB (64 TB). Sie können die Größe des Datenträgers basierend auf der Größe Ihrer Notebooks und Daten auswählen. Wenn keine Angabe erfolgt, wird standardmäßig 100 verwendet.
no_remove_data_disk	bool Nur Eingabe. Wenn „true“, wird das Datenlaufwerk beim Löschen der Instanz nicht automatisch gelöscht.
disk_encryption	DiskEncryption Nur Eingabe. Die auf den Boot- und Datenlaufwerken verwendete Laufwerkverschlüsselungsmethode. Der Standardwert ist GMEK.
kms_key	string Nur Eingabe. Der KMS-Schlüssel, der zum Verschlüsseln der Laufwerke verwendet wird. Gilt nur, wenn „disk_encryption“ CMEK ist. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Weitere Informationen zur Verwendung eigener Verschlüsselungsschlüssel
disks[]	Disk Nur Ausgabe. Der Notebookinstanz angehängte Laufwerke.
shielded_instance_config	ShieldedInstanceConfig Optional. Shielded VM-Konfiguration. Images, die unterstützte Shielded VM-Funktionen verwenden.
no_public_ip	bool Wenn „true“, wird dieser Instanz keine externe IP-Adresse zugewiesen.
no_proxy_access	bool Bei „true“ wird die Notebook-Instanz nicht beim Proxy registriert.
network	string Der Name der VPC, in der sich diese Instanz befindet. Format: projects/{project_id}/global/networks/{network_id}
subnet	string Der Name des Subnetzes, in dem sich diese Instanz befindet. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
labels	map<string, string> Labels, die auf diese Instanz angewendet werden sollen. Diese können später mit der Methode „setLabels“ geändert werden.
metadata	map<string, string> Benutzerdefinierte Metadaten, die auf diese Instanz angewendet werden sollen. Wenn Sie beispielsweise einen Cloud Storage-Bucket für die automatische Sicherung angeben möchten, können Sie das Metadaten-Tag gcs-data-bucket verwenden. Format: "--metadata=gcs-data-bucket=BUCKET".
tags[]	string Optional. Die Compute Engine-Netzwerktags, die der Laufzeit hinzugefügt werden sollen (siehe Netzwerktags konfigurieren).
upgrade_history[]	UpgradeHistoryEntry Der Upgradeverlauf dieser Instanz.
nic_type	NicType Optional. Der Typ der vNIC, die auf dieser Schnittstelle verwendet werden soll. Das kann gVNIC oder VirtioNet sein.
reservation_affinity	ReservationAffinity Optional. Die optionale Reservierungsaffinität. Wenn Sie dieses Feld festlegen, wird die angegebene zonale Compute-Reservierung auf diese Notebook-Instanz angewendet.
creator	string Nur Ausgabe. E-Mail-Adresse der Organisation, die die ursprüngliche CreateInstance-Anfrage gesendet hat.
can_ip_forward	bool Optional. Flag zum Aktivieren oder Deaktivieren der IP-Weiterleitung. Standardmäßig ist es auf „false“ (aus) gesetzt. https://cloud.google.com/vpc/docs/using-routes#canipforward
create_time	Timestamp Nur Ausgabe. Erstellungszeit der Instanz.
update_time	Timestamp Nur Ausgabe. Zeitpunkt der Instanzaktualisierung.
instance_migration_eligibility	InstanceMigrationEligibility Nur Ausgabe. Prüft, wie machbar eine Migration von UmN zu WbI ist.
Union-Feld environment. Typ der Umgebung; kann „VM-Image“ oder „Container-Image“ sein. Für environment ist nur einer der folgenden Werte zulässig:
vm_image	VmImage Verwenden Sie ein Compute Engine-VM-Image, um die Notebook-Instanz zu starten.
container_image	ContainerImage Verwenden Sie ein Container-Image, um die Notebook-Instanz zu starten.
migrated	bool Nur Ausgabe. Boolescher Wert, der angibt, ob dieses Notebook zu einer Workbench-Instanz migriert wurde.

AcceleratorConfig

Definition eines Hardwarebeschleunigers. Nicht alle Kombinationen von type und core_count sind gültig. Eine gültige Kombination finden Sie unter GPUs in Compute Engine. TPUs werden nicht unterstützt.

Felder
type	AcceleratorType Typ dieses Beschleunigers.
core_count	int64 Anzahl der Kerne dieses Beschleunigers.

AcceleratorType

Definition der Arten von Hardwarebeschleunigern, die auf dieser Instanz verwendet werden können.

Enums
ACCELERATOR_TYPE_UNSPECIFIED	Der Beschleunigertyp ist nicht angegeben.
NVIDIA_TESLA_K80	Der Beschleunigertyp ist Nvidia Tesla K80.
NVIDIA_TESLA_P100	Der Beschleunigertyp ist Nvidia Tesla P100.
NVIDIA_TESLA_V100	Der Beschleunigertyp ist Nvidia Tesla V100.
NVIDIA_TESLA_P4	Der Beschleunigertyp ist Nvidia Tesla P4.
NVIDIA_TESLA_T4	Der Beschleunigertyp ist Nvidia Tesla T4.
NVIDIA_TESLA_A100	Der Beschleunigertyp ist Nvidia Tesla A100.
NVIDIA_L4	Der Beschleunigertyp ist Nvidia Tesla L4.
NVIDIA_A100_80GB	Der Beschleunigertyp ist Nvidia Tesla A100 80 GB.
NVIDIA_TESLA_T4_VWS	Der Beschleunigertyp ist NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS	Der Beschleunigertyp ist NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS	Der Beschleunigertyp ist NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_H100_80GB	Der Beschleunigertyp ist NVIDIA H100 mit 80 GB.
NVIDIA_H100_MEGA_80GB	Der Beschleunigertyp ist NVIDIA H100 Mega mit 80 GB.
TPU_V2	(Demnächst verfügbar) Der Beschleunigertyp ist TPU V2.
TPU_V3	(Demnächst verfügbar) Der Beschleunigertyp ist TPU V3.

Laufwerk

Eine an eine Instanz angehängte Laufwerksressource.

Felder
auto_delete	bool Gibt an, ob das Laufwerk automatisch gelöscht wird, wenn die Instanz gelöscht wird. Dies gilt nicht, wenn das Laufwerk von der Instanz getrennt wird.
boot	bool Gibt an, dass es sich um ein Bootlaufwerk handelt. Für das Root-Dateisystem der virtuellen Maschine wird die erste Partition des Laufwerks verwendet.
device_name	string Gibt einen eindeutigen Gerätenamen an, der im /dev/disk/by-id/google-*-Baum des Linux-Betriebssystems innerhalb der Instanz widergespiegelt wird. Mit diesem Namen kann das Gerät z. B. aus der Instanz heraus bereitgestellt oder in der Größe angepasst werden. Wenn Sie keine Angabe machen, wird auf dem Server ein standardmäßiger Gerätename für das Laufwerk nach dem Schema „persistent-disk-x“ ausgewählt. „x“ steht dabei für eine mit Google Compute Engine festgelegte Zahl. Dieses Feld ist nur für nichtflüchtige Speicher anwendbar.
disk_size_gb	int64 Gibt die Größe des Laufwerks in GB (Basis 2) an.
guest_os_features[]	GuestOsFeature Gibt eine Liste der Funktionen an, die im Gastbetriebssystem aktiviert werden sollen. Gilt nur für bootfähige Images. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren.
index	int64 Ein nullbasierter Index für dieses Laufwerk, wobei 0 für das Startlaufwerk reserviert ist. Wenn viele Laufwerke an eine Instanz angehängt sind, hat jedes Laufwerk eine eindeutige Indexnummer.
interface	string Gibt die Laufwerksschnittstelle an, die zum Anhängen dieses Laufwerks verwendet werden soll. Dies kann entweder SCSI oder NVME sein. Der Standardwert ist SCSI. Für nichtflüchtige Speicher muss immer SCSI verwendet werden. Der Vorgang schlägt fehl, wenn Sie versuchen, einen nichtflüchtigen Speicher in einem anderen Format als SCSI anzuhängen. Lokale SSDs können entweder NVME oder SCSI verwenden. Informationen zu den Leistungsmerkmalen von SCSI über NVMe finden Sie unter Leistung lokaler SSDs. Zulässige Werte: NVME SCSI
kind	string Typ der Ressource. Berechnen Sie immer „compute#attachedDisk“ für angehängte Laufwerke.
licenses[]	string Eine Liste öffentlich sichtbarer Lizenzen. Für die Nutzung durch Google reserviert. Eine Lizenz enthält Abrechnungs- und aggregierte Nutzungsdaten für öffentliche und Marketplace-Images.
mode	string Der Modus, in dem dieses Laufwerk angehängt werden soll, entweder READ_WRITE oder READ_ONLY. Wenn nichts angegeben ist, wird das Laufwerk standardmäßig im Modus READ_WRITE angehängt. Zulässige Werte: READ_ONLY READ_WRITE
source	string Gibt eine gültige partielle oder vollständige URL zu einer vorhandenen Ressource für nichtflüchtigen Speicher an.
type	string Gibt den Typ des Laufwerks an, entweder SCRATCH oder PERSISTENT. Zulässige Werte: PERSISTENT SCRATCH

GuestOsFeature

Features des Gastbetriebssystems für das Bootlaufwerk.

Felder
type	string Die ID einer unterstützten Funktion. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren. Zulässige Werte: FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS

DiskEncryption

Definition der Optionen für die Laufwerkverschlüsselung.

Enums
DISK_ENCRYPTION_UNSPECIFIED	Die Festplattenverschlüsselung ist nicht angegeben.
GMEK	Verwenden Sie von Google verwaltete Verschlüsselungsschlüssel, um das Bootlaufwerk zu verschlüsseln.
CMEK	Verwenden Sie vom Kunden verwaltete Verschlüsselungsschlüssel, um das Bootlaufwerk zu verschlüsseln.

DiskType

Mögliche Laufwerkstypen für Notebook-Instanzen.

Enums
DISK_TYPE_UNSPECIFIED	Der Laufwerkstyp wurde nicht festgelegt.
PD_STANDARD	Typ des nichtflüchtigen Standardspeichers.
PD_SSD	Typ des nichtflüchtiger SSD-Speicher.
PD_BALANCED	Typ des abgestimmten nichtflüchtigen Speichers.
PD_EXTREME	Typ des extrem nichtflüchtigen Speichers.

NicType

Der Typ des vNIC-Treibers. Der Standardwert sollte UNSPECIFIED_NIC_TYPE sein.

Enums
UNSPECIFIED_NIC_TYPE	Kein Typ angegeben
VIRTIO_NET	VIRTIO
GVNIC	GVNIC

ShieldedInstanceConfig

Eine Reihe von Optionen für abgeschirmte Instanzen. Weitere Informationen finden Sie unter Images mit unterstützten Shielded VM-Funktionen. Nicht alle Kombinationen sind gültig.

Felder
enable_secure_boot	bool Gibt an, ob für die Instanz Secure Boot aktiviert ist. Secure Boot sorgt dafür, dass das System nur authentische Software ausführt. Dazu wird die digitale Signatur aller Bootkomponenten überprüft und der Bootvorgang angehalten, wenn die Signaturüberprüfung fehlschlägt. Standardmäßig deaktiviert.
enable_vtpm	bool Definiert, ob vTPM für die Instanz aktiviert ist. Standardmäßig aktiviert.
enable_integrity_monitoring	bool Gibt an, ob für die Instanz das Integritätsmonitoring aktiviert ist. Ermöglicht das Monitoring und die Attestierung der Bootintegrität der Instanz. Die Attestierung erfolgt anhand der Referenz der Integritätsrichtlinie. Diese Referenz wird bei der Erstellung der Instanz vom Boot-Image abgeleitet, dem implizit vertraut wird. Standardmäßig aktiviert.

Bundesland

Die Definition der Status dieser Instanz.

Enums
STATE_UNSPECIFIED	Der Status ist nicht angegeben.
STARTING	Die Steuerungslogik startet die Instanz.
PROVISIONING	Die Steuerungslogik installiert die erforderlichen Frameworks und registriert die Instanz beim Notebook-Proxy.
ACTIVE	Die Instanz wird ausgeführt.
STOPPING	Die Steuerungslogik beendet die Instanz.
STOPPED	Die Instanz wurde angehalten.
DELETED	Die Instanz wird gelöscht.
UPGRADING	Die Instanz wird aktualisiert.
INITIALIZING	Die Instanz wird gerade erstellt.
REGISTERING	Die Instanz wird registriert.
SUSPENDING	Die Instanz wird gesperrt.
SUSPENDED	Die Instanz wurde gesperrt.

UpgradeHistoryEntry

Der Eintrag des VM-Image-Upgradeverlaufs.

Felder
snapshot	string Der Snapshot des Bootlaufwerks dieser Notebook-Instanz vor dem Upgrade.
vm_image	string Das VM-Image vor diesem Instanz-Upgrade.
container_image	string Das Container-Image vor dem Upgrade dieser Instanz.
framework	string Das Framework dieser Notebook-Instanz.
version	string Die Version der Notebook-Instanz vor diesem Upgrade.
state	State Der Status dieses Eintrags im Verlauf der Instanzupgrades.
create_time	Timestamp Der Zeitpunkt, zu dem dieser Eintrag im Verlauf der Instanzupgrades erstellt wurde.
target_image (deprecated)	string Dieses Element wird nicht mehr unterstützt. Ziel-VM-Image Format: ainotebooks-vm/project/image-name/name.
action	Action Aktion Rollback oder Upgrade.
target_version	string Ziel-VM-Version, z. B. „m63“.

Aktion

Die Definition der Vorgänge dieses Upgradeverlaufs.

Enums
ACTION_UNSPECIFIED	Der Vorgang ist nicht angegeben.
UPGRADE	Upgrade durchführen.
ROLLBACK	Rollback auslösen.

Bundesland

Die Definition der Status dieses Upgradeverlaufseintrags.

Enums
STATE_UNSPECIFIED	Der Status ist nicht angegeben.
STARTED	Das Upgrade der Instanz wurde gestartet.
SUCCEEDED	Das Instanzupgrade wurde erfolgreich durchgeführt.
FAILED	Das Instanzupgrade ist fehlgeschlagen.

InstanceConfig

Notebook-Instanzkonfigurationen, die aktualisiert werden können.

Felder
notebook_upgrade_schedule	string Cron-Ausdruck in der UTC-Zeitzone, der zum Planen des automatischen Upgrades von Instanzen verwendet wird. Halten Sie sich bitte an das cron-Format.
enable_health_monitoring	bool Prüft, ob die wichtigsten internen Dienste ausgeführt werden.

InstanceMigrationEligibility

InstanceMigrationEligibility stellt die Machbarkeitsinformationen für eine Migration von UmN zu WbI dar.

Felder
warnings[]	Warning Nur Ausgabe. Bestimmte Konfigurationen werden während der Migration auf die Standardeinstellungen zurückgesetzt.
errors[]	Error Nur Ausgabe. Bei bestimmten Konfigurationen ist eine automatische Migration nicht möglich. Eine manuelle Migration ist erforderlich.

Fehler

Eine Migrationsfehlermeldung bedeutet, dass bestimmte Konfigurationen die automatische Migration eines UmN verhindern. Eine manuelle Migration ist erforderlich.

Enums
ERROR_UNSPECIFIED	Standardtyp.
DATAPROC_HUB	Der UmN verwendet Dataproc Hub und kann nicht migriert werden.

Warnung

Eine Migrationswarnung bedeutet, dass bestimmte Konfigurationen während der Migration auf die Standardeinstellungen zurückgesetzt werden.

Enums
WARNING_UNSPECIFIED	Standardtyp.
UNSUPPORTED_MACHINE_TYPE	Die UmN verwendet einen Maschinentyp, der in WbI nicht unterstützt wird. Es wird mit dem Standardmaschinentyp „e2-standard-4“ migriert. Nutzer können den Maschinentyp nach der Migration ändern.
UNSUPPORTED_ACCELERATOR_TYPE	Die UmN verwendet einen Beschleunigertyp, der in WbI nicht unterstützt wird. Es wird ohne Beschleuniger migriert. Nutzer können einen Beschleuniger nach der Migration anhängen.
UNSUPPORTED_OS	Die UmN verwendet ein Betriebssystem, das in WbI nicht unterstützt wird (z.B. Debian 10, Ubuntu). Es wird in WbI durch Debian 11 ersetzt.
NO_REMOVE_DATA_DISK	Dieses UmN ist mit „no_remove_data_disk“ konfiguriert, das in WbI nicht mehr verfügbar ist.
GCS_BACKUP	Dieses UmN ist mit dem Feature für Cloud Storage-Sicherungen konfiguriert, das in WbI nicht mehr verfügbar ist.
POST_STARTUP_SCRIPT	Diese UmN ist mit einem Post-Startscript konfiguriert. Geben Sie optional die post_startup_script_option für die Migration an.

IsInstanceUpgradeableRequest

Anfrage zum Prüfen, ob eine Notebook-Instanz aktualisiert werden kann.

Felder
notebook_instance	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource notebookInstance: notebooks.instances.checkUpgradability
type	UpgradeType Optional. Der optionale UpgradeType. Wenn Sie dieses Feld festlegen, wird nach zusätzlichen Compute-Images gesucht, um ein Upgrade für diese Instanz durchzuführen.

IsInstanceUpgradeableResponse

Antwort auf die Frage, ob eine Notebook-Instanz aktualisiert werden kann.

Felder
upgradeable	bool Ob eine Instanz aktualisiert werden kann.
upgrade_version	string Die Version, auf die diese Instanz aktualisiert wird, wenn der Upgrade-Endpunkt aufgerufen wird. Dieses Feld wird nur ausgefüllt, wenn „field_upgradeable“ auf „true“ gesetzt ist.
upgrade_info	string Zusätzliche Informationen zum Upgrade.
upgrade_image	string Der neue Self-Link des Bildes, auf das diese Instanz aktualisiert wird, wenn der Upgrade-Endpunkt aufgerufen wird. Dieses Feld wird nur ausgefüllt, wenn „field_upgradeable“ auf „true“ gesetzt ist.

ListEnvironmentsRequest

Anfrage zum Auflisten von Umgebungen.

Felder
parent	string Erforderlich. Format: projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.environments.list
page_size	int32 Maximale Rückgabegröße des Listenaufrufs.
page_token	string Ein zuvor zurückgegebenes Seitentoken, mit dem die Auflistung ab dem letzten Ergebnis fortgesetzt werden kann.

ListEnvironmentsResponse

Antwort für das Auflisten von Umgebungen.

Felder
environments[]	Environment Eine Liste der zurückgegebenen Umgebungen.
next_page_token	string Ein Seitentoken, mit dem die Auflistung im nächsten Listenaufruf ab dem letzten Ergebnis fortgesetzt werden kann.
unreachable[]	string Standorte, die nicht erreicht werden konnten.

ListExecutionsRequest

Anfrage zum Auflisten geplanter Notebook-Ausführungen.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.executions.list
page_size	int32 Maximale Rückgabegröße des Listenaufrufs.
page_token	string Ein zuvor zurückgegebenes Seitentoken, mit dem die Auflistung ab dem letzten Ergebnis fortgesetzt werden kann.
filter	string Filter, der auf die resultierenden Ausführungen angewendet wird. Derzeit wird nur das Filtern von Ausführungen nach einer bestimmten schedule_id unterstützt. Format: schedule_id=<Schedule_ID>
order_by	string Nach Feld sortieren.

ListExecutionsResponse

Antwort für das Auflisten geplanter Notebookausführungen

Felder
executions[]	Execution Eine Liste der zurückgegebenen Instanzen.
next_page_token	string Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis im nächsten Listenaufruf fortzusetzen.
unreachable[]	string Ausführungs-IDs, die nicht erreicht werden konnten. Beispiel: ['projects/{project_id}/location/{location}/executions/imagenet_test1', 'projects/{project_id}/location/{location}/executions/classifier_train1']

ListInstancesRequest

Anfrage zum Auflisten von Notebook-Instanzen.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.instances.list
page_size	int32 Maximale Rückgabegröße des Listenaufrufs.
page_token	string Ein zuvor zurückgegebenes Seitentoken, mit dem die Auflistung ab dem letzten Ergebnis fortgesetzt werden kann.
order_by	string Optional. Ergebnisse sortieren. Unterstützte Werte sind "name", "name desc" oder "" (nicht sortiert).
filter	string Optional. Listenfilter

ListInstancesResponse

Antwort für das Auflisten von Notebook-Instanzen.

Felder
instances[]	Instance Eine Liste der zurückgegebenen Instanzen.
next_page_token	string Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis im nächsten Listenaufruf fortzusetzen.
unreachable[]	string Standorte, die nicht erreicht werden konnten. Beispiel: ['us-west1-a', 'us-central1-b']. Eine ListInstancesResponse enthält entweder Instanzen oder nicht erreichbare Instanzen.

ListRuntimesRequest

Anfrage zum Auflisten von Managed Notebook-Laufzeiten.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.runtimes.list
page_size	int32 Maximale Rückgabegröße des Listenaufrufs.
page_token	string Ein zuvor zurückgegebenes Seitentoken, mit dem die Auflistung ab dem letzten Ergebnis fortgesetzt werden kann.
order_by	string Optional. Ergebnisse sortieren. Unterstützte Werte sind "name", "name desc" oder "" (nicht sortiert).
filter	string Optional. Listenfilter

ListRuntimesResponse

Antwort für das Auflisten von Managed Notebook-Laufzeiten.

Felder
runtimes[]	Runtime Eine Liste der zurückgegebenen Laufzeiten.
next_page_token	string Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis im nächsten Listenaufruf fortzusetzen.
unreachable[]	string Standorte, die nicht erreicht werden konnten. Beispiel: ['us-west1', 'us-central1']. Eine ListRuntimesResponse enthält entweder Runtimes oder Unreachables.

ListSchedulesRequest

Anfrage zum Auflisten geplanter Notebook-Jobs.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.schedules.list
page_size	int32 Maximale Rückgabegröße des Listenaufrufs.
page_token	string Ein zuvor zurückgegebenes Seitentoken, mit dem die Auflistung ab dem letzten Ergebnis fortgesetzt werden kann.
filter	string Filter, der auf die resultierenden Zeitpläne angewendet wird.
order_by	string Feld, nach dem die Ergebnisse sortiert werden sollen.

ListSchedulesResponse

Antwort für das Auflisten geplanter Notebook-Jobs.

Felder
schedules[]	Schedule Eine Liste der zurückgegebenen Instanzen.
next_page_token	string Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis im nächsten Listenaufruf fortzusetzen.
unreachable[]	string Zeitpläne, die nicht erreicht werden konnten. Beispiel: ['projects/{project_id}/location/{location}/schedules/monthly_digest', 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']

LocalDisk

Eine lokal angehängte Festplattenressource.

Felder
auto_delete	bool Optional. Nur Ausgabe. Gibt an, ob das Laufwerk automatisch gelöscht wird, wenn die Instanz gelöscht wird. Dies gilt nicht, wenn das Laufwerk von der Instanz getrennt wird.
boot	bool Optional. Nur Ausgabe. Gibt an, dass es sich um ein Bootlaufwerk handelt. Für das Root-Dateisystem der virtuellen Maschine wird die erste Partition des Laufwerks verwendet.
device_name	string Optional. Nur Ausgabe. Gibt einen eindeutigen Gerätenamen an, der im /dev/disk/by-id/google-*-Baum des Linux-Betriebssystems innerhalb der Instanz widergespiegelt wird. Mit diesem Namen kann das Gerät z. B. aus der Instanz heraus bereitgestellt oder in der Größe angepasst werden. Wenn Sie keine Angabe machen, wird auf dem Server ein standardmäßiger Gerätename für das Laufwerk nach dem Schema „persistent-disk-x“ ausgewählt. „x“ steht dabei für eine mit Google Compute Engine festgelegte Zahl. Dieses Feld gilt nur für persistente Laufwerke.
guest_os_features[]	RuntimeGuestOsFeature Nur Ausgabe. Gibt eine Liste der Funktionen an, die im Gastbetriebssystem aktiviert werden sollen. Gilt nur für bootfähige Images. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren.
index	int32 Nur Ausgabe. Ein nullbasierter Index für dieses Laufwerk, wobei 0 für das Startlaufwerk reserviert ist. Wenn viele Laufwerke an eine Instanz angehängt sind, hat jedes Laufwerk eine eindeutige Indexnummer.
initialize_params	LocalDiskInitializeParams Nur Eingabe. Gibt die Parameter für ein neues Laufwerk an, das zusammen mit der neuen Instanz erstellt wird. Verwenden Sie Initialisierungsparameter, um Bootlaufwerke oder lokale SSDs zu erstellen, die an die neue Instanz angehängt werden. Diese Property schließt die Quell-Property aus. Sie können nur eine der beiden definieren, aber nicht beide.
interface	string Gibt die Laufwerkschnittstelle an, die zum Anhängen dieses Laufwerks verwendet werden soll. Dies kann entweder SCSI oder NVME sein. Der Standardwert ist SCSI. Für nichtflüchtige Speicher muss immer SCSI verwendet werden. Der Vorgang schlägt fehl, wenn Sie versuchen, einen nichtflüchtigen Speicher in einem anderen Format als SCSI anzuhängen. Lokale SSDs können entweder NVME oder SCSI verwenden. Informationen zu den Leistungsmerkmalen von SCSI über NVMe finden Sie unter Leistung lokaler SSDs. Zulässige Werte: NVME SCSI
kind	string Nur Ausgabe. Typ der Ressource. Berechnen Sie immer „compute#attachedDisk“ für angehängte Laufwerke.
licenses[]	string Nur Ausgabe. Alle gültigen, öffentlich sichtbaren Lizenzen.
mode	string Der Modus, in dem dieses Laufwerk angehängt werden soll, entweder READ_WRITE oder READ_ONLY. Wenn nichts angegeben ist, wird das Laufwerk standardmäßig im Modus READ_WRITE angehängt. Zulässige Werte: READ_ONLY READ_WRITE
source	string Gibt eine gültige partielle oder vollständige URL zu einer vorhandenen Ressource für einen nichtflüchtigen Speicher an.
type	string Gibt den Typ des Laufwerks an, entweder SCRATCH oder PERSISTENT. Wenn keine Angabe erfolgt, wird der Standardwert PERSISTENT verwendet. Zulässige Werte: PERSISTENT SCRATCH

RuntimeGuestOsFeature

Optional. Eine Liste der Funktionen, die im Gastbetriebssystem aktiviert werden sollen. Gilt nur für bootfähige Images. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren. Features des Gastbetriebssystems für das Bootlaufwerk.

Felder
type	string Die ID einer unterstützten Funktion. Eine Liste der verfügbaren Optionen finden Sie unter Gastbetriebssystem-Funktionen aktivieren. Zulässige Werte: FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS

LocalDiskInitializeParams

Nur Eingabe. Gibt die Parameter für ein neues Laufwerk an, das zusammen mit der neuen Instanz erstellt wird. Verwenden Sie Initialisierungsparameter, um Bootlaufwerke oder lokale SSDs zu erstellen, die an die neue Laufzeit angehängt werden. Diese Property schließt die Quell-Property aus. Sie können nur eine der beiden definieren, aber nicht beide.

Felder
description	string Optional. Geben Sie diese Eigenschaft beim Erstellen des Laufwerks an.
disk_name	string Optional. Gibt den Namen des Laufwerks an. Wenn nichts angegeben ist, wird standardmäßig der Name der Instanz verwendet. Wenn das Laufwerk mit dem Instanznamen bereits in der angegebenen Zone/Region vorhanden ist, wird automatisch ein neuer Name generiert.
disk_size_gb	int64 Optional. Gibt die Größe des Laufwerks in GB (Basis 2) an. Wenn nichts angegeben ist, hat das Laufwerk dieselbe Größe wie das Image (normalerweise 10 GB). Falls die Größe angegeben wird, muss sie mindestens 10 GB betragen. Standardmäßig 100 GB.
disk_type	DiskType Nur Eingabe. Der Typ des Bootlaufwerks, das an diese Instanz angehängt ist. Der Standardwert ist ein nichtflüchtiger Standardspeicher (PD_STANDARD).
labels	map<string, string> Optional. Labels, die auf dieses Laufwerk angewendet werden sollen. Diese können später mit der Methode „disks.setLabels“ geändert werden. Dieses Feld gilt nur für persistente Laufwerke.

DiskType

Mögliche Laufwerkstypen.

Enums
DISK_TYPE_UNSPECIFIED	Der Laufwerkstyp wurde nicht festgelegt.
PD_STANDARD	Typ des nichtflüchtigen Standardspeichers.
PD_SSD	Typ des nichtflüchtiger SSD-Speicher.
PD_BALANCED	Typ des abgestimmten nichtflüchtigen Speichers.
PD_EXTREME	Typ des extrem nichtflüchtigen Speichers.

MigrateInstanceRequest

Anfrage zur Migration eines nutzerverwalteten Notebooks zu Workbench-Instanzen.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Zur Autorisierung ist mindestens eine der folgenden IAM-Berechtigungen für die angegebene Ressource name erforderlich: notebooks.instances.get notebooks.instances.create
post_startup_script_option	PostStartupScriptOption Optional. Gibt das Verhalten des Post-Startscripts während der Migration an.

PostStartupScriptOption

Gibt das Verhalten des Post-Startscripts während der Migration an.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED	Die Option für das Post-Startscript ist nicht angegeben. Der Standardwert ist POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP	Das Post-Startscript wird nicht in die neue Workbench-Instanz migriert.
POST_STARTUP_SCRIPT_OPTION_RERUN	Laden Sie das Post-Startscript noch einmal herunter und führen Sie es noch einmal aus.

MigrateInstanceResponse

Dieser Typ hat keine Felder.

Leerer Nachrichtentyp für MigrateInstance.

MigrateRuntimeRequest

Anfrage zur Migration einer Runtime zu einer Workbench-Instanz.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Zur Autorisierung ist mindestens eine der folgenden IAM-Berechtigungen für die angegebene Ressource name erforderlich: notebooks.runtimes.get notebooks.instances.create
network	string Optional. Name der VPC, in der sich die neue Instanz befindet. Dies ist erforderlich, wenn für die Laufzeit ein von Google verwaltetes Netzwerk verwendet wird. Wenn für die Laufzeit ein vom Kunden bereitgestelltes Netzwerk verwendet wird, wird dieselbe VPC wiederverwendet und dieses Feld muss leer sein. Format: projects/{project_id}/global/networks/{network_id}
subnet	string Optional. Name des Subnetzes, in dem sich die neue Instanz befindet. Dies ist erforderlich, wenn für die Laufzeit ein von Google verwaltetes Netzwerk verwendet wird. Wenn die Laufzeit ein vom Kunden bereitgestelltes Netzwerk verwendet, wird dasselbe Subnetz wiederverwendet und dieses Feld muss leer sein. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account	string Optional. Das Dienstkonto, das in die Compute Engine-Instanz der neuen Workbench-Instanz aufgenommen werden soll, wenn die Laufzeit den Modus „Nur ein Nutzer“ für die Berechtigung verwendet. Wenn nicht angegeben, wird das Compute Engine-Standarddienstkonto verwendet. Wenn die Laufzeit den Dienstkontomodus für Berechtigungen verwendet, wird dasselbe Dienstkonto wiederverwendet und dieses Feld muss leer sein.
request_id	string Optional. UUID für idempotente Anfrage.
post_startup_script_option	PostStartupScriptOption Optional. Gibt das Verhalten des Post-Startscripts während der Migration an.

PostStartupScriptOption

Gibt das Verhalten des Post-Startscripts während der Migration an.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED	Die Option für das Post-Startscript ist nicht angegeben. Der Standardwert ist POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP	Das Post-Startscript wird nicht in die neue Workbench-Instanz migriert.
POST_STARTUP_SCRIPT_OPTION_RERUN	Laden Sie das Post-Startscript noch einmal herunter und führen Sie es noch einmal aus, wie beim von Google verwalteten Notebook.

OperationMetadata

Stellt die Metadaten des Vorgangs mit langer Ausführungszeit dar.

Felder
create_time	Timestamp Der Zeitpunkt, zu dem der Vorgang erstellt wurde.
end_time	Timestamp Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.
target	string Serverdefinierter Ressourcenpfad für das Ziel des Vorgangs.
verb	string Name des vom Vorgang ausgeführten Verbs.
status_message	string Lesbarer Status des Vorgangs, falls vorhanden.
requested_cancellation	bool Gibt an, ob der Nutzer einen Abbruch angefordert hat. Vorgänge, die erfolgreich abgebrochen wurden, haben den Wert google.longrunning.Operation.error mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.
api_version	string Zum Starten des Vorgangs verwendete API-Version.
endpoint	string API-Endpunktname dieses Vorgangs.

RegisterInstanceRequest

Anfrage zum Registrieren einer Notebook-Instanz.

Felder
parent	string Erforderlich. Format: parent=projects/{project_id}/locations/{location} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent: notebooks.instances.create
instance_id	string Erforderlich. Vom Nutzer definierte eindeutige ID dieser Instanz. Der Parameter instance_id muss 1 bis 63 Zeichen lang sein und darf nur Kleinbuchstaben, numerische Zeichen und Bindestriche enthalten. Das erste Zeichen muss ein Kleinbuchstabe und das letzte Zeichen darf kein Bindestrich sein.

ReportInstanceInfoRequest

Anfrage für Notebook-Instanzen, Informationen an die Notebooks API zu senden.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
vm_id	string Erforderlich. Das VM-Hardwaretoken zur Authentifizierung der VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata	map<string, string> Die Metadaten, die an die Notebooks API gemeldet werden. Diese werden mit dem Instanzmetadatenspeicher zusammengeführt.

ReportRuntimeEventRequest

Anfrage zum Melden eines Managed Notebook-Ereignisses.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: iam.permissions.none
vm_id	string Erforderlich. Das VM-Hardwaretoken zur Authentifizierung der VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event	Event Erforderlich. Das zu meldende Ereignis.

ReservationAffinity

Reservierungsaffinität für die Nutzung einer zonalen Reservierung.

Felder
consume_reservation_type	Type Optional. Art der zu nutzenden Reservierung
key	string Optional. Entspricht dem Labelschlüssel der Reservierungsressource.
values[]	string Optional. Entspricht den Labelwerten der Reservierungsressource.

Typ

Gibt an, ob Kapazität aus einer Reservierung genutzt werden soll.

Enums
TYPE_UNSPECIFIED	Standardtyp.
NO_RESERVATION	Es wird keine zugewiesene Kapazität genutzt.
ANY_RESERVATION	Jede verfügbare Reservierung nutzen.
SPECIFIC_RESERVATION	Die Nutzung muss aus einer bestimmten Reservierung erfolgen. Sie müssen Schlüsselwertfelder angeben, um die Reservierungen festzulegen.

ResetInstanceRequest

Zurücksetzung einer Notebook-Instanz anfordern

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.reset

ResetRuntimeRequest

Anfrage zum Zurücksetzen einer Laufzeit für verwaltete Notebooks.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.runtimes.reset
request_id	string UUID für idempotente Anfrage.

RollbackInstanceRequest

Rollback für eine Notebookinstanz anfordern

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: iam.permissions.none
target_snapshot	string Erforderlich. Der Snapshot für den Rollback. Beispiel: projects/test-project/global/snapshots/krwlzipynril.

Laufzeit

Die Definition einer Laufzeit für eine verwaltete Notebook-Instanz.

Felder
name	string Nur Ausgabe. Der Ressourcenname der Laufzeit. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}
state	State Nur Ausgabe. Laufzeitstatus.
health_state	HealthState Nur Ausgabe. Laufzeit-health_state.
access_config	RuntimeAccessConfig Die Konfigurationseinstellungen für den Zugriff auf die Laufzeit.
software_config	RuntimeSoftwareConfig Die Konfigurationseinstellungen für Software in der Laufzeit.
metrics	RuntimeMetrics Nur Ausgabe. Enthält Messwerte für den Laufzeit-Daemon, z. B. den Dienststatus und JupyterLab-Statistiken.
create_time	Timestamp Nur Ausgabe. Erstellungszeit der Laufzeit.
update_time	Timestamp Nur Ausgabe. Zeitpunkt der Laufzeitaktualisierung.
labels	map<string, string> Optional. Die Labels, die diesem verwalteten Notebook oder dieser Laufzeit zugeordnet werden sollen. Label-Schlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte dürfen leer sein. Wenn sie vorhanden sind, müssen sie jedoch 1 bis 63 Zeichen enthalten und RFC 1035 entsprechen. Einem Cluster können maximal 32 Labels zugeordnet werden.
runtime_migration_eligibility	RuntimeMigrationEligibility Nur Ausgabe. Prüft, wie machbar eine Migration von GmN zu WbI ist.
Union-Feld runtime_type. Typ der Laufzeitumgebung. Derzeit wird nur Compute Engine-VM unterstützt. Für runtime_type ist nur einer der folgenden Werte zulässig:
virtual_machine	VirtualMachine Verwenden Sie ein Compute Engine-VM-Image, um die verwaltete Notebook-Instanz zu starten.
migrated	bool Nur Ausgabe. Boolescher Wert, der angibt, ob dieses Notebook zu einer Workbench-Instanz migriert wurde.

HealthState

Der Laufzeit-Unterstatus.

Enums
HEALTH_STATE_UNSPECIFIED	Der Laufzeit-Unterstatus ist unbekannt.
HEALTHY	Die Laufzeit befindet sich in einem fehlerfreien Zustand (z. B. werden kritische Daemons ausgeführt). Gilt für den Status „ACTIVE“.
UNHEALTHY	Die Laufzeit befindet sich bekanntermaßen in einem fehlerhaften Zustand (z. B. werden kritische Daemons nicht ausgeführt). Gilt für den Status „AKTIV“.
AGENT_NOT_INSTALLED	Der Health Monitoring-Agent wurde nicht in der Laufzeit installiert. Gilt für den Status AKTIV.
AGENT_NOT_RUNNING	Der Agent für die Laufzeit-Statusüberwachung wird nicht ausgeführt. Gilt für den Status AKTIV.

Bundesland

Die Definition der Zustände dieser Laufzeit.

Enums
STATE_UNSPECIFIED	Der Status ist nicht angegeben.
STARTING	Die Compute-Ebene startet die Laufzeit. Sie ist noch nicht einsatzbereit.
PROVISIONING	Auf der Compute-Ebene werden die erforderlichen Frameworks installiert und die Laufzeit beim Notebook-Proxy registriert. Sie kann nicht verwendet werden.
ACTIVE	Die Laufzeit wird gerade ausgeführt. Sie ist einsatzbereit.
STOPPING	Die Steuerungslogik beendet die Laufzeit. Sie kann nicht verwendet werden.
STOPPED	Die Laufzeit wird beendet. Sie kann nicht verwendet werden.
DELETING	Die Laufzeit wird gelöscht. Sie kann nicht verwendet werden.
UPGRADING	Die Laufzeit wird aktualisiert. Sie kann nicht verwendet werden.
INITIALIZING	Die Laufzeit wird erstellt und eingerichtet. Sie ist noch nicht einsatzbereit.

RuntimeAcceleratorConfig

Definition der Arten von Hardwarebeschleunigern, die verwendet werden können. Weitere Informationen finden Sie unter Compute Engine-Beschleunigertypen. Beispiele:

• nvidia-tesla-k80
• nvidia-tesla-p100
• nvidia-tesla-v100
• nvidia-tesla-p4
• nvidia-tesla-t4
• nvidia-tesla-a100

Felder
type	AcceleratorType Beschleunigermodell.
core_count	int64 Anzahl der Kerne dieses Beschleunigers.

AcceleratorType

Typ dieses Beschleunigers.

Enums
ACCELERATOR_TYPE_UNSPECIFIED	Der Beschleunigertyp ist nicht angegeben.
NVIDIA_TESLA_K80	Der Beschleunigertyp ist Nvidia Tesla K80. Dieses Element wird nicht mehr unterstützt.
NVIDIA_TESLA_P100	Der Beschleunigertyp ist Nvidia Tesla P100.
NVIDIA_TESLA_V100	Der Beschleunigertyp ist Nvidia Tesla V100.
NVIDIA_TESLA_P4	Der Beschleunigertyp ist Nvidia Tesla P4.
NVIDIA_TESLA_T4	Der Beschleunigertyp ist Nvidia Tesla T4.
NVIDIA_TESLA_A100	Der Beschleunigertyp ist „Nvidia Tesla A100 – 40 GB“.
NVIDIA_L4	Der Beschleunigertyp ist Nvidia L4.
TPU_V2	(Demnächst verfügbar) Der Beschleunigertyp ist TPU V2.
TPU_V3	(Demnächst verfügbar) Der Beschleunigertyp ist TPU V3.
NVIDIA_TESLA_T4_VWS	Der Beschleunigertyp ist NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS	Der Beschleunigertyp ist NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS	Der Beschleunigertyp ist NVIDIA Tesla P4 Virtual Workstations.

RuntimeAccessConfig

Gibt die Anmeldekonfiguration für Runtime an.

Felder
access_type	RuntimeAccessType Der Zugriffstyp dieser Instanz.
runtime_owner	string Der Eigentümer dieser Laufzeit nach der Erstellung. Format: [e-mail] Derzeit wird nur ein Inhaber unterstützt.
proxy_uri	string Nur Ausgabe. Der Proxy-Endpunkt, der für den Zugriff auf die Laufzeit verwendet wird.

RuntimeAccessType

Mögliche Arten des Zugriffs auf die Laufzeit. Authentifizierungsmodus. Derzeit wird nur der Einzelnutzermodus unterstützt.

Enums
RUNTIME_ACCESS_TYPE_UNSPECIFIED	Nicht angegebener Zugriff.
SINGLE_USER	Einzelnutzeranmeldung
SERVICE_ACCOUNT	Dienstkontomodus. Im Dienstkontomodus gibt der Laufzeit-Ersteller ein Dienstkonto an, das im Nutzerprojekt vorhanden ist. Feld „Laufzeitdienstkonto“ verwenden. Nutzer, die auf die Laufzeit zugreifen, benötigen die Berechtigung „ActAs“ (Service Account User).

RuntimeMetrics

Enthält Laufzeit-Daemon-Messwerte wie Statistiken zu Betriebssystem, Kernel und Sitzungen.

Felder
system_metrics	map<string, string> Nur Ausgabe. Die Systemmesswerte.

RuntimeMigrationEligibility

RuntimeMigrationEligibility stellt die Machbarkeitsinformationen für eine Migration von GmN zu WbI dar.

Felder
warnings[]	Warning Nur Ausgabe. Bestimmte Konfigurationen werden während der Migration auf die Standardeinstellungen zurückgesetzt.
errors[]	Error Nur Ausgabe. Bei bestimmten Konfigurationen ist eine automatische Migration nicht möglich. Eine manuelle Migration ist erforderlich.

Fehler

Eine Migrationsfehlermeldung bedeutet, dass bestimmte Konfigurationen die automatische Migration von Google My Business verhindern. Eine manuelle Migration ist erforderlich.

Enums
ERROR_UNSPECIFIED	Standardtyp.
CUSTOM_CONTAINER	Das GmN ist mit benutzerdefinierten Containern konfiguriert und kann nicht migriert werden.

Warnung

Eine Migrationswarnung bedeutet, dass bestimmte Konfigurationen während der Migration auf die Standardeinstellungen zurückgesetzt werden.

Enums
WARNING_UNSPECIFIED	Standardtyp.
UNSUPPORTED_ACCELERATOR_TYPE	Für das GmN wird ein Beschleunigertyp verwendet, der in WbI nicht unterstützt wird. Es wird ohne Beschleuniger migriert. Nutzer können einen Beschleuniger nach der Migration anhängen.
UNSUPPORTED_OS	Die GmN verwendet ein Betriebssystem, das in WbI nicht unterstützt wird (z.B. Debian 10). Es wird in WbI durch Debian 11 ersetzt.
RESERVED_IP_RANGE	Dieses GmN ist mit einem reservierten IP-Bereich konfiguriert, der in WbI nicht mehr gilt.
GOOGLE_MANAGED_NETWORK	Dieses GmN ist mit einem von Google verwalteten Netzwerk konfiguriert. Gib die Optionen network und subnet für die Migration an.
POST_STARTUP_SCRIPT	Für diesen GmN ist ein Post-Startscript konfiguriert. Geben Sie optional die post_startup_script_option für die Migration an.
SINGLE_USER	Dieses GmN ist für den Einzelnutzermodus konfiguriert. Geben Sie optional die Option service_account für die Migration an.

RuntimeShieldedInstanceConfig

Eine Reihe von Optionen für abgeschirmte Instanzen. Weitere Informationen finden Sie unter Images mit unterstützten Shielded VM-Funktionen. Nicht alle Kombinationen sind gültig.

Felder
enable_secure_boot	bool Gibt an, ob für die Instanz Secure Boot aktiviert ist. Secure Boot sorgt dafür, dass das System nur authentische Software ausführt. Dazu wird die digitale Signatur aller Bootkomponenten überprüft und der Bootvorgang angehalten, wenn die Signaturüberprüfung fehlschlägt. Standardmäßig deaktiviert.
enable_vtpm	bool Definiert, ob vTPM für die Instanz aktiviert ist. Standardmäßig aktiviert.
enable_integrity_monitoring	bool Gibt an, ob für die Instanz das Integritätsmonitoring aktiviert ist. Ermöglicht das Monitoring und die Attestierung der Bootintegrität der Instanz. Die Attestierung erfolgt anhand der Referenz der Integritätsrichtlinie. Diese Referenz wird bei der Erstellung der Instanz vom Boot-Image abgeleitet, dem implizit vertraut wird. Standardmäßig aktiviert.

RuntimeSoftwareConfig

Gibt die Auswahl und Konfiguration von Software in der Laufzeit an. Die Attribute, die zur Laufzeit festgelegt werden sollen. Eigenschaftsschlüssel werden im Format key:value angegeben, z. B.:

• idle_shutdown: true
• idle_shutdown_timeout: 180
• enable_health_monitoring: true

Felder
notebook_upgrade_schedule	string Cron-Ausdruck in der UTC-Zeitzone, der zum Planen des automatischen Upgrades von Instanzen verwendet wird. Halten Sie sich bitte an das cron-Format.
idle_shutdown_timeout	int32 Zeit in Minuten, die vor dem Herunterfahren der Laufzeit gewartet werden soll. Standard: 180 Minuten
install_gpu_driver	bool Nvidia-Treiber automatisch installieren. Standardwert: True
custom_gpu_driver_path	string Geben Sie einen benutzerdefinierten Cloud Storage-Pfad an, in dem der GPU-Treiber gespeichert ist. Wenn nichts angegeben ist, wählen wir automatisch aus offiziellen GPU-Treibern aus.
post_startup_script	string Pfad zu einem Bash-Script, das automatisch ausgeführt wird, nachdem eine Notebook-Instanz vollständig hochgefahren wurde. Der Pfad muss eine URL oder ein Cloud Storage-Pfad (gs://path-to-file/file-name) sein.
kernels[]	ContainerImage Optional. Verwenden Sie eine Liste von Container-Images, die als Kernel in der Notebook-Instanz verwendet werden sollen.
post_startup_script_behavior	PostStartupScriptBehavior Verhalten für das Post-Startscript.
enable_health_monitoring	bool Prüft, ob die wichtigsten internen Dienste ausgeführt werden. Standardwert: True
idle_shutdown	bool Die Laufzeit wird nach idle_shutdown_time automatisch beendet. Standardwert: True
upgradeable	bool Nur Ausgabe. Bool-Wert, der angibt, ob in einer Image-Familie ein neueres Image verfügbar ist.
disable_terminal	bool Boolescher Wert, der angibt, ob das JupyterLab-Terminal verfügbar ist. Standardwert: False
version	string Nur die Ausgabevariante des Boot-Images, z. B. M100, aus dem Release-Label des Images.
mixer_disabled	bool Boolescher Wert, der angibt, ob der Mixer-Client deaktiviert werden soll. Standardwert: False

PostStartupScriptBehavior

Verhalten für das Post-Startscript.

Enums
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten des Post-Startscripts. Wird nur einmal bei der Erstellung ausgeführt.
RUN_EVERY_START	Führt bei jedem Start das bei der Erstellung angegebene Post-Startscript aus.
DOWNLOAD_AND_RUN_EVERY_START	Lädt das bereitgestellte Post-Startscript bei jedem Start herunter und führt es aus.

Zeitplan

Die Definition eines Zeitplans.

Felder
name	string Nur Ausgabe. Der Name dieses Zeitplans. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name	string Nur Ausgabe. Anzeigename für die Benutzeroberfläche. Der Name darf nur alphanumerische Zeichen, Bindestriche - und Unterstriche _ enthalten.
description	string Eine kurze Beschreibung dieser Umgebung.
state	State
cron_schedule	string Zeitplan im Crontab-Format, nach dem der Job ausgeführt wird. Format: Minute, Stunde, Tag des Monats, Monat, Wochentag, z. B. 0 0 * * WED = jeden Mittwoch. Weitere Beispiele: https://crontab.guru/examples.html
time_zone	string Zeitzone für den cron_schedule. Der Wert dieses Felds muss ein Zeitzonenname aus der tz-Datenbank sein. Zeitzonendatenbank: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Beachten Sie, dass einige Zeitzonen die Sommerzeit berücksichtigen. Die Regeln für die Sommerzeit richten sich nach der ausgewählten Zeitzone. Verwenden Sie für UTC den String „utc“. Wenn keine Zeitzone angegeben ist, wird standardmäßig UTC (auch als GMT bezeichnet) verwendet.
create_time	Timestamp Nur Ausgabe. Die Uhrzeit, zu der der Zeitplan erstellt wurde.
update_time	Timestamp Nur Ausgabe. Zeitpunkt der letzten Aktualisierung des Zeitplans.
execution_template	ExecutionTemplate Notebook-Ausführungsvorlage, die diesem Zeitplan entspricht.
recent_executions[]	Execution Nur Ausgabe. Die Namen der letzten Ausführungen, die durch diesen Zeitplan ausgelöst wurden, und die entsprechenden Status.

Bundesland

Status des Jobs.

Enums
STATE_UNSPECIFIED	Nicht angegebener Zustand.
ENABLED	Der Job wird normal ausgeführt.
PAUSED	Der Job wurde vom Nutzer pausiert. Sie wird nicht ausgeführt. Ein Nutzer kann den Job mit Cloud Scheduler absichtlich pausieren.
DISABLED	Der Job wurde aufgrund eines Fehlers vom System deaktiviert. Der Nutzer kann einen Job nicht direkt deaktivieren.
UPDATE_FAILED	Der Jobstatus, der sich aus einem fehlgeschlagenen CloudScheduler.UpdateJob-Vorgang ergibt. Zum Wiederherstellen eines Jobs aus diesem Status wiederholen Sie CloudScheduler.UpdateJob, bis eine erfolgreiche Antwort empfangen wird.
INITIALIZING	Die Zeitplanressource wird erstellt.
DELETING	Die Zeitplanressource wird gelöscht.

SetInstanceAcceleratorRequest

Anfrage zum Festlegen des Instanzbeschleunigers.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.setAccelerator
type	AcceleratorType Erforderlich. Typ dieses Beschleunigers.
core_count	int64 Erforderlich. Anzahl der Kerne dieses Beschleunigers. Nicht alle Kombinationen von type und core_count sind gültig. Eine gültige Kombination finden Sie unter GPUs in Compute Engine. TPUs werden nicht unterstützt.

SetInstanceLabelsRequest

Anfrage zum Festlegen von Instanzlabels.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.setLabels
labels	map<string, string> Labels, die auf diese Instanz angewendet werden sollen. Diese können später mit der Methode „setLabels“ geändert werden.

SetInstanceMachineTypeRequest

Anfrage zum Festlegen des Maschinentyps für eine Instanz.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.setMachineType
machine_type	string Erforderlich. Der Compute Engine-Maschinentyp.

StartInstanceRequest

Anfrage zum Starten einer Notebookinstanz

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.start

StartRuntimeRequest

Anfrage zum Starten einer Managed Notebook-Laufzeit.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.runtimes.start
request_id	string UUID für idempotente Anfrage.

StopInstanceRequest

Anfrage zum Beenden einer Notebookinstanz

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.stop

StopRuntimeRequest

Anfrage zum Beenden einer Managed Notebook-Laufzeit.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.runtimes.stop
request_id	string UUID für idempotente Anfrage.

SwitchRuntimeRequest

Anfrage zum Wechseln einer Managed Notebook-Laufzeit.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.runtimes.switch
machine_type	string Maschinentyp.
accelerator_config	RuntimeAcceleratorConfig Beschleunigerkonfiguration.
request_id	string UUID für idempotente Anfrage.

UpdateInstanceConfigRequest

Anfrage zum Aktualisieren von Instanzkonfigurationen.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.updateConfig
config	InstanceConfig Die zu aktualisierenden Instanzkonfigurationen.

UpdateInstanceMetadataItemsRequest

Anfrage zum Hinzufügen oder Ändern von Metadatenelementen für eine Instanz.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.updateConfig
items	map<string, string> Metadatenelemente, die für die Instanz hinzugefügt oder aktualisiert werden sollen.

UpdateInstanceMetadataItemsResponse

Antwort für das Hinzufügen/Ändern von Metadatenelementen für eine Instanz.

Felder
items	map<string, string> Eine Karte der Elemente, die den Metadaten hinzugefügt oder in den Metadaten aktualisiert wurden.

UpdateRuntimeRequest

Anfrage zum Aktualisieren einer Konfiguration für verwaltete Notebooks.

Felder
runtime	Runtime Erforderlich. Die zu aktualisierende Laufzeit. Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource runtime: notebooks.runtimes.update
update_mask	FieldMask Erforderlich. Gibt den Pfad des zu aktualisierenden Felds im Verhältnis zu Runtime an. Zum Ändern der Softwarekonfigurations-Kernels wird beispielsweise der Parameter update_mask als software_config.kernels und der PATCH-Anfragetext so angegeben: { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Derzeit können nur die folgenden Felder aktualisiert werden: 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 labels
request_id	string UUID für idempotente Anfrage.

UpdateShieldedInstanceConfigRequest

Anfrage zum Aktualisieren der Konfiguration der abgeschirmten Instanz für eine Notebook-Instanz. Sie können diese Methode nur für eine angehaltene Instanz verwenden.

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.updateShieldInstanceConfig
shielded_instance_config	ShieldedInstanceConfig Die Konfiguration der abgeschirmten Instanz, die aktualisiert werden soll.

UpgradeInstanceRequest

Anfrage zum Aktualisieren einer Notebook-Instanz

Felder
name	string Erforderlich. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource name: notebooks.instances.upgrade
type	UpgradeType Optional. Der optionale UpgradeType. Wenn Sie dieses Feld festlegen, wird nach zusätzlichen Compute-Images gesucht, um ein Upgrade für diese Instanz durchzuführen.

UpgradeType

Definition der Arten von Upgrades, die für diese Instanz verwendet werden können.

Enums
UPGRADE_TYPE_UNSPECIFIED	Der Upgradetyp ist nicht angegeben.
UPGRADE_FRAMEWORK	ML-Framework aktualisieren.
UPGRADE_OS	Aktualisieren Sie das Betriebssystem.
UPGRADE_CUDA	CUDA aktualisieren
UPGRADE_ALL	„Upgrade All“ (Betriebssystem, Framework und CUDA)

VirtualMachine

Laufzeit mit virtueller Maschine für die Berechnung.

Felder
instance_name	string Nur Ausgabe. Der nutzerfreundliche Name der verwalteten Compute Engine-Instanz.
instance_id	string Nur Ausgabe. Die eindeutige Kennung der verwalteten Compute Engine-Instanz.
virtual_machine_config	VirtualMachineConfig Konfigurationseinstellungen für virtuelle Maschinen.

VirtualMachineConfig

Die Konfigurationseinstellungen für die virtuelle Maschine.

Felder
zone	string Nur Ausgabe. Die Zone, in der sich die virtuelle Maschine befindet. Wenn Sie eine regionale Anfrage verwenden, wählt der Notebooks-Dienst einen Standort in der entsprechenden Laufzeitregion aus. Bei einer GET-Anfrage ist die Zone immer vorhanden. Beispiel: * us-central1-b
machine_type	string Erforderlich. Der für Runtimes verwendete Compute Engine-Maschinentyp. Der Kurzname ist gültig. Beispiele: * n1-standard-2 * e2-standard-8
container_images[]	ContainerImage Optional. Verwenden Sie eine Liste von Container-Images, die als Kernel in der Notebook-Instanz verwendet werden sollen.
data_disk	LocalDisk Erforderlich. Konfigurationseinstellungen für die Option „Datenlaufwerk“.
encryption_config	EncryptionConfig Optional. Verschlüsselungseinstellungen für die Datenträger der virtuellen Maschine.
shielded_instance_config	RuntimeShieldedInstanceConfig Optional. Konfigurationseinstellungen für Shielded VM-Instanzen.
accelerator_config	RuntimeAcceleratorConfig Optional. Die Compute Engine-Beschleunigerkonfiguration für diese Laufzeit.
network	string Optional. Das Compute Engine-Netzwerk, das für die Maschinenkommunikation verwendet werden soll. Kann nicht mit einem Subnetzwerk angegeben werden. Wenn weder network noch subnet angegeben ist, wird das Standardnetzwerk des Projekts verwendet, sofern es vorhanden ist. Eine vollständige URL oder ein partieller URI. Beispiele: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default Laufzeiten sind verwaltete Ressourcen in der Google-Infrastruktur. Laufzeiten unterstützen die folgenden Netzwerkkonfigurationen: Von Google verwaltetes Netzwerk (Netzwerk und Subnetz sind leer) VPC des Nutzerprojekts (Netzwerk und Subnetz sind erforderlich). Erfordert die Konfiguration des Zugriffs auf private Dienste. Freigegebene VPC (Netzwerk und Subnetz sind erforderlich). Erfordert die Konfiguration des Zugriffs auf private Dienste.
subnet	string Optional. Das Compute Engine-Subnetzwerk, das für die Maschinenkommunikation verwendet werden soll. Kann nicht mit „network“ angegeben werden. Eine vollständige URL oder ein teilweiser URI sind gültig. Beispiele: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0
internal_ip_only	bool Optional. Wenn „true“, hat die Laufzeit nur interne IP-Adressen. Standardmäßig sind Runtimes nicht auf interne IP-Adressen beschränkt und jeder VM werden sitzungsspezifische externe IP-Adressen zugewiesen. Diese internal_ip_only-Einschränkung kann nur für Netzwerke mit aktivierten Subnetzwerken aktiviert werden. Alle Abhängigkeiten müssen so konfiguriert sein, dass sie ohne externe IP-Adressen zugänglich sind.
tags[]	string Optional. Die Compute Engine-Netzwerktags, die der Laufzeit hinzugefügt werden sollen (siehe Netzwerktags konfigurieren).
guest_attributes	map<string, string> Nur Ausgabe. Die Compute Engine-Gastattribute. Weitere Informationen finden Sie unter Gastattribute für Projekte und Instanzen.
metadata	map<string, string> Optional. Die Compute Engine-Metadateneinträge, die der virtuellen Maschine hinzugefügt werden sollen. Weitere Informationen finden Sie unter Metadaten für Projekte und Instanzen.
labels	map<string, string> Optional. Die Labels, die dieser Laufzeit zugeordnet werden sollen. Label-Schlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte dürfen leer sein. Wenn sie vorhanden sind, müssen sie jedoch 1 bis 63 Zeichen enthalten und RFC 1035 entsprechen. Einem Cluster können maximal 32 Labels zugeordnet werden.
nic_type	NicType Optional. Der Typ der vNIC, die auf dieser Schnittstelle verwendet werden soll. Das kann gVNIC oder VirtioNet sein.
reserved_ip_range	string Optional. Der Name des reservierten IP-Bereichs wird für VPC-Peering verwendet. Wenn der Bereich name zugewiesen ist, wird er bei der Zuordnung des Subnetzwerks verwendet. Beispiel: 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 Feldwert: managed-notebooks-range-c
boot_image	BootImage Optional. Boot-Image-Metadaten, die für die Laufzeit-Upgradefähigkeit verwendet werden.

BootImage

Dieser Typ hat keine Felder.

Definition des vom Laufzeit-Image verwendeten Boot-Images. Wird verwendet, um Laufzeitupgrades zu ermöglichen.

NicType

Der Typ des vNIC-Treibers. Der Standardwert sollte UNSPECIFIED_NIC_TYPE sein.

Enums
UNSPECIFIED_NIC_TYPE	Kein Typ angegeben
VIRTIO_NET	VIRTIO
GVNIC	GVNIC

VmImage

Definition eines benutzerdefinierten Compute Engine-Images für virtuelle Maschinen zum Starten einer Notebook-Instanz, auf der die Umgebung direkt auf der VM installiert ist.

Felder
project	string Erforderlich. Der Name des Google Cloud-Projekts, zu dem dieses VM-Image gehört. Format: {project_id}
Union-Feld image. Der Verweis auf ein externes Compute Engine-VM-Image. Für image ist nur einer der folgenden Werte zulässig:
image_name	string Suchen Sie anhand des VM-Image-Namens nach dem Image.
image_family	string Verwenden Sie diese VM-Image-Familie, um das Image zu finden. Das neueste Image in dieser Familie wird verwendet.