Package google.cloud.notebooks.v2

Index

NotebookService

Service d'API v2 pour les instances de notebooks Workbench.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

Vérifie si une instance de notebook peut être mise à niveau.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Créer une instance dans un projet et un emplacement donnés.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Supprimer une seule instance.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

Crée un fichier de diagnostic et exécute l'outil de diagnostic pour une instance donnée.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Renvoie différents paramètres de configuration.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Récupère les détails d'une seule instance.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Liste les instances d'un projet et d'un emplacement donnés.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Réinitialise une instance de notebook.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

Redimensionnez le disque d'une instance de notebook pour augmenter sa capacité.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance restaure une instance à partir d'une BackupSource.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

Effectue un rollback d'une instance de notebook vers la version précédente.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Démarre une instance de notebook.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Arrête une instance de notebook.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance met à jour une instance.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

Met à niveau une instance de notebook vers la dernière version.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/notebooks

Pour plus d'informations, consultez la Authentication Overview.

AcceleratorConfig

Configuration d'un accélérateur pour une instance de VM Définition d'un accélérateur matériel. Notez qu'il n'y a pas de vérification des combinaisons type et core_count. Les TPU ne sont pas compatibles. Pour trouver une combinaison valide, consultez GPU sur Compute Engine.

Champs
type

AcceleratorType

Facultatif. Type de cet accélérateur.
core_count

int64

Facultatif. Nombre de cœurs de cet accélérateur.

AcceleratorType

Définition des types d'accélérateurs matériels pouvant être utilisés sur cette instance.

Enums
ACCELERATOR_TYPE_UNSPECIFIED Le type d'accélérateur n'est pas spécifié.
NVIDIA_TESLA_P100

Obsolète : utilisez NVIDIA_TESLA_T4 (N1) ou NVIDIA_L4 (G2) à la place. Le GPU NVIDIA Tesla P100 est mis hors service à l'échelle du parc par Compute Engine et n'est plus disponible pour les nouvelles instances.
NVIDIA_TESLA_V100 Le type d'accélérateur est Nvidia Tesla V100.
NVIDIA_TESLA_P4 Le type d'accélérateur est Nvidia Tesla P4.
NVIDIA_TESLA_T4 Le type d'accélérateur est Nvidia Tesla T4.
NVIDIA_TESLA_A100 Le type d'accélérateur est Nvidia Tesla A100 – 40 Go.
NVIDIA_A100_80GB Le type d'accélérateur est Nvidia Tesla A100-80GB.
NVIDIA_L4 Le type d'accélérateur est Nvidia Tesla L4.
NVIDIA_H100_80GB Le type d'accélérateur est Nvidia Tesla H100 – 80 Go.
NVIDIA_H100_MEGA_80GB Le type d'accélérateur est Nvidia Tesla H100 – MEGA 80 Go.
NVIDIA_H200_141GB Le type d'accélérateur est Nvidia Tesla H200 – 141 Go.
NVIDIA_TESLA_T4_VWS Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla T4".
NVIDIA_TESLA_P100_VWS

Obsolète : utilisez plutôt NVIDIA_TESLA_T4_VWS. Le GPU NVIDIA Tesla P100 (Virtual Workstations) est mis hors service à l'échelle du parc par Compute Engine et n'est plus disponible pour les nouvelles instances.
NVIDIA_TESLA_P4_VWS Le type d'accélérateur est NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_B200 Le type d'accélérateur est NVIDIA B200.
NVIDIA_RTX6000 NVIDIA RTX 6000.

AccessConfig

Configuration d'accès associée à l'interface réseau d'une instance.

Champs
external_ip

string

Facultatif. Adresse IP externe associée à cette instance. Spécifiez une adresse IP externe statique inutilisée disponible pour le projet ou laissez ce champ non défini pour utiliser une adresse IP d'un pool d'adresses IP éphémères partagé. Si vous spécifiez une adresse IP externe statique, elle doit se trouver dans la même région que la zone de l'instance.

BootDisk

Définition d'un disque de démarrage.

Champs
disk_size_gb

int64

Facultatif. Taille du disque de démarrage en Go associé à cette instance, jusqu'à un maximum de 64 000 Go (64 To). Si aucune valeur n'est spécifiée, la valeur par défaut est la valeur recommandée de 150 Go.
disk_type

DiskType

Facultatif. Indique le type de disque.
disk_encryption

