Package google.cloud.notebooks.v1

Index

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

ManagedNotebookService

Service API v1 pour les notebooks gérés.

CreateRuntime
rpc CreateRuntime(CreateRuntimeRequest) returns (Operation) Crée un environnement d'exécution dans un projet et un emplacement donnés. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

DeleteRuntime
rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation) Supprime un seul Runtime. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

GetRuntime
rpc GetRuntime(GetRuntimeRequest) returns (Runtime) Récupère les détails d'un seul environnement d'exécution. L'emplacement doit être un point de terminaison régional et non zonal. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ListRuntimes
rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse) Liste les runtimes d'un projet et d'un emplacement donnés. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

MigrateRuntime
rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation) Migrez un environnement d'exécution existant vers une nouvelle instance Workbench. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ReportRuntimeEvent
rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation) Signale et traite un événement d'exécution. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ResetRuntime
rpc ResetRuntime(ResetRuntimeRequest) returns (Operation) Réinitialise un environnement d'exécution de notebook géré. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

StartRuntime

rpc StartRuntime(StartRuntimeRequest) returns (Operation) Démarre un environnement d'exécution de notebooks gérés. Démarrez les instances GPU et reprenez les instances CPU. Pour en savoir plus, consultez les pages suivantes : https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

StopRuntime

rpc StopRuntime(StopRuntimeRequest) returns (Operation) Arrête un environnement d'exécution de notebook géré. Arrêtez les instances GPU et suspendez les instances CPU. Consultez les pages suivantes : https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

SwitchRuntime
rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation) Changer d'environnement d'exécution d'un notebook géré Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

UpdateRuntime
rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation) Mettez à jour la configuration du runtime du notebook. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

NotebookService

Service de l'API v1 pour Cloud AI Platform Notebooks.

CreateEnvironment
rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation) Crée un environnement. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

CreateExecution
rpc CreateExecution(CreateExecutionRequest) returns (Operation) Crée une exécution dans un projet et un emplacement donnés. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

CreateSchedule
rpc CreateSchedule(CreateScheduleRequest) returns (Operation) Crée un notebook planifié dans un projet et un emplacement donnés. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

DeleteEnvironment
rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation) Supprime un seul environnement. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

DeleteExecution
rpc DeleteExecution(DeleteExecutionRequest) returns (Operation) Supprime l'exécution Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

DeleteInstance
rpc DeleteInstance(DeleteInstanceRequest) returns (Operation) Supprimer une seule instance. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

DeleteSchedule
rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation) Supprime la planification et tous les jobs sous-jacents Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

GetEnvironment
rpc GetEnvironment(GetEnvironmentRequest) returns (Environment) Récupère les détails d'un seul environnement. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

GetExecution
rpc GetExecution(GetExecutionRequest) returns (Execution) Obtenir les détails des exécutions Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

GetInstanceHealth
rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse) Vérifie si une instance de notebook est opérationnelle. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

GetSchedule
rpc GetSchedule(GetScheduleRequest) returns (Schedule) Obtenir les détails d'une programmation Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

IsInstanceUpgradeable
rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse) Vérifie si une instance de notebook peut être mise à niveau. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ListEnvironments
rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) Répertorie les environnements d'un projet. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ListExecutions
rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse) Liste les exécutions d'un projet et d'un emplacement donnés. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ListSchedules
rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse) Liste les planifications d'un projet et d'un emplacement donnés. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

MigrateInstance
rpc MigrateInstance(MigrateInstanceRequest) returns (Operation) Migre un notebook géré par l'utilisateur existant vers des instances Workbench. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

RegisterInstance

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation) Enregistre une ancienne instance de notebook existante sur le serveur de l'API Notebooks. Les anciennes instances sont celles créées avec les anciens appels Compute Engine. Elles ne sont pas gérables par l'API Notebooks prête à l'emploi. Cet appel permet à l'API Notebooks de gérer ces instances. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

ReportInstanceInfo

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation) Permet aux instances de notebook de communiquer les dernières informations les concernant au serveur de l'API Notebooks. Le serveur fusionne les informations signalées dans le magasin de métadonnées de l'instance. N'utilisez pas cette méthode directement. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

RollbackInstance
rpc RollbackInstance(RollbackInstanceRequest) returns (Operation) Rétablit la version précédente d'une instance de notebook. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

SetInstanceAccelerator
rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation) Met à jour les accélérateurs invités d'une seule instance. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

SetInstanceLabels
rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation) Remplace tous les libellés d'une instance. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

SetInstanceMachineType
rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation) Met à jour le type de machine d'une seule instance. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform 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 Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

UpdateInstanceConfig
rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation) Mettre à jour les configurations des instances de notebooks. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

UpdateInstanceMetadataItems
rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse) Ajoutez ou mettez à jour des éléments de métadonnées pour une instance. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

UpdateShieldedInstanceConfig
rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation) Met à jour la configuration d'instance protégée d'une seule instance. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

UpgradeInstance
rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation) Mise à niveau d'une instance de notebook vers la dernière version. Niveaux d'accès des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/cloud-platform Pour plus d'informations, consultez la Authentication Overview.

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 Tag de l'image de conteneur. Si aucune valeur n'est spécifiée, la balise la plus récente est utilisée par défaut.

CreateEnvironmentRequest

Requête de création d'un environnement de notebook.

Champs
parent	string Obligatoire. Format : projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.environments.create
environment_id	string Obligatoire. ID unique défini par l'utilisateur pour cet environnement. Le environment_id doit comporter entre 1 et 63 caractères, et ne peut contenir que des lettres minuscules, des chiffres et des tirets. Le premier caractère doit être une lettre minuscule et le dernier ne peut pas être un tiret.
environment	Environment Obligatoire. Environnement à créer.

CreateExecutionRequest

Demande de création d'une exécution 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.executions.create
execution_id	string Obligatoire. ID unique défini par l'utilisateur pour cette exécution.
execution	Execution Obligatoire. Exécution à créer.

CreateInstanceRequest

Demande 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. ID unique défini par l'utilisateur pour cette instance.
instance	Instance Obligatoire. Instance à créer.

CreateRuntimeRequest

Demande de création d'un environnement d'exécution de notebook géré.

Champs
parent	string Obligatoire. Format : parent=projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.runtimes.create
runtime_id	string Obligatoire. Identifiant unique défini par l'utilisateur pour ce Runtime.
runtime	Runtime Obligatoire. Environnement d'exécution à créer.
request_id	string UUID de la requête idempotente.

CreateScheduleRequest

Demande de notebooks programmés créés

Champs
parent	string Obligatoire. Format : parent=projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.schedules.create
schedule_id	string Obligatoire. Identifiant unique défini par l'utilisateur pour ce programme.
schedule	Schedule Obligatoire. Planning à créer.

DeleteEnvironmentRequest

Requête de suppression d'un environnement de notebook.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/environments/{environment_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.environments.delete

DeleteExecutionRequest

