Package google.cloud.notebooks.v2

AcceleratorType

Optional. Typ dieses Beschleunigers.

int64

Optional. Anzahl der Kerne dieses Beschleunigers.

string

Optional. Externe IP-Adresse, die mit dieser Instanz verknüpft ist. Geben Sie eine nicht verwendete statische externe IP-Adresse an, die für das Projekt verfügbar ist, oder lassen Sie dieses Feld undefiniert, um eine IP-Adresse aus einem freigegebenen Pool mit sitzungsspezifischen IP-Adressen zu verwenden. Wenn Sie eine statische externe IP-Adresse angeben, muss sie sich in derselben Region wie die Zone der Instanz befinden.

int64

Optional. Die Größe des Bootlaufwerks in GB, das an diese Instanz angehängt ist, bis zu einem Maximum von 64.000 GB (64 TB). Wenn keine Angabe erfolgt, wird standardmäßig der empfohlene Wert von 150 GB verwendet.

DiskType

Optional. Gibt den Typ des Laufwerks an.

DiskEncryption

Optional. Die auf den Boot- und Datenlaufwerken verwendete Laufwerkverschlüsselungsmethode. Der Standardwert ist GMEK.

string

Optional. 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

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

bool

Ob eine Instanz aktualisiert werden kann.

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.

string

Zusätzliche Informationen zum Upgrade.

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.

ConfidentialInstanceType

Optional. Definiert den Typ der von der vertraulichen Instanz verwendeten Technologie.

DefaultValues

Nur Ausgabe. Die Standardwerte für die Konfiguration.

SupportedValues

Nur Ausgabe. Die unterstützten Werte für die Konfiguration.

ImageRelease

Nur Ausgabe. Die Liste der verfügbaren Bilder zum Erstellen eines Web-Bild-Index.

bool

Nur Ausgabe. Flag zum Deaktivieren der Erstellung von Legacy-Workbench-Notebooks (nutzerverwaltete Notebooks und von Google verwaltete Notebooks).

string

Erforderlich. Der Pfad zum Container-Image-Repository. Beispiel: gcr.io/{project_id}/{image_name}

string

Optional. Das Tag des Container-Images. Wenn nichts angegeben ist, wird standardmäßig das neueste Tag verwendet.

string

Erforderlich. Format: parent=projects/{project_id}/locations/{location}

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent:

• notebooks.instances.create

string

Erforderlich. Die benutzerdefinierte eindeutige ID dieser Instanz.

Instance

Erforderlich. Die zu erstellende Instanz.

string

Optional. UUID für idempotente Anfragen.

int64

Optional. Die Größe des Laufwerks in GB, das an diese VM-Instanz angehängt ist, bis zu einem Maximum von 64.000 GB (64 TB). Wenn keine Angabe erfolgt, wird standardmäßig 100 verwendet.

DiskType

Optional. Gibt den Typ des Laufwerks an.

DiskEncryption

Optional. Die auf den Boot- und Datenlaufwerken verwendete Laufwerkverschlüsselungsmethode. Der Standardwert ist GMEK.

string

Optional. 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

string

Optional. Die auf das Datenlaufwerk anzuwendenden Ressourcenrichtlinien.

string

Nur Ausgabe. Der Standardmaschinentyp, der vom Backend verwendet wird, wenn er nicht vom Nutzer angegeben wird.

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

string

Optional. UUID für idempotente Anfragen.

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.diagnose

DiagnosticConfig

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

int32

Optional. Maximale Zeit in Minuten, bevor für den Vorgang ein Zeitlimit überschritten wird.

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 erteilt werden, das an die VM angehängt ist. Google Managed Notebooks: - storage.buckets.writer: Muss dem Dienstkonto des Projekts oder den an die VM angehängten Nutzeranmeldedaten zugewiesen werden, je nach Authentifizierungsmodus.

Cloud Storage-Bucket, in den die Logdatei geschrieben wird: gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz

string

Optional. Definiert den relativen Speicherpfad im Cloud Storage-Bucket, in den die Diagnoselogbücher 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/

bool

Optional. Aktiviert das Flag zum Reparieren des Dienstes für die Instanz.

bool

Optional. Aktiviert das Flag, um 30 Sekunden lang Pakete von der Instanz zu erfassen.

bool

Optional. Ermöglicht das Kopieren aller Inhalte des Ordners /home/jupyter

bool

Optional. Gibt an, ob der Endnutzer Google Cloud autorisiert, den GPU-Treiber auf dieser VM-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.

string

Optional. 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.

string

Optional. Der Maschinentyp der VM-Instanz. https://cloud.google.com/compute/docs/machine-resource