DiskEncryption

Facultatif. Méthode de chiffrement de disque utilisée sur les disques de démarrage et de données. La valeur par défaut est GMEK.
kms_key

string

Facultatif. Clé KMS utilisée pour chiffrer les disques. Ne s'applique que si disk_encryption est défini sur CMEK. Format : projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

En savoir plus sur l'utilisation de vos propres clés de chiffrement

CheckInstanceUpgradabilityRequest

Demande permettant de vérifier si une instance de notebook peut être mise à niveau.

Champs
notebook_instance

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource notebookInstance indiquée :

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

Réponse pour vérifier si une instance de notebook peut être mise à niveau.

Champs
upgradeable

bool

Si une instance peut être mise à niveau.
upgrade_version

string

Version vers laquelle cette instance sera mise à niveau si le point de terminaison de mise à niveau est appelé. Ce champ ne sera renseigné que si "field_upgradeable" est défini sur "true".
upgrade_info

string

Informations supplémentaires sur la mise à niveau.
upgrade_image

string

L'auto-lien de la nouvelle image vers laquelle cette instance sera mise à niveau si le point de terminaison de mise à niveau est appelé. Ce champ ne sera renseigné que si "field_upgradeable" est défini sur "true".

ConfidentialInstanceConfig

Ensemble d'options d'instance confidentielle.

Champs
confidential_instance_type

ConfidentialInstanceType

Facultatif. Définit le type de technologie utilisé par l'instance confidentielle.

ConfidentialInstanceType

Type d'instance confidentielle.

Enums
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED Aucun type spécifié. N'utilisez pas cette valeur.
SEV AMD SEV (Secure Encrypted Virtualization)

Configuration

Réponse pour obtenir les configurations WbI dans un lieu

Champs
default_values

DefaultValues

Uniquement en sortie. Valeurs par défaut de la configuration.
supported_values

SupportedValues

Uniquement en sortie. Valeurs acceptées pour la configuration.
available_images[]

ImageRelease

Uniquement en sortie. Liste des images disponibles pour créer un fichier WbI.
disable_workbench_legacy_creation

bool

Uniquement en sortie. Indicateur permettant de désactiver la création d'anciens notebooks Workbench (notebooks gérés par l'utilisateur et notebooks gérés par Google).

ContainerImage

Définition d'une image de conteneur pour démarrer une instance de notebook avec l'environnement installé dans un conteneur.

Champs
repository

string

Obligatoire. Chemin d'accès au dépôt d'images de conteneurs. Par exemple : gcr.io/{project_id}/{image_name}
tag

string

Facultatif. Tag de l'image de conteneur. Si aucune valeur n'est spécifiée, la valeur par défaut est le tag le plus récent.

CreateInstanceRequest

Requête de création d'une instance de notebook.

Champs
parent

string

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

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • notebooks.instances.create
instance_id

string

Obligatoire. Identifiant unique défini par l'utilisateur pour cette instance.
instance

Instance

Obligatoire. Instance à créer.
request_id

string

Facultatif. UUID de la requête idempotente.

DataDisk

Ressource de disque associée à une instance.

Champs
disk_size_gb

int64

Facultatif. Taille du disque en Go associé à cette instance de VM, jusqu'à un maximum de 64 000 Go (64 To). Si aucune valeur n'est spécifiée, la valeur par défaut est 100.
disk_type

DiskType

Facultatif. Indique le type de disque.
disk_encryption

DiskEncryption

Facultatif. Méthode de chiffrement de disque utilisée sur les disques de démarrage et de données. La valeur par défaut est GMEK.
kms_key

string

Facultatif. Clé KMS utilisée pour chiffrer les disques. Ne s'applique que si disk_encryption est défini sur CMEK. Format : projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

En savoir plus sur l'utilisation de vos propres clés de chiffrement
resource_policies[]

string

Facultatif. Stratégies de ressources à appliquer au disque de données.

DefaultValues

DefaultValues représente les valeurs de configuration par défaut.

Champs
machine_type

string

Uniquement en sortie. Type de machine par défaut utilisé par le backend s'il n'est pas fourni par l'utilisateur.

DeleteInstanceRequest

Requête de suppression d'une instance de notebook.

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.delete
request_id

string

Facultatif. UUID de la requête idempotente.

DiagnoseInstanceRequest

Demande de création d'un fichier de diagnostic d'instance de notebook.

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