Demande de suppression d'une exécution de notebook programmée

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/executions/{execution_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.executions.delete

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

DeleteRuntimeRequest

Requête de suppression d'un environnement d'exécution de notebooks gérés.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.runtimes.delete
request_id	string UUID de la requête idempotente.

DeleteScheduleRequest

Demande de suppression d'une programmation

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/schedules/{schedule_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.schedules.delete

DiagnoseInstanceRequest

Requête 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}
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 formaté avec un 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 accordé 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 est 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/
repair_flag_enabled	bool Facultatif. Active l'indicateur pour le service de réparation de l'instance.
packet_capture_flag_enabled	bool Facultatif. Active le signalement pour capturer les paquets de l'instance pendant 30 secondes.
copy_home_files_flag_enabled	bool Facultatif. Active le flag pour copier tout le contenu du dossier /home/jupyter.

EncryptionConfig

Représente une configuration de clé de chiffrement personnalisée pouvant être appliquée à une ressource. Tous les disques de la machine virtuelle seront chiffrés.

Champs
kms_key	string Identifiant de ressource Cloud KMS de la clé de chiffrement gérée par le client, utilisée pour protéger une ressource, telle qu'un disque. Son format est le suivant : projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

Environnement

Définition d'un environnement logiciel utilisé pour démarrer une instance de notebook.

Champs
name	string Uniquement en sortie. Nom de cet environnement. Format : projects/{project_id}/locations/{location}/environments/{environment_id}
display_name	string Nom à afficher de cet environnement dans l'UI.
description	string Brève description de cet environnement.
post_startup_script	string Chemin d'accès à un script Bash qui s'exécute automatiquement après le démarrage complet d'une instance de notebook. Le chemin d'accès doit être une URL ou un chemin d'accès Cloud Storage. Exemple : "gs://path-to-file/file-name"
create_time	Timestamp Uniquement en sortie. Date et heure auxquelles cet environnement a été créé.
Champ d'union image_type. Type d'environnement : image de VM ou image de conteneur. image_type ne peut être qu'un des éléments suivants :
vm_image	VmImage Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook.
container_image	ContainerImage Utilisez une image de conteneur pour démarrer l'instance de notebook.

Événement

Définition d'un événement pour une instance de notebook gérée / semi-gérée.

Champs
report_time	Timestamp Heure du rapport sur l'événement.
type	EventType Type d'événement.
details	map<string, string> Facultatif. Détails de l'événement. Ce champ permet de transmettre des informations sur l'événement.

EventType

Définition des types d'événements.

Enums
EVENT_TYPE_UNSPECIFIED	L'événement n'est pas spécifié.
IDLE	L'instance / l'environnement d'exécution est inactif
HEARTBEAT	L'instance / l'environnement d'exécution est disponible. Cet événement indique que le calcul sous-jacent de l'instance / du runtime est opérationnel.
HEALTH	L'état de l'instance / du runtime est disponible. Cet événement indique des informations sur l'état de l'instance ou de l'environnement d'exécution.
MAINTENANCE	L'instance / l'environnement d'exécution est disponible. Cet événement permet à l'instance / au runtime d'envoyer des informations sur la maintenance de l'hôte au plan de contrôle. https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

Exécution

Définition d'un seul notebook exécuté.

Champs
execution_template	ExecutionTemplate Métadonnées d'exécution, y compris le nom, les spécifications matérielles, la région, les libellés, etc.
name	string Uniquement en sortie. Nom de ressource de l'exécution. Format : projects/{project_id}/locations/{location}/executions/{execution_id}
display_name	string Uniquement en sortie. Nom utilisé à des fins d'interface utilisateur. Le nom ne peut contenir que des caractères alphanumériques et des traits de soulignement ("_").
description	string Brève description de cette exécution.
create_time	Timestamp Uniquement en sortie. Heure à laquelle l'exécution a été instanciée.
update_time	Timestamp Uniquement en sortie. Heure de la dernière mise à jour de l'exécution.
state	State Uniquement en sortie. État du job AI Platform sous-jacent.
output_notebook_file	string Fichier notebook de sortie généré par cette exécution
job_uri	string Uniquement en sortie. URI du job externe utilisé pour exécuter le notebook.

État

Description de l'état du job AIP sous-jacent.

Enums
STATE_UNSPECIFIED	L'état de la tâche n'est pas spécifié.
QUEUED	La tâche vient d'être créée et le traitement n'a pas encore commencé.
PREPARING	Le service se prépare à exécuter le job.
RUNNING	La tâche est en cours.
SUCCEEDED	La tâche a bien été exécutée.
FAILED	La tâche a échoué. error_message doit contenir les détails de l'échec.
CANCELLING	La tâche est en cours d'annulation. error_message doit décrire le motif de l'annulation
CANCELLED	La tâche a été annulée. error_message doit décrire le motif de l'annulation
EXPIRED	Le job a expiré (pertinent pour les jobs Agent Platform) https://cloud.google.com/gemini-enterprise-agent-platform/reference/rest/v1/JobState
INITIALIZING	L'exécution est en cours de création.

ExecutionTemplate

Description d'une charge de travail d'exécution de notebook.

Champs
scale_tier (deprecated)	ScaleTier Cet élément est obsolète. Obligatoire. Niveau de scaling du matériel utilisé pour l'exécution du notebook. OBSOLÈTE Sera abandonné. Pour le moment, seul le type "CUSTOM" est accepté.
master_type	string Spécifie le type de machine virtuelle à utiliser pour le nœud de calcul maître de votre tâche d'entraînement. Vous devez spécifier ce champ lorsque scaleTier est défini sur CUSTOM. Vous pouvez utiliser certains types de machines Compute Engine directement dans ce champ. Les types de valeurs suivants sont acceptés : 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 Vous pouvez également utiliser les anciens types de machines suivants : 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 Enfin, si vous souhaitez utiliser un TPU pour l'entraînement, spécifiez cloud_tpu dans ce champ. En savoir plus sur les options de configuration spéciales pour l'entraînement avec des TPU
accelerator_config	SchedulerAcceleratorConfig Configuration (nombre et type d'accélérateur) du matériel exécutant le notebook.
labels	map<string, string> Libellés pour l'exécution. Si l'exécution est planifiée, un champ "nbs-scheduled" sera inclus. Sinon, il s'agit d'une exécution immédiate et un champ inclus sera "nbs-immediate". Utilisez des champs pour indexer efficacement différents types d'exécutions.
input_notebook_file	string Chemin d'accès au fichier notebook à exécuter. Doit se trouver dans un bucket Google Cloud Storage. Format : gs://{bucket_name}/{folder}/{notebook_file_name} (par exemple, gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb)
container_image_uri	string URI d'image de conteneur vers un exemple de DLVM : "gcr.io/deeplearning-platform-release/base-cu100". Vous trouverez d'autres exemples sur la page https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container.
output_notebook_folder	string Chemin d'accès au dossier du notebook dans lequel écrire. Doit correspondre au chemin d'accès à un bucket Cloud Storage. Format : gs://{bucket_name}/{folder} (par exemple, gs://notebook_user/scheduled_notebooks)
params_yaml_file	string Paramètres à remplacer dans le notebook lors de l'exécution. Consultez https://papermill.readthedocs.io/en/latest/usage-parameterize.html pour savoir comment spécifier des paramètres dans le notebook d'entrée et les transmettre ici dans un fichier YAML. Ex. : gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters	string Paramètres utilisés dans le notebook "input_notebook_file".
service_account	string Adresse e-mail d'un compte de service à utiliser lors de l'exécution. Vous devez disposer de l'autorisation iam.serviceAccounts.actAs pour le compte de service spécifié.
job_type	JobType Type de job à utiliser pour cette exécution.
kernel_spec	string Nom de la spécification du noyau à utiliser. Cette option doit être spécifiée si le nom de la spécification du noyau sur la cible d'exécution ne correspond pas au nom dans le fichier notebook d'entrée.
tensorboard	string Nom d'une ressource de plate-forme d'agent [Tensorboard] dans laquelle cette exécution importera les journaux Tensorboard. Format : projects/{project}/locations/{location}/tensorboards/{tensorboard}
Champ d'union job_parameters. Paramètres d'un type d'exécution. REMARQUE : Il n'existe actuellement aucun paramètre supplémentaire pour les jobs Vertex AI. job_parameters ne peut être qu'un des éléments suivants :
dataproc_parameters	DataprocParameters Paramètres utilisés dans les exécutions JobType Dataproc.
vertex_ai_parameters	VertexAIParameters Paramètres utilisés dans les exécutions JobType Agent Platform.

DataprocParameters

Paramètres utilisés dans les exécutions JobType Dataproc.

Champs
cluster	string URI du cluster utilisé pour exécuter Dataproc. Format : projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType (Type de tâche)

Backend utilisé pour cette exécution.

Enums
JOB_TYPE_UNSPECIFIED	Aucun type spécifié.
VERTEX_AI	Job personnalisé dans aiplatform.googleapis.com. Valeur par défaut pour une exécution.
DATAPROC	Exécutez l'exécution sur un cluster avec Dataproc en tant que job. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

Obligatoire. Spécifie les types de machines, le nombre d'instances dupliquées pour les nœuds de calcul et les serveurs de paramètres.

Enums
SCALE_TIER_UNSPECIFIED	Niveau d'évolutivité non spécifié.
BASIC	Une seule instance de nœud de calcul. Ce niveau convient à la découverte de Cloud ML et au test de nouveaux modèles à l'aide de petits ensembles de données.
STANDARD_1	Plusieurs nœuds de calcul et quelques serveurs de paramètres.
PREMIUM_1	Un grand nombre de nœuds de calcul avec plusieurs serveurs de paramètres.
BASIC_GPU	Une seule instance de nœud de calcul avec un GPU K80.
BASIC_TPU	Une seule instance de nœud de calcul avec un Cloud TPU.
CUSTOM	Le niveau CUSTOM n'est pas un niveau défini, mais vous permet d'appliquer votre propre spécification de cluster. Lorsque vous utilisez ce niveau, définissez des valeurs pour configurer votre cluster de traitement conformément aux instructions suivantes : Vous devez définir la valeur ExecutionTemplate.masterType pour spécifier le type de machine à utiliser pour votre nœud maître. Il s'agit du seul paramètre obligatoire.

SchedulerAcceleratorConfig

Définition d'un accélérateur matériel. Notez que toutes les combinaisons de type et core_count ne sont pas valides. Consultez la page GPU sur Compute Engine pour trouver une combinaison valide. Les TPU ne sont pas compatibles.

Champs
type	SchedulerAcceleratorType Type de cet accélérateur.
core_count	int64 Nombre de cœurs de cet accélérateur.

SchedulerAcceleratorType

Types d'accélérateurs matériels pour les tâches AI Platform Training.

Enums
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED	Type d'accélérateur non spécifié. Par défaut, aucun GPU.
NVIDIA_TESLA_K80	GPU Nvidia Tesla K80.
NVIDIA_TESLA_P100	GPU Nvidia Tesla P100.
NVIDIA_TESLA_V100	GPU Nvidia Tesla V100.
NVIDIA_TESLA_P4	GPU Nvidia Tesla P4.
NVIDIA_TESLA_T4	GPU Nvidia Tesla T4.
NVIDIA_TESLA_A100	GPU Nvidia Tesla A100.
TPU_V2	TPU v2.
TPU_V3	TPU v3.

VertexAIParameters

Paramètres utilisés dans les exécutions JobType Agent Platform.

Champs
network	string Nom complet du réseau Compute Engine auquel le job doit être appairé. Exemple :projects/12345/global/networks/myVPC Format est au format projects/{project}/global/networks/{network}. Où {project} est un numéro de projet, tel que 12345, et {network} est un nom de réseau. L'accès aux services privés doit déjà être configuré pour le réseau. Si le champ n'est pas spécifié, le job n'est appairé à aucun réseau.
env	map<string, string> Variables d'environnement. Vous pouvez spécifier au maximum 100 variables d'environnement uniques. Exemple : GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

Requête permettant d'obtenir un environnement de notebook.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/environments/{environment_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.environments.get

GetExecutionRequest

Requête pour obtenir l'exécution programmée d'un notebook

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/executions/{execution_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.executions.get

GetInstanceHealthRequest

Demande de vérification de l'état 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.getHealth

GetInstanceHealthResponse

Réponse pour vérifier si une instance de notebook est opérationnelle.

Champs
health_state	HealthState Uniquement en sortie. État de l'environnement d'exécution.
health_info	map<string, string> Uniquement en sortie. Informations supplémentaires sur l'état des instances. 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

Indique si une instance est opérationnelle ou non.

Enums
HEALTH_STATE_UNSPECIFIED	Le sous-état de l'instance est inconnu.
HEALTHY	L'instance est opérationnelle (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 ACTIF.
AGENT_NOT_INSTALLED	L'agent de surveillance de l'état n'est pas installé sur l'instance. S'applique à l'état ACTIVE.
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 ACTIVE.

GetInstanceRequest

Requête permettant d'obtenir 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

GetRuntimeRequest

Requête permettant d'obtenir un environnement d'exécution de notebook géré.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.runtimes.get

GetScheduleRequest

Requête pour obtenir un notebook programmé.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/schedules/{schedule_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.schedules.get

Instance

Définition d'une instance de notebook.

Champs
name	string Uniquement en sortie. Nom de cette instance de notebook. Format : projects/{project_id}/locations/{location}/instances/{instance_id}
post_startup_script	string Chemin d'accès à un script Bash qui s'exécute automatiquement après le démarrage complet d'une instance de notebook. Le chemin d'accès doit être une URL ou un chemin d'accès Cloud Storage (gs://path-to-file/file-name).
proxy_uri	string Uniquement en sortie. Point de terminaison du proxy utilisé pour accéder au notebook Jupyter.
instance_owners[]	string Uniquement en entrée. Propriétaire de cette instance après sa création. Format : [e-mail] Pour le moment, 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.
service_account	string Le compte de service de cette instance, qui donne accès à d'autres services Google Cloud. Vous pouvez utiliser n'importe quel compte de service au sein du même projet, mais vous devez disposer de l'autorisation "Utilisateur du compte de service" pour utiliser l'instance. S'il n'est pas spécifié, le compte de service Compute Engine par défaut est utilisé.
service_account_scopes[]	string Facultatif. URI des niveaux d'accès des comptes de service à inclure dans les instances Compute Engine. Si aucun n'est spécifié, les scopes suivants sont définis : - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email Si vous n'utilisez pas les scopes par défaut, vous devez au moins utiliser : https://www.googleapis.com/auth/compute
machine_type	string Obligatoire. Le type de machine Compute Engine de cette instance.
accelerator_config	AcceleratorConfig Accélérateur matériel utilisé 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 le machine_type que vous avez sélectionné.
state	State Uniquement en sortie. État de cette instance.
install_gpu_driver	bool Indique si l'utilisateur final autorise Google Cloud à installer le pilote de GPU sur cette instance. Si ce champ est vide ou défini sur "false", le pilote GPU ne sera pas installé. Applicable uniquement aux instances avec GPU.
custom_gpu_driver_path	string Spécifiez un chemin d'accès Cloud Storage personnalisé où le pilote GPU est stocké. Si vous n'indiquez aucune valeur, nous choisirons automatiquement parmi les pilotes de GPU officiels.
boot_disk_type	DiskType Uniquement en entrée. Type du disque de démarrage associé à cette instance. La valeur par défaut est "Disque persistant standard" (PD_STANDARD).
boot_disk_size_gb	int64 Uniquement en entrée. Taille en Go du disque de démarrage associé à cette instance, jusqu'à un maximum de 64 000 Go (64 To). La valeur minimale recommandée est de 100 Go. Si aucune valeur n'est spécifiée, la valeur par défaut est 100.
data_disk_type	DiskType Uniquement en entrée. Type de disque de données associé à cette instance. La valeur par défaut est "Disque persistant standard" (PD_STANDARD).
data_disk_size_gb	int64 Uniquement en entrée. Taille du disque de données en Go associé à cette instance, jusqu'à un maximum de 64 000 Go (64 To). Vous pouvez choisir la taille du disque de données en fonction de la taille de vos notebooks et de vos données. Si aucune valeur n'est spécifiée, la valeur par défaut est 100.
no_remove_data_disk	bool Uniquement en entrée. Si la valeur est "true", le disque de données ne sera pas supprimé automatiquement lors de la suppression de l'instance.
disk_encryption	DiskEncryption Uniquement en entrée. 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 Uniquement en entrée. 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
disks[]	Disk Uniquement en sortie. Disques associés à l'instance de notebook.
shielded_instance_config	ShieldedInstanceConfig Facultatif. Configuration de VM protégée. Images utilisant les fonctionnalités de VM protégée compatibles
no_public_ip	bool Si la valeur est "true", aucune adresse IP externe ne sera attribuée à cette instance.
no_proxy_access	bool Si la valeur est "true", l'instance de notebook ne s'enregistre pas auprès du proxy.
network	string Nom du VPC dans lequel se trouve cette instance. Format : projects/{project_id}/global/networks/{network_id}
subnet	string Nom du sous-réseau dans lequel se trouve cette instance. Format : projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
labels	map<string, string> Libellés à appliquer à cette instance. Vous pourrez les modifier ultérieurement à l'aide de la méthode setLabels.
metadata	map<string, string> Métadonnées personnalisées à appliquer à cette instance. Par exemple, pour spécifier un bucket Cloud Storage pour la sauvegarde automatique, vous pouvez utiliser le tag de métadonnées gcs-data-bucket. Format : "--metadata=gcs-data-bucket=BUCKET".
tags[]	string Facultatif. Tags réseau Compute Engine à ajouter au runtime (voir Ajouter des tags réseau).
upgrade_history[]	UpgradeHistoryEntry Historique des mises à niveau de cette instance.
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.
reservation_affinity	ReservationAffinity Facultatif. Affinité de réservation facultative. Si vous définissez ce champ, la réservation de calcul zonal spécifiée sera appliquée à cette instance de notebook.
creator	string Uniquement en sortie. Adresse e-mail de l'entité ayant envoyé la demande CreateInstance initiale.
can_ip_forward	bool Facultatif. Indique si le transfert IP est activé ou non. La valeur par défaut est "false" (désactivé). https://cloud.google.com/vpc/docs/using-routes#canipforward
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.
instance_migration_eligibility	InstanceMigrationEligibility Uniquement en sortie. Vérifie la faisabilité d'une migration d'UmN vers WbI.
Champ d'union environment. Type d'environnement : image de VM ou image de conteneur. environment ne peut être qu'un des éléments suivants :
vm_image	VmImage Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook.
container_image	ContainerImage Utilisez une image de conteneur pour démarrer l'instance de notebook.
migrated	bool Uniquement en sortie. Booléen indiquant si ce notebook a été migré vers une instance Workbench

AcceleratorConfig

Définition d'un accélérateur matériel. Notez que toutes les combinaisons de type et core_count ne sont pas valides. Consultez la page GPU sur Compute Engine pour trouver une combinaison valide. Les TPU ne sont pas compatibles.

Champs
type	AcceleratorType Type de cet accélérateur.
core_count	int64 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_K80	Le type d'accélérateur est Nvidia Tesla K80.
NVIDIA_TESLA_P100	Le type d'accélérateur est Nvidia Tesla P100.
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.
NVIDIA_L4	Le type d'accélérateur est Nvidia Tesla L4.
NVIDIA_A100_80GB	Le type d'accélérateur est Nvidia Tesla A100 80 Go.
NVIDIA_TESLA_T4_VWS	Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla T4".
NVIDIA_TESLA_P100_VWS	Le type d'accélérateur est "NVIDIA Tesla P100 Virtual Workstations".
NVIDIA_TESLA_P4_VWS	Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla P4".
NVIDIA_H100_80GB	Le type d'accélérateur est NVIDIA H100 80 Go.
NVIDIA_H100_MEGA_80GB	Le type d'accélérateur est NVIDIA H100 Mega 80 Go.
TPU_V2	(Bientôt disponible) Le type d'accélérateur est TPU V2.
TPU_V3	(Bientôt disponible) Le type d'accélérateur est TPU v3.

Disque

Ressource de disque associée à une instance.

Champs
auto_delete	bool Indique si le disque sera automatiquement supprimé lorsque l'instance sera supprimée (mais pas lorsque le disque sera déconnecté de l'instance).
boot	bool Indique qu'il s'agit d'un disque de démarrage. La machine virtuelle utilisera la première partition du disque pour son système de fichiers racine.
device_name	string Indique un nom d'appareil unique de votre choix. Celui-ci apparaît dans l'arborescence /dev/disk/by-id/google-* d'un système d'exploitation Linux exécutant l'instance. Ce nom peut être utilisé pour faire référence à l'appareil depuis l'instance au cours des processus de montage ou de redimensionnement, par exemple. Si vous n'en spécifiez pas, le serveur choisit un nom d'appareil par défaut qu'il appliquera à ce disque, sous la forme "persistent-disk-x", où x est un numéro attribué par Google Compute Engine.Ce champ ne s'applique qu'aux disques persistants.
disk_size_gb	int64 Indique la taille du disque en Go (base 2).
guest_os_features[]	GuestOsFeature Indique une liste de fonctionnalités à activer sur le système d'exploitation invité. Elle ne s'applique qu'aux images amorçables. Consultez la section "Activer des fonctionnalités d'un système d'exploitation invité" pour obtenir la liste des options disponibles.
index	int64 Index basé sur zéro de ce disque, où 0 est réservé au disque de démarrage. Si plusieurs disques sont associés à une instance, chacun d'eux possède un numéro d'index unique.
interface	string Indique l'interface de disque à utiliser pour associer ce disque (SCSI ou NVMe). La valeur par défaut est SCSI. Les disques persistants doivent toujours utiliser SCSI. La requête échouera si vous tentez d'associer un disque persistant dans un autre format que SCSI. Les disques SSD locaux peuvent utiliser NVMe ou SCSI. Pour connaître les caractéristiques de performances de SCSI sur NVMe, consultez "Performances des disques SSD locaux". Valeurs correctes : NVME SCSI
kind	string Type de la ressource. Calculez toujours compute#attachedDisk pour les disques associés.
licenses[]	string Liste des licences visibles publiquement. Réservé à l'usage de Google. Une licence représente les données de facturation et d'utilisation agrégées pour les images publiques et Marketplace.
mode	string Mode d'association de ce disque, READ_WRITE ou READ_ONLY. Si aucune valeur n'est spécifiée, le disque est associé en mode READ_WRITE par défaut. Valeurs correctes : READ_ONLY READ_WRITE
source	string Indique une URL partielle ou complète valide vers une ressource de disque persistant existante.
type	string Indique le type de disque (SCRATCH ou PERSISTENT). Valeurs correctes : PERSISTENT SCRATCH

GuestOsFeature

Fonctionnalités de l'OS invité pour le disque de démarrage.

Champs
type	string ID d'une fonctionnalité compatible. Consultez la section "Activer des fonctionnalités d'un système d'exploitation invité" pour obtenir la liste des options disponibles. Valeurs correctes : FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS

DiskEncryption

Définition des options de chiffrement de disque.

Enums
DISK_ENCRYPTION_UNSPECIFIED	Le chiffrement du 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 pour les instances de notebooks.

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.

NicType

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

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

ShieldedInstanceConfig

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

Champs
enable_secure_boot	bool Définit si le démarrage sécurisé est activé sur l'instance. 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 Définit si l'instance a activé le vTPM. Cette option est activée par défaut.
enable_integrity_monitoring	bool Définit si la surveillance de l'intégrité est activée pour l'instance. Permet la surveillance et l'attestation de l'intégrité du démarrage de l'instance. 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. Cette option est activée par défaut.

É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.
REGISTERING	L'instance est en cours d'enregistrement.
SUSPENDING	L'instance est en cours de suspension.
SUSPENDED	L'instance est suspendue.

UpgradeHistoryEntry

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

Champs
snapshot	string Instantané du disque de démarrage de cette instance de notebook avant la mise à niveau.
vm_image	string Image de VM avant la mise à niveau de cette instance.
container_image	string Image de conteneur avant la mise à niveau de cette instance.
framework	string Framework de cette instance de notebook.
version	string Version de l'instance de notebook avant cette mise à niveau.
state	State État de cette entrée de l'historique de mise à niveau de l'instance.
create_time	Timestamp Heure de création de cette entrée de l'historique de mise à niveau de l'instance.
target_image (deprecated)	string Cet élément est obsolète. Image de VM cible. Format : ainotebooks-vm/project/image-name/name.
action	Action Action. Effectuer un rollback ou une mise à niveau.
target_version	string 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	La mise à niveau de l'instance a échoué.

InstanceConfig

Configurations d'instance de notebook pouvant être mises à jour.

Champs
notebook_upgrade_schedule	string Expression Cron dans le fuseau horaire UTC, utilisée pour planifier la mise à niveau automatique de l'instance. Veuillez respecter le format cron.
enable_health_monitoring	bool Vérifiez que les services internes principaux sont en cours d'exécution.

InstanceMigrationEligibility

InstanceMigrationEligibility représente les informations sur la faisabilité d'une migration d'UmN vers WbI.

Champs
warnings[]	Warning Uniquement en sortie. Certaines configurations seront définies par défaut lors de la migration.
errors[]	Error Uniquement en sortie. Certaines configurations rendent l'UmN inéligible à la migration automatique. Une migration manuelle est requise.

Erreur

Un message d'erreur de migration signifie que certaines configurations rendent l'UmN inéligible à une migration automatique. Une migration manuelle est requise.

Enums
ERROR_UNSPECIFIED	Type par défaut.
DATAPROC_HUB	L'UmN utilise Dataproc Hub et ne peut pas être migré.

Avertissement

Un message d'avertissement de migration signifie que certaines configurations seront définies par défaut lors de la migration.

Enums
WARNING_UNSPECIFIED	Type par défaut.
UNSUPPORTED_MACHINE_TYPE	Le notebook géré par l'utilisateur utilise un type de machine non compatible avec les instances Workbench. Il sera migré avec le type de machine e2-standard-4 par défaut. Les utilisateurs peuvent modifier le type de machine après la migration.
UNSUPPORTED_ACCELERATOR_TYPE	L'UmN utilise un type d'accélérateur non compatible avec WbI. Il sera migré sans accélérateur. L'utilisateur peut associer un accélérateur après la migration.
UNSUPPORTED_OS	L'UmN utilise un système d'exploitation non compatible avec les instances Workbench (par exemple, Debian 10 ou Ubuntu). Il sera remplacé par Debian 11 dans WbI.
NO_REMOVE_DATA_DISK	Ce notebook est configuré avec no_remove_data_disk, qui n'est plus disponible dans WbI.
GCS_BACKUP	Ce notebook est configuré avec la fonctionnalité de sauvegarde Cloud Storage, qui n'est plus disponible dans les instances Workbench.
POST_STARTUP_SCRIPT	Cette UMN est configurée avec un script post-démarrage. Veuillez fournir le post_startup_script_option pour la migration (facultatif).

IsInstanceUpgradeableRequest

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
type	UpgradeType Facultatif. UpgradeType facultatif. Si vous définissez ce champ, d'autres images de calcul seront recherchées pour mettre à niveau cette instance.

IsInstanceUpgradeableResponse

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 n'est renseigné que si la valeur de "field upgradeable" est "true".
upgrade_info	string Informations supplémentaires sur la mise à niveau.
upgrade_image	string Nouveau lien vers l'image vers laquelle cette instance sera mise à niveau si le point de terminaison de mise à niveau est appelé. Ce champ n'est renseigné que si la valeur de "field upgradeable" est "true".

ListEnvironmentsRequest

Requête pour lister les environnements.

Champs
parent	string Obligatoire. Format : projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.environments.list
page_size	int32 Taille de retour maximale de l'appel de liste.
page_token	string Jeton de page renvoyé précédemment et pouvant être utilisé pour poursuivre la liste à partir du dernier résultat.

ListEnvironmentsResponse

Réponse pour la liste des environnements.

Champs
environments[]	Environment Liste des environnements renvoyés.
next_page_token	string Jeton de page pouvant être utilisé pour poursuivre la liste à partir du dernier résultat lors du prochain appel de liste.
unreachable[]	string Emplacements inaccessibles.

ListExecutionsRequest

Requête pour lister les exécutions de notebooks planifiées.

Champs
parent	string Obligatoire. Format : parent=projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.executions.list
page_size	int32 Taille de retour maximale de l'appel de liste.
page_token	string Jeton de page renvoyé précédemment et pouvant être utilisé pour poursuivre la liste à partir du dernier résultat.
filter	string Filtre appliqué aux exécutions résultantes. Actuellement, seule la filtration des exécutions par schedule_id spécifié est prise en charge. Format : schedule_id=<Schedule_ID>
order_by	string Trier par champ.

ListExecutionsResponse

Réponse pour la liste des exécutions de notebook planifiées

Champs
executions[]	Execution Liste des instances renvoyées.
next_page_token	string Jeton de page pouvant être utilisé pour continuer à lister à partir du dernier résultat lors du prochain appel de liste.
unreachable[]	string ID d'exécution inaccessibles. Exemple : ['projects/{project_id}/location/{location}/executions/imagenet_test1', 'projects/{project_id}/location/{location}/executions/classifier_train1']

ListInstancesRequest

Requête pour lister les instances de notebooks.

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.list
page_size	int32 Taille de retour maximale de l'appel de liste.
page_token	string Jeton de page renvoyé précédemment et pouvant être utilisé pour poursuivre la liste à 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 pouvant être utilisé pour continuer à lister à partir du dernier résultat lors du prochain appel de liste.
unreachable[]	string Emplacements inaccessibles. Par exemple, ['us-west1-a', 'us-central1-b']. Une réponse ListInstancesResponse ne contient que des instances ou des instances inaccessibles.

ListRuntimesRequest

Requête pour lister les environnements d'exécution de notebooks gérés.

Champs
parent	string Obligatoire. Format : parent=projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.runtimes.list
page_size	int32 Taille de retour maximale de l'appel de liste.
page_token	string Jeton de page renvoyé précédemment et pouvant être utilisé pour poursuivre la liste à 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.

ListRuntimesResponse

Réponse pour la liste des runtimes de notebooks gérés.

Champs
runtimes[]	Runtime Liste des environnements d'exécution renvoyés.
next_page_token	string Jeton de page pouvant être utilisé pour continuer à lister à partir du dernier résultat lors du prochain appel de liste.
unreachable[]	string Emplacements inaccessibles. Par exemple, ['us-west1', 'us-central1']. Une réponse ListRuntimesResponse ne contient que des runtimes ou des runtimes inaccessibles.

ListSchedulesRequest

Demande d'affichage d'une tâche de notebook planifiée.

Champs
parent	string Obligatoire. Format : parent=projects/{project_id}/locations/{location} L'autorisation IAM suivante est requise pour la ressource parent indiquée : notebooks.schedules.list
page_size	int32 Taille de retour maximale de l'appel de liste.
page_token	string Jeton de page renvoyé précédemment et pouvant être utilisé pour poursuivre la liste à partir du dernier résultat.
filter	string Filtre appliqué aux plannings obtenus.
order_by	string Champ selon lequel les résultats doivent être classés.

ListSchedulesResponse

Réponse pour lister les tâches de notebook planifiées.

Champs
schedules[]	Schedule Liste des instances renvoyées.
next_page_token	string Jeton de page pouvant être utilisé pour continuer à lister à partir du dernier résultat lors du prochain appel de liste.
unreachable[]	string Programmes inaccessibles. Exemple : ['projects/{project_id}/location/{location}/schedules/monthly_digest', 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']

LocalDisk

Ressource de disque local associé.

Champs
auto_delete	bool Facultatif. Uniquement en sortie. Spécifie si le disque sera automatiquement supprimé lorsque l'instance sera supprimée (mais pas lorsque le disque sera déconnecté de l'instance).
boot	bool Facultatif. Uniquement en sortie. Indique qu'il s'agit d'un disque de démarrage. La machine virtuelle utilisera la première partition du disque pour son système de fichiers racine.
device_name	string Facultatif. Uniquement en sortie. Spécifie un nom d'appareil unique de votre choix. Celui-ci apparaît dans l'arborescence /dev/disk/by-id/google-* d'un système d'exploitation Linux exécutant l'instance. Ce nom peut être utilisé pour faire référence à l'appareil depuis l'instance au cours des processus de montage ou de redimensionnement, par exemple. Si vous n'en spécifiez pas, le serveur choisit un nom d'appareil par défaut qu'il appliquera à ce disque, sous la forme "persistent-disk-x", où x est un numéro attribué par Google Compute Engine. Ce champ ne s'applique qu'aux disques persistants.
guest_os_features[]	RuntimeGuestOsFeature Uniquement en sortie. Indique une liste de fonctionnalités à activer sur le système d'exploitation invité. Elle ne s'applique qu'aux images amorçables. Consultez la section "Activer des fonctionnalités d'un système d'exploitation invité" pour obtenir la liste des options disponibles.
index	int32 Uniquement en sortie. Index basé sur zéro de ce disque, où 0 est réservé au disque de démarrage. Si plusieurs disques sont associés à une instance, chacun d'eux possède un numéro d'index unique.
initialize_params	LocalDiskInitializeParams Uniquement en entrée. Spécifie les paramètres d'un nouveau disque qui sera créé en même temps que la nouvelle instance. Utilisez des paramètres d'initialisation pour créer des disques de démarrage ou des disques SSD locaux associés à la nouvelle instance. Cette propriété s'exclut mutuellement avec la propriété source. Vous ne pouvez définir que l'une ou l'autre, mais pas les deux.
interface	string Spécifie l'interface de disque à utiliser pour associer ce disque (SCSI ou NVMe). La valeur par défaut est SCSI. Les disques persistants doivent toujours utiliser SCSI. La requête échouera si vous tentez d'associer un disque persistant dans un autre format que SCSI. Les disques SSD locaux peuvent utiliser NVMe ou SCSI. Pour connaître les caractéristiques de performances de SCSI sur NVMe, consultez "Performances des disques SSD locaux". Valeurs correctes : NVME SCSI
kind	string Uniquement en sortie. Type de la ressource. Calculez toujours compute#attachedDisk pour les disques associés.
licenses[]	string Uniquement en sortie. Toute licence valide et visible publiquement.
mode	string Mode d'association de ce disque, READ_WRITE ou READ_ONLY. Si aucune valeur n'est spécifiée, le disque est associé en mode READ_WRITE par défaut. Valeurs correctes : READ_ONLY READ_WRITE
source	string Spécifie une URL partielle ou complète valide vers une ressource de disque persistant existante.
type	string Spécifie le type de disque (SCRATCH ou PERSISTENT). Si aucune valeur n'est spécifiée, la valeur par défaut est PERSISTENT. Valeurs correctes : PERSISTENT SCRATCH

RuntimeGuestOsFeature

Facultatif. Liste des fonctionnalités à activer sur le système d'exploitation invité. Elle ne s'applique qu'aux images amorçables. Consultez Activer les fonctionnalités du système d'exploitation invité pour obtenir la liste des options disponibles. Fonctionnalités de l'OS invité pour le disque de démarrage.

Champs
type	string ID d'une fonctionnalité compatible. Consultez Activer les fonctionnalités du système d'exploitation invité pour obtenir la liste des options disponibles. Valeurs correctes : FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS

LocalDiskInitializeParams

Uniquement en entrée. Spécifie les paramètres d'un nouveau disque qui sera créé en même temps que la nouvelle instance. Utilisez des paramètres d'initialisation pour créer des disques de démarrage ou des disques SSD locaux associés au nouveau runtime. Cette propriété s'exclut mutuellement avec la propriété source. Vous ne pouvez définir que l'une ou l'autre, mais pas les deux.

Champs
description	string Facultatif. Fournissez cette propriété lors de la création du disque.
disk_name	string Facultatif. Spécifie le nom du disque. Si aucun nom n'est spécifié, le nom de l'instance est utilisé par défaut. Si le disque portant le nom de l'instance existe déjà dans la zone ou la région spécifiée, un nouveau nom sera généré automatiquement.
disk_size_gb	int64 Facultatif. Spécifie la taille du disque en Go (base 2). Si aucune taille n'est spécifiée, le disque aura la même taille que l'image (généralement 10 Go). Si elle est spécifiée, la taille doit être supérieure ou égale à 10 Go. 100 Go par défaut.
disk_type	DiskType Uniquement en entrée. Type du disque de démarrage associé à cette instance. La valeur par défaut est "Disque persistant standard" (PD_STANDARD).
labels	map<string, string> Facultatif. Libellés à appliquer à ce disque. Vous pourrez les modifier ultérieurement à l'aide de la méthode disks.setLabels. Ce champ ne s'applique qu'aux disques persistants.

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.

MigrateInstanceRequest

Demande de migration d'un notebook géré par l'utilisateur vers des instances Workbench.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id} Une ou plusieurs des autorisations IAMsuivantes sont requises pour la ressource name indiquée : notebooks.instances.get notebooks.instances.create
post_startup_script_option	PostStartupScriptOption Facultatif. Spécifie le comportement du script post-démarrage lors de la migration.

PostStartupScriptOption

Spécifie le comportement du script post-démarrage lors de la migration.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED	L'option de script post-démarrage n'est pas spécifiée. La valeur par défaut est POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP	Ne pas migrer le script de démarrage post-création vers la nouvelle instance Workbench.
POST_STARTUP_SCRIPT_OPTION_RERUN	Téléchargez de nouveau et réexécutez le même script post-démarrage que le notebook géré par l'utilisateur.

MigrateInstanceResponse

Ce type ne comporte aucun champ.

Type de réponse de message vide pour MigrateInstance.

MigrateRuntimeRequest

Demande de migration d'un environnement d'exécution vers une instance Workbench.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} Une ou plusieurs des autorisations IAMsuivantes sont requises pour la ressource name indiquée : notebooks.runtimes.get notebooks.instances.create
network	string Facultatif. Nom du VPC dans lequel se trouve la nouvelle instance. Ce champ est obligatoire si l'environnement d'exécution utilise un réseau géré par Google. Si le runtime utilise un réseau appartenant au client, il réutilisera le même VPC et ce champ doit être vide. Format : projects/{project_id}/global/networks/{network_id}
subnet	string Facultatif. Nom du sous-réseau dans lequel se trouve la nouvelle instance. Ce champ est obligatoire si l'environnement d'exécution utilise un réseau géré par Google. Si l'environnement d'exécution utilise un réseau appartenant au client, il réutilisera le même sous-réseau et ce champ doit être vide. Format : projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account	string Facultatif. Compte de service à inclure dans l'instance Compute Engine de la nouvelle instance Workbench lorsque le runtime utilise le mode "Un seul utilisateur" pour les autorisations. S'il n'est pas spécifié, le compte de service Compute Engine par défaut est utilisé. Lorsque le Runtime utilise le mode de compte de service pour les autorisations, il réutilise le même compte de service et ce champ doit être vide.
request_id	string Facultatif. UUID de la requête idempotente.
post_startup_script_option	PostStartupScriptOption Facultatif. Spécifie le comportement du script post-démarrage lors de la migration.

PostStartupScriptOption

Spécifie le comportement du script post-démarrage lors de la migration.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED	L'option de script post-démarrage n'est pas spécifiée. La valeur par défaut est POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP	Ne pas migrer le script de démarrage post-création vers la nouvelle instance Workbench.
POST_STARTUP_SCRIPT_OPTION_RERUN	Téléchargez de nouveau et réexécutez le même script post-démarrage que le notebook géré par Google.

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'opération a terminé son exécution.
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.

RegisterInstanceRequest

Demande d'enregistrement 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. ID unique défini par l'utilisateur pour cette instance. Le instance_id doit comporter entre 1 et 63 caractères, et ne peut contenir que des lettres minuscules, des chiffres et des tirets. Le premier caractère doit être une lettre minuscule et le dernier ne peut pas être un tiret.

ReportInstanceInfoRequest

Demande aux instances de notebooks de signaler des informations à l'API Notebooks.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/instances/{instance_id}
vm_id	string Obligatoire. Jeton matériel de la VM pour authentifier la VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata	map<string, string> Métadonnées signalées à l'API Notebooks. Il sera fusionné avec le magasin de métadonnées de l'instance.

ReportRuntimeEventRequest

Demande de signalement d'un événement lié à un notebook géré.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : iam.permissions.none
vm_id	string Obligatoire. Jeton matériel de la VM pour authentifier la VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event	Event Obligatoire. Événement à signaler.

ReservationAffinity

Affinité de réservation pour la consommation de la réservation zonale.

Champs
consume_reservation_type	Type Facultatif. Type de réservation à utiliser
key	string Facultatif. Correspond à la clé d'étiquette de la ressource de réservation.
values[]	string Facultatif. Correspond aux valeurs d'étiquette de la ressource de réservation.

Type

Indique s'il faut consommer de la capacité à partir d'une réservation ou non.

Enums
TYPE_UNSPECIFIED	Type par défaut.
NO_RESERVATION	Ne consommez aucune capacité allouée.
ANY_RESERVATION	Utiliser toute réservation disponible.
SPECIFIC_RESERVATION	Doit consommer à partir d'une réservation spécifique. Vous devez spécifier les champs de valeur clé pour indiquer les réservations.

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

ResetRuntimeRequest

Demande de réinitialisation d'un environnement d'exécution de notebook géré.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.runtimes.reset
request_id	string UUID de la requête idempotente.

RollbackInstanceRequest

Demande de rollback 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 : iam.permissions.none
target_snapshot	string Obligatoire. Instantané pour le rollback. Exemple : projects/test-project/global/snapshots/krwlzipynril.

Environnement d'exécution

Définition d'un environnement d'exécution pour une instance de notebooks gérés.

Champs
name	string Uniquement en sortie. Nom de ressource du runtime. Format : projects/{project}/locations/{location}/runtimes/{runtimeId}
state	State Uniquement en sortie. État de l'exécution.
health_state	HealthState Uniquement en sortie. État de l'environnement d'exécution.
access_config	RuntimeAccessConfig Paramètres de configuration pour accéder au runtime.
software_config	RuntimeSoftwareConfig Paramètres de configuration du logiciel dans l'environnement d'exécution.
metrics	RuntimeMetrics Uniquement en sortie. Contient les métriques du daemon d'exécution, telles que l'état du service et les statistiques JupyterLab.
create_time	Timestamp Uniquement en sortie. Heure de création de l'exécution.
update_time	Timestamp Uniquement en sortie. Heure de mise à jour de l'environnement d'exécution.
labels	map<string, string> Facultatif. Libellés à associer à ce notebook ou à cet environnement d'exécution géré. Les clés des libellés doivent comporter entre 1 et 63 caractères, et être conformes à la norme RFC 1035. Les valeurs des libellés peuvent être vides, mais, si elles sont présentes, elles doivent comporter entre 1 et 63 caractères et être conformes à la norme RFC 1035. Vous ne pouvez pas associer plus de 32 libellés à un cluster.
runtime_migration_eligibility	RuntimeMigrationEligibility Uniquement en sortie. Vérifie la faisabilité d'une migration de GmN vers WbI.
Champ d'union runtime_type. Type du runtime. Actuellement, seule la VM Compute Engine est acceptée. runtime_type ne peut être qu'un des éléments suivants :
virtual_machine	VirtualMachine Utilisez une image de VM Compute Engine pour démarrer l'instance de notebook gérée.
migrated	bool Uniquement en sortie. Booléen indiquant si ce notebook a été migré vers une instance Workbench

HealthState

Sous-état de l'exécution.

Enums
HEALTH_STATE_UNSPECIFIED	Le sous-état de l'environnement d'exécution est inconnu.
HEALTHY	L'environnement d'exécution est connu pour être dans un état sain (par exemple, les daemons critiques sont en cours d'exécution). S'applique à l'état ACTIVE.
UNHEALTHY	L'état du runtime est connu comme étant non opérationnel (par exemple, les daemons critiques ne sont pas en cours d'exécution). S'applique à l'état ACTIVE.
AGENT_NOT_INSTALLED	L'environnement d'exécution n'a pas installé l'agent de surveillance de l'état. S'applique à l'état ACTIVE.
AGENT_NOT_RUNNING	L'agent de surveillance de l'état de l'exécution n'est pas en cours d'exécution. S'applique à l'état ACTIVE.

État

Définition des états de ce runtime.

Enums
STATE_UNSPECIFIED	L'état n'est pas spécifié.
STARTING	La couche de calcul démarre le runtime. Il n'est pas prêt à être utilisé.
PROVISIONING	La couche de calcul installe les frameworks requis et enregistre le runtime auprès du proxy de notebook. Il ne peut pas être utilisé.
ACTIVE	Le runtime est en cours d'exécution. Il est prêt à être utilisé.
STOPPING	La logique de contrôle arrête l'exécution. Il ne peut pas être utilisé.
STOPPED	L'environnement d'exécution est arrêté. Il ne peut pas être utilisé.
DELETING	Le runtime est en cours de suppression. Il ne peut pas être utilisé.
UPGRADING	La mise à niveau du runtime est en cours. Il ne peut pas être utilisé.
INITIALIZING	L'environnement d'exécution est en cours de création et de configuration. Il n'est pas prêt à être utilisé.

RuntimeAcceleratorConfig

Définition des types d'accélérateurs matériels pouvant être utilisés. Consultez Compute Engine AcceleratorTypes. Exemples :

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

Champs
type	AcceleratorType Modèle d'accélérateur.
core_count	int64 Nombre de cœurs de cet accélérateur.

AcceleratorType

Type de cet accélérateur.

Enums
ACCELERATOR_TYPE_UNSPECIFIED	Le type d'accélérateur n'est pas spécifié.
NVIDIA_TESLA_K80	Le type d'accélérateur est Nvidia Tesla K80. Cet élément est obsolète.
NVIDIA_TESLA_P100	Le type d'accélérateur est Nvidia Tesla P100.
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_L4	Le type d'accélérateur est Nvidia L4.
TPU_V2	(Bientôt disponible) Le type d'accélérateur est TPU V2.
TPU_V3	(Bientôt disponible) Le type d'accélérateur est TPU v3.
NVIDIA_TESLA_T4_VWS	Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla T4".
NVIDIA_TESLA_P100_VWS	Le type d'accélérateur est "NVIDIA Tesla P100 Virtual Workstations".
NVIDIA_TESLA_P4_VWS	Le type d'accélérateur est "Postes de travail virtuels NVIDIA Tesla P4".

RuntimeAccessConfig

Spécifie la configuration de connexion pour Runtime

Champs
access_type	RuntimeAccessType Type de mode d'accès de cette instance.
runtime_owner	string Propriétaire de ce runtime après sa création. Format : [e-mail]. Pour le moment, un seul propriétaire est accepté.
proxy_uri	string Uniquement en sortie. Point de terminaison du proxy utilisé pour accéder au runtime.

RuntimeAccessType

Voici les différentes façons d'accéder à l'exécution. Mode d'authentification. Actuellement compatible avec le mode "Un seul utilisateur" uniquement.

Enums
RUNTIME_ACCESS_TYPE_UNSPECIFIED	Accès non spécifié.
SINGLE_USER	Connexion d'un seul utilisateur.
SERVICE_ACCOUNT	Mode Compte de service. En mode "Compte de service", le créateur de l'environnement d'exécution spécifie un compte de service existant dans le projet consommateur. Utiliser le champ "Compte de service d'exécution". Les utilisateurs qui accèdent au Runtime doivent disposer de l'autorisation ActAs (Utilisateur du compte de service).

RuntimeMetrics

Contient des métriques de démon d'exécution, telles que les statistiques sur l'OS, les noyaux et les sessions.

Champs
system_metrics	map<string, string> Uniquement en sortie. Métriques système.

RuntimeMigrationEligibility

RuntimeMigrationEligibility représente les informations sur la faisabilité d'une migration de GmN vers WbI.

Champs
warnings[]	Warning Uniquement en sortie. Certaines configurations seront définies par défaut lors de la migration.
errors[]	Error Uniquement en sortie. Certaines configurations rendent le compte GmN inéligible à la migration automatique. Une migration manuelle est requise.

Erreur

Un message d'erreur de migration signifie que certaines configurations rendent le GmN inéligible à une migration automatique. Une migration manuelle est requise.

Enums
ERROR_UNSPECIFIED	Type par défaut.
CUSTOM_CONTAINER	Le GmN est configuré avec un ou plusieurs conteneurs personnalisés et ne peut pas être migré.

Avertissement

Un message d'avertissement de migration signifie que certaines configurations seront définies par défaut lors de la migration.

Enums
WARNING_UNSPECIFIED	Type par défaut.
UNSUPPORTED_ACCELERATOR_TYPE	Le notebook GmN utilise un type d'accélérateur non compatible avec WbI. Il sera migré sans accélérateur. Les utilisateurs peuvent associer un accélérateur après la migration.
UNSUPPORTED_OS	Le GmN utilise un système d'exploitation non compatible avec WbI (par exemple, Debian 10). Il sera remplacé par Debian 11 dans WbI.
RESERVED_IP_RANGE	Ce notebook géré est configuré avec une plage d'adresses IP réservée, qui n'est plus applicable dans les instances Workbench.
GOOGLE_MANAGED_NETWORK	Ce GmN est configuré avec un réseau géré par Google. Veuillez fournir les options network et subnet pour la migration.
POST_STARTUP_SCRIPT	Ce GmN est configuré avec un script post-démarrage. Veuillez fournir le post_startup_script_option pour la migration (facultatif).
SINGLE_USER	Ce GmN est configuré en mode mono-utilisateur. Veuillez éventuellement fournir l'option service_account pour la migration.

RuntimeShieldedInstanceConfig

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

Champs
enable_secure_boot	bool Définit si le démarrage sécurisé est activé sur l'instance. 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 Définit si l'instance a activé le vTPM. Cette option est activée par défaut.
enable_integrity_monitoring	bool Définit si la surveillance de l'intégrité est activée pour l'instance. Permet la surveillance et l'attestation de l'intégrité du démarrage de l'instance. 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. Cette option est activée par défaut.

RuntimeSoftwareConfig

Spécifie la sélection et la configuration des logiciels dans l'environnement d'exécution. Propriétés à définir lors de l'exécution. Les clés de propriété sont spécifiées au format key:value, par exemple :

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

Champs
notebook_upgrade_schedule	string Expression Cron dans le fuseau horaire UTC, utilisée pour planifier la mise à niveau automatique de l'instance. Veuillez respecter le format cron.
idle_shutdown_timeout	int32 Temps d'attente en minutes avant l'arrêt de l'environnement d'exécution. Par défaut : 180 minutes
install_gpu_driver	bool Installez automatiquement le pilote Nvidia. Valeur par défaut : True
custom_gpu_driver_path	string Spécifiez un chemin d'accès Cloud Storage personnalisé où le pilote GPU est stocké. Si vous n'indiquez aucune valeur, nous choisirons automatiquement parmi les pilotes de GPU officiels.
post_startup_script	string Chemin d'accès à un script Bash qui s'exécute automatiquement après le démarrage complet d'une instance de notebook. Le chemin d'accès doit être une URL ou un chemin d'accès Cloud Storage (gs://path-to-file/file-name).
kernels[]	ContainerImage Facultatif. Utilisez une liste d'images de conteneurs à utiliser comme noyaux dans l'instance de notebook.
post_startup_script_behavior	PostStartupScriptBehavior Comportement du script post-démarrage.
enable_health_monitoring	bool Vérifiez que les services internes principaux sont en cours d'exécution. Valeur par défaut : True
idle_shutdown	bool L'environnement d'exécution s'arrête automatiquement après idle_shutdown_time. Valeur par défaut : True
upgradeable	bool Uniquement en sortie. Booléen indiquant si une image plus récente est disponible dans une famille d'images.
disable_terminal	bool Booléen indiquant si le terminal JupyterLab sera disponible ou non. Valeur par défaut : False
version	string Sortie uniquement. Version de l'image de démarrage, telle que M100, à partir du libellé de version de l'image.
mixer_disabled	bool Valeur booléenne indiquant si le client Mixer doit être désactivé. Valeur par défaut : False

PostStartupScriptBehavior

Comportement du script post-démarrage.

Enums
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED	Comportement du script post-démarrage non spécifié. S'exécutera une seule fois lors de la création.
RUN_EVERY_START	Exécute le script post-démarrage fourni lors de la création à chaque démarrage.
DOWNLOAD_AND_RUN_EVERY_START	Télécharge et exécute le script de post-démarrage fourni à chaque démarrage.

Programmation

Définition d'une programmation.

Champs
name	string Uniquement en sortie. Nom de cette programmation. Format : projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name	string Uniquement en sortie. Nom à afficher utilisé dans l'UI. Le nom ne peut contenir que des caractères alphanumériques, des traits d'union - et des traits de soulignement _.
description	string Brève description de cet environnement.
state	State
cron_schedule	string Planification au format Cron-tab selon laquelle le job sera exécuté. Format : minute, heure, jour du mois, mois, jour de la semaine, par exemple 0 0 * * WED = tous les mercredis. Autres exemples : https://crontab.guru/examples.html
time_zone	string Fuseau horaire sur lequel cron_schedule. La valeur de ce champ doit être un nom de fuseau horaire provenant de la base de données tz. Base de données TZ : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Notez que certains fuseaux horaires prévoient l'heure d'été. Les règles relatives à l'heure d'été sont déterminées par le fuseau horaire choisi. Pour UTC, utilisez la chaîne "utc". Si aucun fuseau horaire n'est spécifié, le fuseau horaire par défaut est UTC (également appelé GMT).
create_time	Timestamp Uniquement en sortie. Heure de création de la planification.
update_time	Timestamp Uniquement en sortie. Heure de la dernière mise à jour de la programmation.
execution_template	ExecutionTemplate Modèle d'exécution de notebook correspondant à ce programme.
recent_executions[]	Execution Uniquement en sortie. Les noms des exécutions les plus récentes déclenchées à partir de ce calendrier et leurs états correspondants.

État

État du job.

Enums
STATE_UNSPECIFIED	État non spécifié.
ENABLED	Le job s'exécute normalement.
PAUSED	Le job a été mis en veille par l'utilisateur. Il ne s'exécutera pas. Un utilisateur peut suspendre intentionnellement le job à l'aide de Cloud Scheduler.
DISABLED	Le job est désactivé par le système en raison d'une erreur. L'utilisateur ne peut pas désactiver directement un job.
UPDATE_FAILED	État du job résultant d'une opération CloudScheduler.UpdateJob ayant échoué. Pour restaurer un job depuis cet état, relancez l'CloudScheduler.UpdateJob jusqu'à ce qu'une réponse positive soit reçue.
INITIALIZING	La ressource de planification est en cours de création.
DELETING	La ressource de programmation est en cours de suppression.

SetInstanceAcceleratorRequest

Demande de configuration de l'accélérateur d'instance.

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.setAccelerator
type	AcceleratorType Obligatoire. Type de cet accélérateur.
core_count	int64 Obligatoire. Nombre de cœurs de cet accélérateur. Notez que toutes les combinaisons de type et core_count ne sont pas valides. Consultez la page GPU sur Compute Engine pour trouver une combinaison valide. Les TPU ne sont pas compatibles.

SetInstanceLabelsRequest

Demande de définition des libellés d'instance.

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.setLabels
labels	map<string, string> Libellés à appliquer à cette instance. Vous pourrez les modifier ultérieurement à l'aide de la méthode setLabels.

SetInstanceMachineTypeRequest

Demande de définition du type de machine de l'instance.

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.setMachineType
machine_type	string Obligatoire. Le type de machine Compute Engine.

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

StartRuntimeRequest

Requête permettant de démarrer un environnement d'exécution de notebooks gérés.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.runtimes.start
request_id	string UUID de la requête idempotente.

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

StopRuntimeRequest

Requête permettant d'arrêter un environnement d'exécution de notebook géré.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.runtimes.stop
request_id	string UUID de la requête idempotente.

SwitchRuntimeRequest

Demande de changement d'un environnement d'exécution de notebook géré.

Champs
name	string Obligatoire. Format : projects/{project_id}/locations/{location}/runtimes/{runtime_id} L'autorisation IAM suivante est requise pour la ressource name indiquée : notebooks.runtimes.switch
machine_type	string type de machine.
accelerator_config	RuntimeAcceleratorConfig configuration de l'accélérateur.
request_id	string UUID de la requête idempotente.

UpdateInstanceConfigRequest

Requête permettant de mettre à jour les configurations d'instance.

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.updateConfig
config	InstanceConfig Configurations d'instance à mettre à jour.

UpdateInstanceMetadataItemsRequest

Demande d'ajout ou de modification d'éléments de métadonnées pour une instance.

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.updateConfig
items	map<string, string> Éléments de métadonnées à ajouter ou à mettre à jour pour l'instance.

UpdateInstanceMetadataItemsResponse

Réponse pour l'ajout ou la modification d'éléments de métadonnées pour une instance.

Champs
items	map<string, string> Carte des éléments ajoutés ou mis à jour dans les métadonnées.

UpdateRuntimeRequest

Requête permettant de mettre à jour une configuration de notebook géré.

Champs
runtime	Runtime Obligatoire. Environnement d'exécution à mettre à jour. L'autorisation IAM suivante est requise pour la ressource runtime indiquée : notebooks.runtimes.update
update_mask	FieldMask Obligatoire. Spécifie le chemin d'accès du champ à mettre à jour, par rapport à Runtime. Par exemple, pour modifier les noyaux de configuration logicielle, le paramètre update_mask serait spécifié en tant que software_config.kernels et le corps de la requête PATCH spécifierait la nouvelle valeur comme suit : { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Actuellement, seuls les champs suivants peuvent être modifiés : 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 de la requête idempotente.

UpdateShieldedInstanceConfigRequest

Requête permettant de mettre à jour la configuration d'instance protégée pour une instance de notebook. Vous ne pouvez utiliser cette méthode que sur une instance arrêtée.

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.updateShieldInstanceConfig
shielded_instance_config	ShieldedInstanceConfig Configuration ShieldedInstance à mettre à jour.

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
type	UpgradeType Facultatif. UpgradeType facultatif. Si vous définissez ce champ, d'autres images de calcul seront recherchées pour mettre à niveau cette instance.

UpgradeType

Définition des types de mise à niveau pouvant être utilisés sur cette instance.

Enums
UPGRADE_TYPE_UNSPECIFIED	Le type de mise à niveau n'est pas spécifié.
UPGRADE_FRAMEWORK	Mettre à niveau le framework de ML.
UPGRADE_OS	Mettez à niveau le système d'exploitation.
UPGRADE_CUDA	Mettez à niveau CUDA.
UPGRADE_ALL	Mettez à niveau tous les éléments (OS, Framework et CUDA).

VirtualMachine

Environnement d'exécution utilisant une machine virtuelle pour le calcul.

Champs
instance_name	string Uniquement en sortie. Nom convivial de l'instance Compute Engine gérée.
instance_id	string Uniquement en sortie. Identifiant unique de l'instance Compute Engine gérée.
virtual_machine_config	VirtualMachineConfig Paramètres de configuration des machines virtuelles.

VirtualMachineConfig

Paramètres de configuration de la machine virtuelle.

Champs
zone	string Uniquement en sortie. Zone où se trouve la machine virtuelle. Si vous utilisez une requête régionale, le service Notebooks choisira un emplacement dans la région d'exécution correspondante. Lors d'une requête GET, la zone sera toujours présente. Exemple : * us-central1-b
machine_type	string Obligatoire. Type de machine Compute Engine utilisé pour les environnements d'exécution. Le nom court est valide. Exemples : * n1-standard-2 * e2-standard-8
container_images[]	ContainerImage Facultatif. Utilisez une liste d'images de conteneurs à utiliser comme noyaux dans l'instance de notebook.
data_disk	LocalDisk Obligatoire. Paramètres de configuration de l'option de disque de données.
encryption_config	EncryptionConfig Facultatif. Paramètres de chiffrement du disque de données de la machine virtuelle.
shielded_instance_config	RuntimeShieldedInstanceConfig Facultatif. Paramètres de configuration des instances de VM protégées.
accelerator_config	RuntimeAcceleratorConfig Facultatif. Configuration de l'accélérateur Compute Engine pour cet environnement d'exécution.
network	string Facultatif. Réseau Compute Engine à utiliser pour les communications entre les machines. Ne peut pas être spécifié avec un sous-réseau. Si ni network ni subnet ne sont spécifiés, le réseau "par défaut" du projet est utilisé, s'il existe. URL complète ou URI partiel. Exemples : https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default Les runtimes sont des ressources gérées dans l'infrastructure Google. Les environnements d'exécution sont compatibles avec les configurations réseau suivantes : Réseau géré par Google (le réseau et le sous-réseau sont vides) VPC du projet consommateur (réseau et sous-réseau obligatoires) Nécessite la configuration de l'accès privé aux services. VPC partagé (réseau et sous-réseau obligatoires). Nécessite la configuration de l'accès privé aux services.
subnet	string Facultatif. Sous-réseau Compute Engine à utiliser pour les communications entre les machines. Ne peut pas être spécifié avec le réseau. Une URL complète ou un URI partiel sont valides. Exemples : 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 Facultatif. Si la valeur est "true", le runtime ne disposera que d'adresses IP internes. Par défaut, les runtimes ne sont pas limités aux adresses IP internes et des adresses IP externes éphémères sont attribuées à chaque VM. Cette restriction internal_ip_only ne peut être activée que pour les réseaux compatibles avec les sous-réseaux, et toutes les dépendances doivent être configurées pour être accessibles sans adresses IP externes.
tags[]	string Facultatif. Tags réseau Compute Engine à ajouter au runtime (voir Ajouter des tags réseau).
guest_attributes	map<string, string> Uniquement en sortie. Attributs invité Compute Engine. (voir Attributs d'invité du projet et de l'instance).
metadata	map<string, string> Facultatif. Entrées de métadonnées Compute Engine à ajouter à la machine virtuelle. (voir Métadonnées du projet et de l'instance).
labels	map<string, string> Facultatif. Libellés à associer à ce runtime. Les clés des libellés doivent comporter entre 1 et 63 caractères, et être conformes à la norme RFC 1035. Les valeurs des libellés peuvent être vides, mais, si elles sont présentes, elles doivent comporter entre 1 et 63 caractères et être conformes à la norme RFC 1035. Vous ne pouvez pas associer plus de 32 libellés à un cluster.
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.
reserved_ip_range	string Facultatif. Le nom de la plage d'adresses IP réservée est utilisé pour l'appairage de VPC. L'allocation de sous-réseau utilisera le nom de la plage si celui-ci est attribué. Exemple : 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 La valeur du champ sera : managed-notebooks-range-c
boot_image	BootImage Facultatif. Métadonnées de l'image de démarrage utilisées pour la mise à niveau de l'environnement d'exécution.

BootImage

Ce type ne comporte aucun champ.

Définition de l'image de démarrage utilisée par l'environnement d'exécution. Utilisé pour faciliter la mise à niveau de l'environnement d'exécution.

NicType

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

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

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}
Champ d'union image. Référence à une image de VM Compute Engine externe. image ne peut être qu'un des éléments suivants :
image_name	string Utilisez le nom de l'image de VM pour la trouver.
image_family	string Utilisez cette famille d'images de VM pour trouver l'image. La dernière image de cette famille sera utilisée.