string

Optional. Die Mindest-CPU-Plattform, die für diese Instanz verwendet werden soll. Die Liste der gültigen Werte finden Sie unter https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones.

AcceleratorConfig

Optional. Die auf dieser Instanz verwendeten Hardwarebeschleuniger. Wenn Sie Beschleuniger verwenden, muss Ihre Konfiguration genügend vCPUs und Arbeitsspeicher für die ausgewählte machine_type haben. Derzeit wird nur eine Accelerator-Konfiguration unterstützt.

ServiceAccount

Optional. Das Dienstkonto, das als Identität für die VM-Instanz dient. Derzeit wird nur ein Dienstkonto unterstützt.

BootDisk

Optional. Das Bootlaufwerk für die VM.

DataDisk

Optional. Datenlaufwerke, die an die VM-Instanz angehängt sind. Derzeit wird nur eine Datenfestplatte unterstützt.

ShieldedInstanceConfig

Optional. Shielded VM-Konfiguration. Images, die unterstützte Shielded VM-Funktionen verwenden.

NetworkInterface

Optional. Die Netzwerkschnittstellen für die VM. Es wird nur eine Schnittstelle unterstützt.

bool

Optional. Wenn „true“, wird dieser VM-Instanz keine externe IP-Adresse zugewiesen.

string

Optional. Die Compute Engine-Netzwerk-Tags, die der Laufzeit hinzugefügt werden sollen (siehe Netzwerk-Tags hinzufügen).

map<string, string>

Optional. Benutzerdefinierte Metadaten, die auf diese Instanz angewendet werden sollen.

map<string, string>

Nur Ausgabe. Stellt die vom System verwalteten Metadaten für diese Instanz dar: die Teilmenge von metadata, deren Schlüssel als Workbench-Systemschlüssel erkannt werden.

bool

Optional. Flag zum Aktivieren oder Deaktivieren der IP-Weiterleitung. Standardmäßig ist „false“/„off“ festgelegt. https://cloud.google.com/vpc/docs/using-routes#canipforward

GPUDriverConfig

Optional. Konfiguration für GPU-Treiber.

ConfidentialInstanceConfig

Optional. Konfiguration vertraulicher Instanzen.

string

Nur Ausgabe. Die eindeutige ID der Compute Engine-Instanzressource.

VmImage

Optional. Verwenden Sie ein Compute Engine-VM-Image, um die Notebook-Instanz zu starten.

ContainerImage

Optional. Verwenden Sie ein Container-Image, um die Notebook-Instanz zu starten.

string

Erforderlich. Format: projects/{project_id}/locations/{location}

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

string

Nur Ausgabe. Der Name des Image im Format workbench-instances-vYYYYmmdd--

string

Nur Ausgabe. Die Veröffentlichung des Bildes des Formulars m123

string

Nur Ausgabe. Die Image-Familie des Bildes. (z. B. workbench-instances oder workbench-2603)

string

Nur Ausgabe. Die Beschreibung des Bildes.

string

Nur Ausgabe. ID. Der Name dieser Notebook-Instanz. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

string

Nur Ausgabe. Der Proxy-Endpunkt, der für den Zugriff auf das Jupyter-Notebook verwendet wird.

string

Optional. Der Eigentümer dieser Instanz nach der Erstellung. Format: alias@example.com

Derzeit wird nur ein Inhaber unterstützt. Wenn nicht angegeben, können alle Dienstkontonutzer des Dienstkontos Ihrer VM-Instanz die Instanz verwenden.

string

Nur Ausgabe. E-Mail-Adresse der Organisation, die die ursprüngliche CreateInstance-Anfrage gesendet hat.

State

Nur Ausgabe. Der Status dieser Instanz.

UpgradeHistoryEntry

Nur Ausgabe. Der Upgradeverlauf dieser Instanz.

string

Nur Ausgabe. Eindeutige ID der Ressource.

HealthState

Nur Ausgabe. health_state der Instanz.

map<string, string>

Nur Ausgabe. Zusätzliche Informationen zum Instanzstatus. Beispiel:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}

Timestamp

Nur Ausgabe. Erstellungszeitpunkt der Instanz.

Timestamp

Nur Ausgabe. Uhrzeit der Instanzaktualisierung.

bool

Optional. Wenn „true“, wird die Notebook-Instanz nicht beim Proxy registriert.

map<string, string>

Optional. Labels, die auf diese Instanz angewendet werden sollen. Diese können später mit der Methode „UpdateInstance“ geändert werden.

string