Obligatoire. Définit les indicateurs utilisés pour exécuter l'outil de diagnostic
timeout_minutes

int32

Facultatif. Durée maximale en minutes avant l'expiration de l'opération.

DiagnosticConfig

Définit les indicateurs utilisés pour exécuter l'outil de diagnostic

Champs
gcs_bucket

string

Obligatoire. Emplacement du bucket Cloud Storage de l'utilisateur (OBLIGATOIRE). Doit être mis en forme avec le préfixe de chemin d'accès (gs://$GCS_BUCKET).

Autorisations : Notebooks gérés par l'utilisateur : "storage.buckets.writer" doit être accordée au compte de service du projet associé à la VM. Notebooks gérés par Google : "storage.buckets.writer" doit être attribué au compte de service du projet ou aux identifiants utilisateur associés à la VM, selon le mode d'authentification.

Le fichier journal du bucket Cloud Storage sera écrit dans gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

Facultatif. Définit le chemin de stockage relatif dans le bucket Cloud Storage où les journaux de diagnostic seront écrits. Le chemin par défaut sera le répertoire racine du bucket Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Exemple de chemin complet où le fichier journal sera écrit : gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

Facultatif. Active le service de réparation pour l'instance
enable_packet_capture_flag

bool

Facultatif. Active le flag permettant de capturer les paquets de l'instance pendant 30 secondes.
enable_copy_home_files_flag

bool

Facultatif. Active le flag pour copier tout le contenu du dossier /home/jupyter.

DiskEncryption

Définition des options de chiffrement du disque.

Enums
DISK_ENCRYPTION_UNSPECIFIED Le chiffrement de disque n'est pas spécifié.
GMEK Utilisez des clés de chiffrement gérées par Google pour chiffrer le disque de démarrage.
CMEK Utilisez des clés de chiffrement gérées par le client pour chiffrer le disque de démarrage.

DiskType

Types de disques possibles.

Enums
DISK_TYPE_UNSPECIFIED Le type de disque n'est pas défini.
PD_STANDARD Type de disque persistant standard.
PD_SSD Type de disque persistant SSD.
PD_BALANCED Type de disque persistant avec équilibrage.
PD_EXTREME Type de disque persistant extrême.
HYPERDISK_BALANCED Représente le type de disque persistant Hyperdisk Balanced. Peut être utilisé comme disque de démarrage ou disque de données.
HYPERDISK_EXTREME Représente le type de disque persistant Hyperdisk Extreme. Ne peut être utilisé que comme disque de données.
HYPERDISK_THROUGHPUT Représente le type de disque persistant Hyperdisk Throughput. Ne peut être utilisé que comme disque de données.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Représente le type de disque persistant Hyperdisk Balanced High Availability. Peut être utilisé comme disque de démarrage ou disque de données.
HYPERDISK_ML Représente le type de disque persistant Hyperdisk ML. Peut être utilisé comme disque de démarrage ou disque de données.

GPUDriverConfig

Configuration d'un pilote de GPU

Champs
enable_gpu_driver

bool

Facultatif. Indique si l'utilisateur final autorise Google Cloud à installer le pilote de GPU sur cette instance de VM. Si ce champ est vide ou défini sur "false", le pilote de GPU ne sera pas installé. Ne s'applique qu'aux instances avec GPU.
custom_gpu_driver_path

string

Facultatif. Spécifiez un chemin d'accès Cloud Storage personnalisé où le pilote GPU est stocké. Si vous n'en indiquez pas, nous choisirons automatiquement parmi les pilotes de GPU officiels.

GceSetup

Définition de la configuration d'une instance de VM en dehors des ressources et de l'identité.

Champs
machine_type

string

Facultatif. Type de machine de l'instance de VM. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

Facultatif. Configuration minimale de la plate-forme de processeur à utiliser pour cette instance. La liste des valeurs valides est disponible sur https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones.
accelerator_configs[]

AcceleratorConfig

Facultatif. Accélérateurs matériels utilisés sur cette instance. Si vous utilisez des accélérateurs, assurez-vous que votre configuration dispose de suffisamment de processeurs virtuels et de mémoire pour prendre en charge les machine_type que vous avez sélectionnés. Actuellement, une seule configuration d'accélérateur est acceptée.
service_accounts[]

ServiceAccount

Facultatif. Compte de service qui sert d'identité à l'instance de VM. Actuellement, un seul compte de service est accepté.
boot_disk

BootDisk

Facultatif. Disque de démarrage de la VM.
data_disks[]

DataDisk

Facultatif. Disques de données associés à l'instance de VM. Actuellement, un seul disque de données est accepté.
shielded_instance_config

ShieldedInstanceConfig

Facultatif. Configuration de VM protégée. Images utilisant les fonctionnalités de VM protégée compatibles
network_interfaces[]

NetworkInterface

Facultatif. Interfaces réseau de la VM. Ne prend en charge qu'une seule interface.
disable_public_ip

bool

Facultatif. Si la valeur est "true", aucune adresse IP externe ne sera attribuée à cette instance de VM.
tags[]

string

Facultatif. Tags réseau Compute Engine à ajouter au runtime (voir Ajouter des tags réseau).
metadata

map<string, string>

Facultatif. Métadonnées personnalisées à appliquer à cette instance.
system_metadata

map<string, string>

Uniquement en sortie. Représente les métadonnées gérées par le système pour cette instance : le sous-ensemble de metadata dont les clés sont des clés système Workbench reconnues.
enable_ip_forwarding

bool

Facultatif. Indicateur permettant d'activer ou non le transfert d'adresse IP. La valeur par défaut est "false" (désactivé). https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

Facultatif. Configuration des pilotes de GPU.
confidential_instance_config

ConfidentialInstanceConfig

Facultatif. Configuration d'instance confidentielle.
instance_id

string

Uniquement en sortie. ID unique de la ressource d'instance Compute Engine.
Champ d'union image. Type de l'image : image de VM ou image de conteneur. image ne peut être qu'un des éléments suivants :
vm_image

VmImage

Facultatif. Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook.
container_image

ContainerImage

Facultatif. Utilisez une image de conteneur pour démarrer l'instance de notebook.

GetConfigRequest

Requête permettant d'obtenir les paramètres de configuration de Workbench.

Champs
name

string

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

GetInstanceRequest

Requête d'obtention d'une instance de notebook.

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.get

HealthState

État de fonctionnement de l'instance.

Enums
HEALTH_STATE_UNSPECIFIED Le sous-état de l'instance est inconnu.
HEALTHY L'instance est connue pour être dans un état sain (par exemple, les daemons critiques sont en cours d'exécution). S'applique à l'état "ACTIVE".
UNHEALTHY L'instance est connue pour être dans un état non sain (par exemple, les daemons critiques ne sont pas en cours d'exécution). S'applique à l'état ACTIVE.
AGENT_NOT_INSTALLED L'agent de surveillance de l'état n'est pas installé sur l'instance. S'applique à l'état ACTIF.
AGENT_NOT_RUNNING L'agent de surveillance de l'état de l'instance n'est pas en cours d'exécution. S'applique à l'état ACTIF.

ImageRelease

ConfigImage représente une version d'image disponible pour créer une instance Workbench.

Champs
image_name

string

Uniquement en sortie. Nom de l'image au format workbench-instances-vYYYYmmdd--
release_name

string

Uniquement en sortie. Publication de l'image du formulaire m123
image_family

string

Uniquement en sortie. Famille d'images de l'image. (par exemple, "workbench-instances" ou "workbench-2603")
description

string

Uniquement en sortie. Description de l'image.

Instance

Définition d'une instance de notebook.

Champs
name

string

Uniquement en sortie. Identifiant. Nom de cette instance de notebook. Format : projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

Uniquement en sortie. Point de terminaison du proxy utilisé pour accéder au notebook Jupyter.
instance_owners[]

string

Facultatif. Propriétaire de cette instance après sa création. Format : alias@example.com

Actuellement, un seul propriétaire est accepté. Si aucun utilisateur n'est spécifié, tous les utilisateurs du compte de service de votre instance de VM peuvent utiliser l'instance.
creator

string

Uniquement en sortie. Adresse e-mail de l'entité ayant envoyé la demande CreateInstance initiale.
state

State

Uniquement en sortie. État de cette instance.
upgrade_history[]

UpgradeHistoryEntry

Uniquement en sortie. Historique des mises à niveau de cette instance.
id

string

Uniquement en sortie. ID unique de la ressource.
health_state

HealthState

Uniquement en sortie. État de fonctionnement de l'instance.
health_info

map<string, string>

Uniquement en sortie. Informations supplémentaires sur l'état de l'instance. Exemple :

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