Nur Ausgabe. Der Proxy-Endpunkt für Workforce-Pools, der für den Zugriff auf das Jupyter-Notebook verwendet wird.

bool

Nur Ausgabe. Reserviert für die zukünftige Verwendung für die Zonentrennung.

bool

Nur Ausgabe. Reserviert für die zukünftige Verwendung für die Zonenisolierung.

bool

Optional. Flag, das angibt, dass auf ein Notebook mit einem externen Identitätsanbieter zugegriffen werden kann.

bool

Optional. Flag zum Aktivieren verwalteter Anmeldedaten von Endnutzern für die Instanz.

bool

Optional. Wenn „true“, wird der Löschschutz für diese Workbench-Instanz aktiviert. Wenn „false“ festgelegt ist, wird der Löschschutz für diese Workbench-Instanz deaktiviert.

GceSetup

Optional. Compute Engine-Einrichtung für das Notebook. Verwendet im Notebook definierte Felder.

string

Erforderlich. Das übergeordnete Element der Instanz. Format: - projects/{project_id}/locations/{location}, um Instanzen in einer bestimmten Zone aufzulisten. – projects/{project_id}/locations/-, um Instanzen an allen Standorten aufzulisten.

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource parent:

• notebooks.instances.list

int32

Optional. Maximale Rückgabegröße des Listenaufrufs.

string

Optional. Ein zuvor zurückgegebenes Seitentoken, das verwendet werden kann, um die Auflistung ab dem letzten Ergebnis fortzusetzen.

string

Optional. Ergebnisse sortieren. Unterstützte Werte sind "name", "name desc" oder "" (nicht sortiert).

string

Optional. Listenfilter.

Instance

Eine Liste der zurückgegebenen Instanzen.

string

Seitentoken, das verwendet werden kann, um die Auflistung im nächsten Listenaufruf ab dem letzten Ergebnis fortzusetzen.

string

Unsortierte Liste. Standorte, die nicht erreicht werden konnten. Beispiel: ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. Eine ListInstancesResponse enthält entweder Instanzen oder nicht erreichbare Elemente.

string

Optional. Der Name der VPC, in der sich diese VM-Instanz befindet. Format: projects/{project_id}/global/networks/{network_id}

string

Optional. Der Name des Subnetzes, in dem sich diese VM-Instanz befindet. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

NicType

Optional. Der Typ der vNIC, die auf dieser Schnittstelle verwendet werden soll. Das kann gVNIC oder VirtioNet sein.

AccessConfig

Optional. Ein Array von Konfigurationen für diese Schnittstelle. Derzeit wird nur eine Zugriffskonfiguration unterstützt: ONE_TO_ONE_NAT. Wenn keine accessConfigs angegeben sind, hat die Instanz über eine sitzungsspezifische externe IP-Adresse externen Internetzugriff.

string

Optional. Interne IP-Adresse, die mit dieser Instanz verknüpft ist. Geben Sie eine nicht verwendete statische interne IP-Adresse an, die für das Subnetz verfügbar ist, in dem sich diese Instanz befindet. Lassen Sie dieses Feld leer, um eine IP-Adresse aus dem sitzungsspezifischen Bereich des Subnetzes zu verwenden.

Timestamp

Der Zeitpunkt, zu dem der Vorgang erstellt wurde.

Timestamp

Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.

string

Serverdefinierter Ressourcenpfad für das Ziel des Vorgangs.

string

Name des vom Vorgang ausgeführten Verbs.

string

Lesbarer Status des Vorgangs, falls vorhanden.

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.

string

Zum Starten des Vorgangs verwendete API-Version.

string

API-Endpunktname dieses Vorgangs.

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

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.update

BootDisk

Erforderlich. Das Bootlaufwerk, dessen Größe angepasst werden soll. Es wird nur „disk_size_gb“ verwendet.

DataDisk

Erforderlich. Das Laufwerk, dessen Größe angepasst werden soll. Es wird nur „disk_size_gb“ verwendet.

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.update

Snapshot

Snapshot, der für die Wiederherstellung verwendet werden soll.

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.rollback

string

Erforderlich. Der Snapshot für den Rollback. Beispiel: „projects/test-project/global/snapshots/krwlzipynril“.

string

Erforderlich. Nur Ausgabe. Versions-ID

string

Optional. E-Mail-Adresse des Dienstkontos.

string

Nur Ausgabe. Die Liste der Bereiche, die für dieses Dienstkonto verfügbar gemacht werden sollen. Wird vom CLH auf https://www.googleapis.com/auth/cloud-platform festgelegt.

bool

Optional. Gibt an, ob für die VM-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.

bool