Timestamp

Uniquement en sortie. Heure de création de l'instance.
update_time

Timestamp

Uniquement en sortie. Heure de mise à jour de l'instance.
disable_proxy_access

bool

Facultatif. Si la valeur est "true", l'instance de notebook ne s'enregistre pas auprès du proxy.
labels

map<string, string>

Facultatif. Libellés à appliquer à cette instance. Vous pourrez les modifier ultérieurement à l'aide de la méthode UpdateInstance.
third_party_proxy_url

string

Uniquement en sortie. Point de terminaison proxy des pools de personnel utilisé pour accéder au notebook Jupyter.
satisfies_pzs

bool

Uniquement en sortie. Réservé pour une utilisation ultérieure pour la séparation des zones.
satisfies_pzi

bool

Uniquement en sortie. Réservé pour une utilisation ultérieure pour l'isolation des zones.
enable_third_party_identity

bool

Facultatif. Indicateur qui précise qu'un notebook est accessible avec un fournisseur d'identité tiers.
enable_managed_euc

bool

Facultatif. Indicateur permettant d'activer les identifiants gérés de l'utilisateur final pour l'instance.
enable_deletion_protection

bool

Facultatif. Si la valeur est "true", la protection contre la suppression sera activée pour cette instance Workbench. Si la valeur est "false", la protection contre la suppression sera désactivée pour cette instance Workbench.
Champ d'union infrastructure. Configuration de l'instance de notebook. infrastructure ne peut être qu'un des éléments suivants :
gce_setup

GceSetup

Facultatif. Configuration de Compute Engine pour le notebook. Utilise les champs définis dans le notebook.

ListInstancesRequest

Requête pour lister les instances de notebooks.

Champs
parent

string

Obligatoire. Parent de l'instance. Formats : - projects/{project_id}/locations/{location} pour lister les instances dans une zone spécifique. - projects/{project_id}/locations/- pour lister les instances dans tous les emplacements.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • notebooks.instances.list
page_size

int32

Facultatif. Taille de retour maximale de l'appel de liste.
page_token

string

Facultatif. Jeton de page renvoyé précédemment et pouvant être utilisé pour continuer à lister à partir du dernier résultat.
order_by

string

Facultatif. Tri des résultats. Les valeurs acceptées sont "name", "name desc" ou "" (non triées).
filter

string

Facultatif. Filtre de liste.

ListInstancesResponse

Réponse pour la liste des instances de notebooks.

Champs
instances[]

Instance

Liste des instances renvoyées.
next_page_token

string

Jeton de page qui peut être utilisé pour continuer à lister à partir du dernier résultat lors du prochain appel de liste.
unreachable[]

string

Liste non triée. Emplacements inaccessibles. Par exemple, ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. Une réponse ListInstancesResponse ne contient que des instances ou des instances inaccessibles.

NetworkInterface

Définition d'une ressource d'interface réseau associée à une VM.

Champs
network

string

Facultatif. Nom du VPC dans lequel se trouve cette instance de VM. Format : projects/{project_id}/global/networks/{network_id}
subnet

string

Facultatif. Nom du sous-réseau dans lequel se trouve cette instance de VM. Format : projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
nic_type

NicType

Facultatif. Type de carte d'interface réseau virtuelle à utiliser sur cette interface. Il peut s'agir de gVNIC ou de VirtioNet.
access_configs[]

AccessConfig

Facultatif. Tableau de configurations pour cette interface. Actuellement, une seule configuration d'accès est acceptée : ONE_TO_ONE_NAT. Si aucune accessConfigs n'est spécifiée, l'instance disposera d'un accès externe à Internet via une adresse IP externe éphémère.
internal_ip

string

Facultatif. Adresse IP interne associée à cette instance. Spécifiez une adresse IP interne statique inutilisée disponible pour le sous-réseau dans lequel se trouve cette instance, ou laissez ce champ non défini pour utiliser une adresse IP de la plage éphémère du sous-réseau.

NicType

Type de pilote vNIC. La valeur par défaut doit être NIC_TYPE_UNSPECIFIED.

Enums
NIC_TYPE_UNSPECIFIED Aucun type spécifié.
VIRTIO_NET VIRTIO
GVNIC GVNIC

OperationMetadata

Représente les métadonnées de l'opération de longue durée.

Champs
create_time

Timestamp

Heure à laquelle l'opération a été créée.
end_time

Timestamp

Heure à laquelle l'exécution de l'opération s'est terminée.
target

string

Chemin d'accès à la ressource défini par le serveur pour la cible de l'opération.
verb

string

Nom du verbe exécuté par l'opération.
status_message

string

Statut lisible de l'opération, le cas échéant.
requested_cancellation

bool

Détermine si l'utilisateur a demandé l'annulation de l'opération. Les opérations qui ont bien été annulées possèdent la valeur google.longrunning.Operation.error avec un google.rpc.Status.code de 1, correspondant à Code.CANCELLED.
api_version

string

Version de l'API ayant permis de démarrer l'opération.
endpoint

string

Nom du point de terminaison de l'API pour cette opération.

ResetInstanceRequest

Demande de réinitialisation d'une instance de notebook

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.reset

ResizeDiskRequest

Demande de redimensionnement des disques de l'instance de notebook

Champs
notebook_instance

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource notebookInstance indiquée :

  • notebooks.instances.update
Champ d'union Disk. Type de disque redimensionnable : disque de démarrage ou de données Disk ne peut être que l'un des suivants :
boot_disk

BootDisk

Obligatoire. Disque de démarrage à redimensionner. Seul disk_size_gb sera utilisé.
data_disk

DataDisk

Obligatoire. Disque de données à redimensionner. Seul disk_size_gb sera utilisé.

RestoreInstanceRequest

Demande de restauration de l'instance de notebook à partir d'une BackupSource.

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.update
Champ d'union Source. Source à partir de laquelle effectuer la restauration. Source ne peut être qu'un des éléments suivants :
snapshot

Snapshot

Instantané à utiliser pour la restauration.

RollbackInstanceRequest

Demande de rétablissement d'une instance de notebook

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.rollback
target_snapshot

string

Obligatoire. Instantané pour le rollback. Exemple : "projects/test-project/global/snapshots/krwlzipynril".
revision_id

string

Obligatoire. Uniquement en sortie. Identifiant de révision

ServiceAccount

Un compte de service qui sert d'identité.

Champs
email

string

Facultatif. Adresse e-mail du compte de service.
scopes[]

string

Uniquement en sortie. Liste des champs d'application à rendre disponibles pour ce compte de service. Défini par le CLH sur https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfig

Ensemble d'options d'instances protégées. Consultez Images utilisant les fonctionnalités de VM protégées compatibles. Toutes les combinaisons ne sont pas valides.

Champs
enable_secure_boot

bool

Facultatif. Définit si le démarrage sécurisé est activé pour l'instance de VM.

Le démarrage sécurisé vous permet de vous assurer que le système n'exécute que des logiciels authentiques. Il vérifie pour cela la signature numérique de tous les composants de démarrage et interrompt le processus de démarrage si cette vérification échoue. Désactivé par défaut
enable_vtpm

bool

Facultatif. Définit si le module vTPM est activé pour l'instance de VM.
enable_integrity_monitoring

bool

Facultatif. Définit si la surveillance de l'intégrité est activée pour l'instance de VM.

Permet de surveiller et d'attester de l'intégrité du démarrage de l'instance de VM. L'attestation est effectuée par rapport à la règle d'intégrité de référence. Cette référence est initialement issue de l'image de démarrage implicitement approuvée lors de la création de l'instance de VM.

Instantané

L'instantané représente l'instantané du disque de données utilisé pour restaurer l'instance Workbench. Fait référence à : compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

Champs
snapshot_id

string

Obligatoire. ID de l'instantané.
project_id

string

Obligatoire. ID du projet de l'instantané.

StartInstanceRequest

Demande de démarrage d'une instance de notebook

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.start

État

Définition des états de cette instance.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié.
STARTING La logique de contrôle démarre l'instance.
PROVISIONING La logique de contrôle installe les frameworks requis et enregistre l'instance auprès du proxy de notebook.
ACTIVE L'instance est en cours d'exécution.
STOPPING La logique de contrôle arrête l'instance.
STOPPED L'instance est arrêtée.
DELETED L'instance est supprimée.
UPGRADING L'instance est en cours de mise à niveau.
INITIALIZING L'instance est en cours de création.
SUSPENDING L'instance est en cours de suspension.
SUSPENDED L'instance est suspendue.
ORPHANED L'instance ne comporte aucune VM. Une mise à niveau a supprimé le disque d'origine et n'a pas pu le remplacer. Le disque de données et les éventuels instantanés sont intacts. Réessayez de la mettre à niveau pour la terminer ou effectuez un rollback de l'instance vers l'instantané pris avant le début de la mise à niveau.