Optional. Gibt an, ob das vTPM für die VM-Instanz aktiviert ist.

bool

Optional. Gibt an, ob für die VM-Instanz das Integritätsmonitoring aktiviert ist.

Ermöglicht die Überwachung und Attestierung der Bootintegrität der VM-Instanz. Die Attestierung erfolgt anhand der Referenz der Integritätsrichtlinie. Diese Baseline wird anfangs aus dem implizit vertrauenswürdigen Boot-Image abgeleitet, wenn die VM-Instanz erstellt wird.

string

Erforderlich. Die ID des Snapshots.

string

Erforderlich. Die Projekt-ID des Snapshots.

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

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

string

Nur Ausgabe. Die von WbI unterstützten Maschinentypen.

string

Nur Ausgabe. Die von WbI unterstützten Beschleunigertypen.

Instance

Erforderlich. Eine Darstellung einer Instanz.

Die Autorisierung erfordert folgende IAM-Berechtigung für die angegebene Ressource instance:

• iam.permissions.none

FieldMask

Erforderlich. Maske zum Aktualisieren einer Instanz. Aktualisierbare Felder:

• labels
• gce_setup.min_cpu_platform
• gce_setup.metadata
• gce_setup.machine_type
• gce_setup.accelerator_configs
• gce_setup.accelerator_configs.type
• gce_setup.accelerator_configs.core_count
• gce_setup.gpu_driver_config
• gce_setup.gpu_driver_config.enable_gpu_driver
• gce_setup.gpu_driver_config.custom_gpu_driver_path
• gce_setup.shielded_instance_config
• gce_setup.shielded_instance_config.enable_secure_boot
• gce_setup.shielded_instance_config.enable_vtpm
• gce_setup.shielded_instance_config.enable_integrity_monitoring
• gce_setup.reservation_affinity
• gce_setup.reservation_affinity.consume_reservation_type
• gce_setup.reservation_affinity.key
• gce_setup.reservation_affinity.values
• gce_setup.tags
• gce_setup.container_image
• gce_setup.container_image.repository
• gce_setup.container_image.tag
• gce_setup.disable_public_ip
• disable_proxy_access

Hinweis: gce_setup.disable_public_ip und disable_proxy_access sind beim Aktualisieren unidirektional. Sie können nur verwendet werden, um die Funktion zu deaktivieren (das Feld auf true festlegen). Anfragen, bei denen eines der Felder wieder auf false festgelegt wird (Reaktivieren des externen IP- oder Proxyzugriffs), werden mit INVALID_ARGUMENT abgelehnt.

string

Optional. UUID für idempotente Anfragen.

string

Optional. Der Snapshot des Bootlaufwerks dieser Notebook-Instanz vor dem Upgrade.

string

Optional. Das VM-Image vor diesem Instanz-Upgrade.

string

Optional. Das Container-Image vor dem Upgrade dieser Instanz.

string

Optional. Das Framework dieser Notebook-Instanz.

string

Optional. Die Version der Notebook-Instanz vor diesem Upgrade.

State

Nur Ausgabe. Der Status dieses Eintrags im Upgradeverlauf der Instanz.

Timestamp

Nicht veränderbar. Der Zeitpunkt, zu dem dieser Eintrag im Upgradeverlauf der Instanz erstellt wurde.

Action

Optional. Aktion Rollback oder Upgrade

string

Optional. Ziel-VM-Version, z. B. „m63“.

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

string

Optional. Der Ressourcenname der Compute Engine-Imagefamilie, auf die aktualisiert werden soll. Format: projects/{project_id}/global/images/family/{image_family} Wenn angegeben, wird die Instanz auf das neueste Image in der angegebenen Image-Familie aktualisiert. Dies ermöglicht Upgrades über Image-Familien hinweg. Wenn keine Angabe erfolgt, wird die Instanz auf das neueste Image in der aktuellen Image-Familie aktualisiert.

string

Erforderlich. Der Name des Google Cloud-Projekts, zu dem dieses VM-Image gehört. Format: {project_id}

string

Nur Ausgabe. Eine menschenlesbare Beschreibung des Images, das auf der Instanz ausgeführt wird (z. B. „Debian 11, Python 3.10“), die zur Lesezeit aus der Konfiguration der Image-Version (der Source of Truth) abgeleitet wird. Wird für nicht erkannte Bootlaufwerk-Images auf „Benutzerdefiniert“ gesetzt.

string

Optional. Suchen Sie anhand des VM-Image-Namens nach dem Image.

string

Optional. Verwenden Sie diese VM-Image-Familie, um das Image zu finden. Das neueste Image in dieser Familie wird verwendet.