StopInstanceRequest

Demande d'arrêt d'une instance de notebook

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.stop

SupportedValues

SupportedValues représente les valeurs acceptées par la configuration.

Champs
machine_types[]

string

Uniquement en sortie. Types de machines compatibles avec WbI.
accelerator_types[]

string

Uniquement en sortie. Types d'accélérateurs compatibles avec WbI.

UpdateInstanceRequest

Requête de mise à jour d'une instance de notebook.

Champs
instance

Instance

Obligatoire. Représentation d'une instance.

L'autorisation IAM suivante est requise pour la ressource instance indiquée :

  • iam.permissions.none
update_mask

FieldMask

Obligatoire. Masque utilisé pour mettre à jour une instance. Champs modifiables :

  • 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

Remarque : gce_setup.disable_public_ip et disable_proxy_access sont unidirectionnels lors de la mise à jour. Ils ne peuvent être utilisés que pour désactiver la fonctionnalité (définir le champ sur true). Les requêtes qui redéfinissent l'un ou l'autre champ sur false (réactivation de l'accès à l'adresse IP externe ou au proxy) sont refusées avec INVALID_ARGUMENT.
request_id

string

Facultatif. UUID de la requête idempotente.

UpgradeHistoryEntry

Entrée de l'historique de mise à niveau des images de VM.

Champs
snapshot

string

Facultatif. Instantané du disque de démarrage de cette instance de notebook avant la mise à niveau.
vm_image

string

Facultatif. Image de VM avant la mise à niveau de cette instance.
container_image

string

Facultatif. Image de conteneur avant la mise à niveau de cette instance.
framework

string

Facultatif. Framework de cette instance de notebook.
version

string

Facultatif. Version de l'instance de notebook avant cette mise à niveau.
state

State

Uniquement en sortie. État de cette entrée de l'historique des mises à niveau de l'instance.
create_time

Timestamp

Immuable. Heure de création de cette entrée de l'historique des mises à niveau de l'instance.
action

Action

Facultatif. Action. Effectuez un rollback ou une mise à niveau.
target_version

string

Facultatif. Version de la VM cible, comme m63.

Action

Définition des opérations de cette entrée de l'historique des mises à niveau.

Enums
ACTION_UNSPECIFIED L'opération n'est pas spécifiée.
UPGRADE Passez à l'édition supérieure.
ROLLBACK Rollback.

État

Définition des états de cette entrée de l'historique des mises à niveau.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié.
STARTED La mise à niveau de l'instance a commencé.
SUCCEEDED La mise à niveau de l'instance a réussi.
FAILED Échec de la mise à niveau de l'instance.

UpgradeInstanceRequest

Demande de mise à niveau d'une instance de notebook

Champs
name

string

Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.upgrade
image_family

string

Facultatif. Nom de ressource de la famille d'images Compute Engine vers laquelle effectuer la mise à niveau. Format : projects/{project_id}/global/images/family/{image_family}. Si cette option est spécifiée, l'instance sera mise à niveau vers la dernière image de la famille d'images spécifiée, ce qui permet d'effectuer des mises à niveau entre les familles d'images. Si aucune image n'est spécifiée, l'instance sera mise à niveau vers la dernière image de sa famille d'images actuelle.

VmImage

Définition d'une image de machine virtuelle Compute Engine personnalisée pour démarrer une instance de notebook avec l'environnement installé directement sur la VM.

Champs
project

string

Obligatoire. Nom du projet Google Cloud auquel appartient cette image de VM. Format : {project_id}
image_description

string

Uniquement en sortie. Description lisible par l'humain de l'image exécutée sur l'instance (par exemple, "Debian 11, Python 3.10"), dérivée au moment de la lecture à partir de la configuration de la version de l'image (la source de vérité). Définissez la valeur sur "Personnalisé" pour les images de disque de démarrage non reconnues.
Champ d'union image. Référence à une image de VM Compute Engine externe. image ne peut être qu'un des éléments suivants :
name

string

Facultatif. Utilisez le nom de l'image de VM pour la trouver.
family

string

Facultatif. Utilisez cette famille d'images de VM pour trouver l'image. L'image la plus récente de cette famille sera utilisée.