Package google.cloud.notebooks.v1

Índice

ManagedNotebookService

Es la API v1 del servicio de Notebooks administrados.

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

Crea un nuevo entorno de ejecución en un proyecto y una ubicación determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
DeleteRuntime

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

Borra un solo entorno de ejecución.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
GetRuntime

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

Obtiene detalles de un solo entorno de ejecución. La ubicación debe ser un extremo regional, no zonal.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ListRuntimes

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

Enumera los tiempos de ejecución en una ubicación y un proyecto determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
MigrateRuntime

rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation)

Migra un entorno de ejecución existente a una instancia nueva de Workbench.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ReportRuntimeEvent

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

Informa y procesa un evento del entorno de ejecución.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ResetRuntime

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

Restablece un entorno de ejecución de notebook administrado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
StartRuntime

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

Inicia un entorno de ejecución de notebook administrado. Realiza la acción "Iniciar" en las instancias de GPU y "Reanudar" en las instancias de CPU. Consulta: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
StopRuntime

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

Detiene un entorno de ejecución de notebook administrado. Realiza la acción "Detener" en las instancias de GPU y "Suspender" en las instancias de CPU. Consulta: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
SwitchRuntime

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

Cambia un entorno de ejecución de notebook administrado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
UpdateRuntime

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

Actualiza la configuración del entorno de ejecución del notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

NotebookService

Es la API de servicio v1 para Cloud AI Platform Notebooks.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

Crea un entorno nuevo.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
CreateExecution

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

Crea una nueva ejecución en un proyecto y una ubicación determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Crea una instancia nueva en un proyecto y una ubicación determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
CreateSchedule

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

Crea un nuevo notebook programado en un proyecto y una ubicación determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
DeleteEnvironment

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

Borra un solo entorno.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
DeleteExecution

rpc DeleteExecution(DeleteExecutionRequest) returns (Operation)

Borra la ejecución

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Borra una sola instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
DeleteSchedule

rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation)

Borra la programación y todos los trabajos subyacentes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

Crea un archivo de diagnóstico y ejecuta la herramienta de diagnóstico para una instancia determinada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
GetEnvironment

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

Obtiene detalles de un solo entorno.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
GetExecution

rpc GetExecution(GetExecutionRequest) returns (Execution)

Obtiene detalles de las ejecuciones

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Obtiene detalles de una sola instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
GetInstanceHealth

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

Verifica si una instancia de notebook está en buen estado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
GetSchedule

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

Obtiene detalles de la programación

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
IsInstanceUpgradeable

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

Comprueba si una instancia de notebook se puede actualizar.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ListEnvironments

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

Enumera los entornos de un proyecto.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ListExecutions

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

Enumera las ejecuciones en una ubicación y un proyecto determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Enumera las instancias en una ubicación y un proyecto determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ListSchedules

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

Enumera las programaciones en una ubicación y un proyecto determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
MigrateInstance

rpc MigrateInstance(MigrateInstanceRequest) returns (Operation)

Migra un notebook administrado por el usuario existente a instancias de Workbench.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
RegisterInstance

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

Registra una instancia de notebook heredada existente en el servidor de la API de Notebooks. Las instancias heredadas son instancias creadas con las llamadas heredadas de Compute Engine. No se pueden administrar con la API de Notebooks de forma predeterminada. Esta llamada hace que la API de Notebooks pueda administrar estas instancias.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ReportInstanceInfo

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

Permite que las instancias de notebook informen su información más reciente al servidor de la API de Notebooks. El servidor combinará la información informada en el almacén de metadatos de la instancia. No uses este método directamente.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Restablece una instancia de notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

Revierte una instancia de notebook a la versión anterior.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
SetInstanceAccelerator

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

Actualiza los aceleradores de invitado de una sola instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
SetInstanceLabels

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

Reemplaza todas las etiquetas de una instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
SetInstanceMachineType

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation)

Actualiza el tipo de máquina de una sola instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Inicia una instancia de notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Detiene una instancia de notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
UpdateInstanceConfig

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

Se actualizó la configuración de las instancias de notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
UpdateInstanceMetadataItems

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

Agrega o actualiza elementos de metadatos para una instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
UpdateShieldedInstanceConfig

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

Actualiza la configuración de instancia protegida de una sola instancia.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

Actualiza una instancia de notebook a la versión más reciente.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

ContainerImage

Es la definición de una imagen de contenedor para iniciar una instancia de notebook con el entorno instalado en un contenedor.

Campos
repository

string

Obligatorio. Es la ruta de acceso al repositorio de imágenes de contenedor. Por ejemplo: gcr.io/{project_id}/{image_name}.
tag

string

Es la etiqueta de la imagen del contenedor. Si no se especifica, el valor predeterminado es la etiqueta más reciente.

CreateEnvironmentRequest

Es una solicitud para crear un entorno de notebook.

Campos
parent

string

Obligatorio. Formato: projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.environments.create
environment_id

string

Obligatorio. Es el ID único definido por el usuario de este entorno. El parámetro environment_id debe tener entre 1 y 63 caracteres, y contener solo letras minúsculas, caracteres numéricos y guiones. El primer carácter debe ser una letra minúscula y el último no puede ser un guion.
environment

Environment

Obligatorio. Es el entorno que se creará.

CreateExecutionRequest

Solicitud para crear la ejecución del notebook

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.executions.create
execution_id

string

Obligatorio. Es el ID único definido por el usuario de esta ejecución.
execution

Execution

Obligatorio. Es la ejecución que se creará.

CreateInstanceRequest

Es una solicitud para crear una instancia de notebook.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.instances.create
instance_id

string

Obligatorio. Es el ID único definido por el usuario de esta instancia.
instance

Instance

Obligatorio. Es la instancia que se creará.

CreateRuntimeRequest

Es una solicitud para crear un tiempo de ejecución de notebook administrado.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.runtimes.create
runtime_id

string

Obligatorio. Es el ID único definido por el usuario de este entorno de ejecución.
runtime

Runtime

Obligatorio. Es el entorno de ejecución que se creará.
request_id

string

Es el UUID de la solicitud idempotente.

CreateScheduleRequest

Solicitud de notebooks programados creados

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.schedules.create
schedule_id

string

Obligatorio. Es el ID único definido por el usuario de esta programación.
schedule

Schedule

Obligatorio. Es la programación que se creará.

DeleteEnvironmentRequest

Es una solicitud para borrar un entorno de notebook.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/environments/{environment_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.environments.delete

DeleteExecutionRequest

Solicitud para borrar la ejecución programada de un notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/executions/{execution_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.executions.delete

DeleteInstanceRequest

Es una solicitud para borrar una instancia de notebook.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.delete

DeleteRuntimeRequest

Es una solicitud para borrar un entorno de ejecución de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.runtimes.delete
request_id

string

Es el UUID de la solicitud idempotente.

DeleteScheduleRequest

Solicitud para borrar una programación

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/schedules/{schedule_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.schedules.delete

DiagnoseInstanceRequest

Es una solicitud para crear un archivo de diagnóstico de la instancia de notebook.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}
diagnostic_config

DiagnosticConfig

Obligatorio. Define marcas que se usan para ejecutar la herramienta de diagnóstico
timeout_minutes

int32

Es opcional. Es la cantidad máxima de tiempo en minutos antes de que se agote el tiempo de espera de la operación.

DiagnosticConfig

Define marcas que se usan para ejecutar la herramienta de diagnóstico

Campos
gcs_bucket

string

Obligatorio. Ubicación del bucket de Cloud Storage del usuario (OBLIGATORIO). Debe tener el formato con el prefijo de ruta (gs://$GCS_BUCKET).

Permisos: Notebooks administrados por el usuario: - storage.buckets.writer: Se debe otorgar a la cuenta de servicio del proyecto conectada a la VM. Notebooks administrados por Google: - storage.buckets.writer: Se debe otorgar a la cuenta de servicio del proyecto o a las credenciales de usuario adjuntas a la VM, según el modo de autenticación.

El archivo de registro del bucket de Cloud Storage se escribirá en gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

Es opcional. Define la ruta de almacenamiento relativa en el bucket de Cloud Storage en el que se escribirán los registros de diagnóstico. La ruta predeterminada será el directorio raíz del bucket de Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Ejemplo de ruta completa en la que se escribirá el archivo de registro: gs://$GCS_BUCKET/$RELATIVE_PATH/
repair_flag_enabled

bool

Es opcional. Habilita la marca para reparar el servicio de la instancia
packet_capture_flag_enabled

bool

Es opcional. Habilita la marca para capturar paquetes de la instancia durante 30 segundos.
copy_home_files_flag_enabled

bool

Es opcional. Habilita la marca para copiar todo el contenido de la carpeta /home/jupyter.

EncryptionConfig

Representa una configuración de clave de encriptación personalizada que se puede aplicar a un recurso. Esto encriptará todos los discos de la máquina virtual.

Campos
kms_key

string

Es el identificador de recurso de Cloud KMS de la clave de encriptación administrada por el cliente que se usa para proteger un recurso, como un disco. Tiene el siguiente formato: projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

Entorno

Es la definición de un entorno de software que se usa para iniciar una instancia de notebook.

Campos
name

string

Solo salida. Nombre de este entorno. Formato: projects/{project_id}/locations/{location}/environments/{environment_id}
display_name

string

Es el nombre visible de este entorno para la IU.
description

string

Es una breve descripción de este entorno.
post_startup_script

string

Ruta de acceso a una secuencia de comandos de Bash que se ejecuta automáticamente después de que se inicia por completo una instancia de notebook. La ruta de acceso debe ser una URL o una ruta de Cloud Storage. Ejemplo: "gs://path-to-file/file-name"
create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó este entorno.
Campo de unión image_type. Tipo de entorno. Puede ser una imagen de VM o una imagen de contenedor. image_type puede ser solo uno de los parámetros siguientes:
vm_image

VmImage

Usa una imagen de VM de Compute Engine para iniciar la instancia del notebook.
container_image

ContainerImage

Usa una imagen de contenedor para iniciar la instancia del notebook.

Evento

Es la definición de un evento para una instancia de notebook administrada o parcialmente administrada.

Campos
report_time

Timestamp

Es la fecha y hora del informe del evento.
type

EventType

Es el tipo de evento.
details

map<string, string>

Es opcional. Son los detalles del evento. Este campo se usa para pasar información del evento.

EventType

Es la definición de los tipos de eventos.

Enums
EVENT_TYPE_UNSPECIFIED No se especificó el evento.
IDLE La instancia o el entorno de ejecución están inactivos
HEARTBEAT El tiempo de ejecución o la instancia están disponibles. Este evento indica que el tiempo de ejecución o la instancia de procesamiento subyacente están operativos.
HEALTH El estado de la instancia o del tiempo de ejecución está disponible. Este evento indica información sobre el estado del entorno de ejecución o de la instancia.
MAINTENANCE El tiempo de ejecución o la instancia están disponibles. Este evento permite que la instancia o el entorno de ejecución envíen información de mantenimiento del host al plano de control. https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

Ejecución

Es la definición de un solo notebook ejecutado.

Campos
execution_template

ExecutionTemplate

Metadatos de ejecución, incluidos el nombre, las especificaciones de hardware, la región, las etiquetas, etcétera
name

string

Solo salida. Es el nombre del recurso de la ejecución. Formato: projects/{project_id}/locations/{location}/executions/{execution_id}
display_name

string

Solo salida. Es el nombre que se usa para la IU. El nombre solo puede contener caracteres alfanuméricos y guiones bajos "_".
description

string

Es una breve descripción de esta ejecución.
create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó la instancia de Execution.
update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó la ejecución por última vez.
state

State

Solo salida. Es el estado del trabajo subyacente de AI Platform.
output_notebook_file

string

Archivo de notebook de salida generado por esta ejecución
job_uri

string

Solo salida. Es el URI del trabajo externo que se usó para ejecutar el notebook.

Estado

Es la descripción del enum del estado del trabajo subyacente de la AIP.

Enums
STATE_UNSPECIFIED El estado del trabajo no está especificado.
QUEUED Se acaba de crear el trabajo y aún no se ha iniciado el procesamiento.
PREPARING El servicio se está preparando para ejecutar el trabajo.
RUNNING El trabajo está en ejecución.
SUCCEEDED El trabajo se completó de forma correcta.
FAILED El trabajo falló. error_message debe contener los detalles de la falla.
CANCELLING Se cancelará el trabajo. error_message debe describir el motivo de la cancelación.
CANCELLED El trabajo se canceló. error_message debe describir el motivo de la cancelación.
EXPIRED El trabajo venció (relevante para los trabajos de Vertex AI)
INITIALIZING Se está creando la ejecución.

ExecutionTemplate

Es la descripción de una carga de trabajo de ejecución de notebook.

Campos
scale_tier
(deprecated)

ScaleTier

Obligatorio. Es el nivel de escala del hardware que se usa para la ejecución del notebook. DEPRECATED Se descontinuará. Por el momento, solo se admite CUSTOM.
master_type

string

Especifica el tipo de máquina virtual que se usará para el trabajador principal del trabajo de entrenamiento. Debes especificar este campo cuando scaleTier está configurado como CUSTOM.

Puedes usar ciertos tipos de máquinas de Compute Engine directamente en este campo. Se admiten los siguientes tipos:

  • 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

Como alternativa, puedes usar los siguientes tipos de máquinas heredadas:

  • 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

Por último, si deseas usar una TPU para el entrenamiento, especifica cloud_tpu en este campo. Obtén más información sobre las opciones de configuración especiales para el entrenamiento con TPU.
accelerator_config

SchedulerAcceleratorConfig

Es la configuración (recuento y tipo de acelerador) del hardware que ejecuta el notebook.
labels

map<string, string>

Son las etiquetas de ejecución. Si la ejecución está programada, se incluirá el campo "nbs-scheduled". De lo contrario, se trata de una ejecución inmediata y el campo incluido será "nbs-immediate". Usa campos para indexar de manera eficiente entre varios tipos de ejecuciones.
input_notebook_file

string

Es la ruta de acceso al archivo del notebook que se ejecutará. Debe estar en un bucket de Google Cloud Storage. Formato: gs://{bucket_name}/{folder}/{notebook_file_name}, p. ej., gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
container_image_uri

string

URI de imagen de contenedor para un ejemplo de DLVM: "gcr.io/deeplearning-platform-release/base-cu100". Puedes encontrar más ejemplos en: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
output_notebook_folder

string

Ruta de acceso a la carpeta del notebook en la que se escribirá. Debe estar en la ruta de acceso de un bucket de Google Cloud Storage. Formato: gs://{bucket_name}/{folder}, p. ej., gs://notebook_user/scheduled_notebooks
params_yaml_file

string

Son los parámetros que se anularán en el notebook durante la ejecución. Consulta https://papermill.readthedocs.io/en/latest/usage-parameterize.html para obtener información sobre cómo especificar parámetros en el notebook de entrada y pasarlos aquí en un archivo YAML. Ej.: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

Son los parámetros que se usan en el notebook "input_notebook_file".
service_account

string

Es la dirección de correo electrónico de una cuenta de servicio que se usará cuando se ejecute la ejecución. Debes tener el permiso iam.serviceAccounts.actAs para la cuenta de servicio especificada.
job_type

JobType

Es el tipo de trabajo que se usará en esta ejecución.
kernel_spec

string

Nombre de la especificación del kernel que se usará. Se debe especificar si el nombre de especificación del kernel en el destino de ejecución no coincide con el nombre en el archivo de notebook de entrada.
tensorboard

string

Es el nombre de un recurso de [Tensorboard] de Vertex AI al que esta ejecución subirá registros de Tensorboard. Formato: projects/{project}/locations/{location}/tensorboards/{tensorboard}
Campo de unión job_parameters. Son los parámetros de un tipo de ejecución. NOTA: Actualmente, no hay parámetros adicionales para los trabajos de Vertex AI. job_parameters puede ser solo uno de los parámetros siguientes:
dataproc_parameters

DataprocParameters

Son los parámetros que se usan en las ejecuciones de JobType de Dataproc.
vertex_ai_parameters

VertexAIParameters

Son los parámetros que se usan en las ejecuciones de JobType de Vertex AI.

DataprocParameters

Son los parámetros que se usan en las ejecuciones de JobType de Dataproc.

Campos
cluster

string

Es el URI del clúster que se usa para ejecutar la ejecución de Dataproc. Formato: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

Es el backend que se usó para esta ejecución.

Enums
JOB_TYPE_UNSPECIFIED No se especificó ningún tipo.
VERTEX_AI Trabajo personalizado en aiplatform.googleapis.com. Es el valor predeterminado para una ejecución.
DATAPROC Ejecuta la ejecución en un clúster con Dataproc como trabajo. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

Obligatorio. Especifica los tipos de máquinas, la cantidad de réplicas para los trabajadores y los servidores de parámetros.

Enums
SCALE_TIER_UNSPECIFIED Es el nivel de la escala sin especificar.
BASIC Una sola instancia de trabajador. Este nivel es adecuado para aprender a usar Cloud ML y experimentar con modelos nuevos mediante conjuntos de datos pequeños.
STANDARD_1 Muchos trabajadores y algunos servidores de parámetros.
PREMIUM_1 Una gran cantidad de trabajadores con muchos servidores de parámetros.
BASIC_GPU Una sola instancia de trabajador con una GPU K80.
BASIC_TPU Una sola instancia de trabajador con una Cloud TPU.
CUSTOM

El nivel CUSTOM no es un nivel establecido, sino que te permite usar tu propia especificación de clúster. Cuando usas este nivel, establece valores para configurar tu clúster de procesamiento según estos lineamientos:

  • Debes configurar ExecutionTemplate.masterType a fin de especificar el tipo de máquina que usarás para el nodo principal. Esta es la única configuración obligatoria.

SchedulerAcceleratorConfig

Es la definición de un acelerador de hardware. Ten en cuenta que no todas las combinaciones de type y core_count son válidas. Consulta GPU en Compute Engine para encontrar una combinación válida. Las TPU no son compatibles.

Campos
type

SchedulerAcceleratorType

Es el tipo de acelerador.
core_count

int64

Es la cantidad de núcleos de este acelerador.

SchedulerAcceleratorType

Son los tipos de aceleradores de hardware para los trabajos de AI Platform Training.

Enums
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED Tipo de acelerador no especificado. Sin GPU según la configuración predeterminada
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

Son los parámetros que se usan en las ejecuciones de JobType de Vertex AI.

Campos
network

string

Nombre completo de la red de Compute Engine con la que el trabajo debe intercambiar tráfico. Por ejemplo, projects/12345/global/networks/myVPC Format tiene el formato projects/{project}/global/networks/{network}. En el ejemplo anterior, {project} es un número de proyecto, como en 12345, y {network} es un nombre de red.

El acceso privado a servicios ya debe estar configurado para la red. Si no se especifica, el trabajo no intercambia tráfico con ninguna red.
env

map<string, string>

Variables de entorno Se pueden especificar hasta 100 variables de entorno únicas. Ejemplo: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

Es una solicitud para obtener un entorno de notebook.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/environments/{environment_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.environments.get

GetExecutionRequest

Solicitud para obtener la ejecución programada de un notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/executions/{execution_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.executions.get

GetInstanceHealthRequest

Es una solicitud para verificar si una instancia de notebook está en buen estado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.getHealth

GetInstanceHealthResponse

Es la respuesta para verificar si una instancia de notebook está en buen estado.

Campos
health_state

HealthState

Solo salida. Es el estado de salud del entorno de ejecución.
health_info

map<string, string>

Solo salida. Es información adicional sobre el estado de la instancia. 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

Indica si una instancia está en buen estado o no.

Enums
HEALTH_STATE_UNSPECIFIED Se desconoce el subestado de la instancia.
HEALTHY Se sabe que la instancia está en buen estado (por ejemplo, los daemons críticos se están ejecutando). Se aplica al estado ACTIVE.
UNHEALTHY Se sabe que la instancia está en mal estado (por ejemplo, no se están ejecutando los daemons críticos). Se aplica al estado ACTIVE.
AGENT_NOT_INSTALLED La instancia no tiene instalado el agente de supervisión de estado. Se aplica al estado ACTIVE.
AGENT_NOT_RUNNING El agente de supervisión del estado de la instancia no se está ejecutando. Se aplica al estado ACTIVE.

GetInstanceRequest

Es una solicitud para obtener una instancia de notebook.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.get

GetRuntimeRequest

Es una solicitud para obtener un tiempo de ejecución de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.runtimes.get

GetScheduleRequest

Es una solicitud para obtener un notebook programado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/schedules/{schedule_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.schedules.get

Instancia

Es la definición de una instancia de notebook.

Campos
name

string

Solo salida. Es el nombre de esta instancia de notebook. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}
post_startup_script

string

Ruta de acceso a una secuencia de comandos de Bash que se ejecuta automáticamente después de que se inicia por completo una instancia de notebook. La ruta de acceso debe ser una URL o una ruta de Cloud Storage (gs://path-to-file/file-name).
proxy_uri

string

Solo salida. Es el extremo del proxy que se usa para acceder al notebook de Jupyter.
instance_owners[]

string

Solo entrada. Es el propietario de esta instancia después de la creación. Formato: alias@example.com

Actualmente, solo admite un propietario. Si no se especifica, todos los usuarios de la cuenta de servicio de la instancia de VM pueden usar la instancia.
service_account

string

La cuenta de servicio en esta instancia, que otorga acceso a otros servicios de Google Cloud. Puedes usar cualquier cuenta de servicio en el mismo proyecto, pero debes tener el permiso de usuario de la cuenta de servicio para usar la instancia.

Si no se especifica, se usa la cuenta de servicio predeterminada de Compute Engine.
service_account_scopes[]

string

Es opcional. Son los URIs de los permisos de acceso de la cuenta de servicio que se incluirán en las instancias de Compute Engine.

Si no se especifican, se definen los siguientes permisos: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email Si no usas los permisos predeterminados, necesitas al menos: https://www.googleapis.com/auth/compute
machine_type

string

Obligatorio. Es el tipo de máquina de Compute Engine de esta instancia.
accelerator_config

AcceleratorConfig

Es el acelerador de hardware que se usa en esta instancia. Si usas aceleradores, asegúrate de que tu configuración tenga suficientes CPU virtuales y memoria para admitir el machine_type que seleccionaste.
state

State

Solo salida. Es el estado de esta instancia.
install_gpu_driver

bool

Indica si el usuario final autoriza a Google Cloud a instalar el controlador de GPU en esta instancia. Si este campo está vacío o se establece como falso, no se instalará el controlador de GPU. Solo se aplica a instancias con GPUs.
custom_gpu_driver_path

string

Especifica una ruta de acceso personalizada de Cloud Storage en la que se almacena el controlador de GPU. Si no se especifica, elegiremos automáticamente entre los controladores oficiales de la GPU.
boot_disk_type

DiskType

Solo entrada. Tipo de disco de arranque conectado a esta instancia. El valor predeterminado es disco persistente estándar (PD_STANDARD).
boot_disk_size_gb

int64

Solo entrada. Tamaño del disco de arranque en GB conectado a esta instancia, hasta un máximo de 64,000 GB (64 TB). El valor mínimo recomendado es de 100 GB. Si no se especifica, el valor predeterminado es 100.
data_disk_type

DiskType

Solo entrada. Es el tipo de disco de datos conectado a esta instancia. El valor predeterminado es disco persistente estándar (PD_STANDARD).
data_disk_size_gb

int64

Solo entrada. Tamaño del disco de datos en GB conectado a esta instancia, hasta un máximo de 64,000 GB (64 TB). Puedes elegir el tamaño del disco de datos según el tamaño de tus notebooks y datos. Si no se especifica, el valor predeterminado es 100.
no_remove_data_disk

bool

Solo entrada. Si es verdadero, el disco de datos no se borrará automáticamente cuando se borre la instancia.
disk_encryption

DiskEncryption

Solo entrada. Es el método de encriptación de disco que se usa en los discos de arranque y de datos. El valor predeterminado es GMEK.
kms_key

string

Solo entrada. Es la clave de KMS que se usa para encriptar los discos. Solo se aplica si disk_encryption es CMEK. Formato: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Obtén más información para usar tus propias claves de encriptación.
disks[]

Disk

Solo salida. Son los discos conectados a la instancia de notebook.
shielded_instance_config

ShieldedInstanceConfig

Es opcional. Configuración de VM protegida. Imágenes que usan funciones compatibles de VM protegida
no_public_ip

bool

Si es verdadero, no se asignará ninguna IP externa a esta instancia.
no_proxy_access

bool

Si es verdadero, la instancia del notebook no se registrará en el proxy.
network

string

Es el nombre de la VPC en la que se encuentra esta instancia. Formato: projects/{project_id}/global/networks/{network_id}
subnet

string

Es el nombre de la subred en la que se encuentra esta instancia. Formato: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
labels

map<string, string>

Son las etiquetas que se aplicarán a esta instancia. Estos se pueden modificar más adelante con el método setLabels.
metadata

map<string, string>

Son los metadatos personalizados que se aplicarán a esta instancia. Por ejemplo, para especificar un bucket de Cloud Storage para la copia de seguridad automática, puedes usar la etiqueta de metadatos gcs-data-bucket. Formato: "--metadata=gcs-data-bucket=BUCKET".
tags[]

string

Es opcional. Son las etiquetas de red de Compute Engine que se agregarán en el tiempo de ejecución (consulta Agrega etiquetas de red).
upgrade_history[]

UpgradeHistoryEntry

Es el historial de actualizaciones de esta instancia.
nic_type

NicType

Es opcional. Es el tipo de vNIC que se usará en esta interfaz. Puede ser gVNIC o VirtioNet.
reservation_affinity

ReservationAffinity

Es opcional. Es la afinidad de reserva opcional. Si configuras este campo, se aplicará la reserva de procesamiento zonal especificada a esta instancia de notebook.
creator

string

Solo salida. Es la dirección de correo electrónico de la entidad que envió la solicitud original de CreateInstance.
can_ip_forward

bool

Es opcional. Es una marca para habilitar o no el reenvío de IP. El valor predeterminado es falso o desactivado. https://cloud.google.com/vpc/docs/using-routes#canipforward
create_time

Timestamp

Solo salida. Es la hora de creación de la instancia.
update_time

Timestamp

Solo salida. Es la fecha y hora de actualización de la instancia.
instance_migration_eligibility

InstanceMigrationEligibility

Solo salida. Verifica qué tan factible es una migración de UmN a WbI.
Campo de unión environment. Tipo de entorno. Puede ser una imagen de VM o una imagen de contenedor. environment puede ser solo uno de los parámetros siguientes:
vm_image

VmImage

Usa una imagen de VM de Compute Engine para iniciar la instancia del notebook.
container_image

ContainerImage

Usa una imagen de contenedor para iniciar la instancia del notebook.
migrated

bool

Solo salida. Es un valor booleano que indica si este notebook se migró a una instancia de Workbench.

AcceleratorConfig

Es la definición de un acelerador de hardware. Ten en cuenta que no todas las combinaciones de type y core_count son válidas. Consulta GPU en Compute Engine para encontrar una combinación válida. Las TPU no son compatibles.

Campos
type

AcceleratorType

Es el tipo de acelerador.
core_count

int64

Es la cantidad de núcleos de este acelerador.

AcceleratorType

Es la definición de los tipos de aceleradores de hardware que se pueden usar en esta instancia.

Enums
ACCELERATOR_TYPE_UNSPECIFIED No se especificó el tipo de acelerador.
NVIDIA_TESLA_K80 El tipo de acelerador es Nvidia Tesla K80.
NVIDIA_TESLA_P100 El tipo de acelerador es Nvidia Tesla P100.
NVIDIA_TESLA_V100 El tipo de acelerador es Nvidia Tesla V100.
NVIDIA_TESLA_P4 El tipo de acelerador es Nvidia Tesla P4.
NVIDIA_TESLA_T4 El tipo de acelerador es Nvidia Tesla T4.
NVIDIA_TESLA_A100 El tipo de acelerador es Nvidia Tesla A100.
NVIDIA_L4 El tipo de acelerador es Nvidia Tesla L4.
NVIDIA_A100_80GB El tipo de acelerador es Nvidia Tesla A100 de 80 GB.
NVIDIA_TESLA_T4_VWS El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla T4.
NVIDIA_TESLA_P100_VWS El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P100.
NVIDIA_TESLA_P4_VWS El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P4.
NVIDIA_H100_80GB El tipo de acelerador es NVIDIA H100 de 80 GB.
NVIDIA_H100_MEGA_80GB El tipo de acelerador es NVIDIA H100 Mega de 80 GB.
TPU_V2 (Próximamente) El tipo de acelerador es TPU V2.
TPU_V3 (Próximamente) El tipo de acelerador es TPU V3.

Disco

Es un recurso de disco conectado a una instancia.

Campos
auto_delete

bool

Indica si el disco se borrará automáticamente cuando se borre la instancia (pero no cuando se separe el disco de la instancia).
boot

bool

Indica que este es un disco de arranque. La máquina virtual usará la primera partición del disco para su sistema de archivos raíz.
device_name

string

Indica un nombre de dispositivo único de tu elección que se refleja en el árbol /dev/disk/by-id/google-* de un sistema operativo Linux que se ejecuta dentro de la instancia. Este nombre se puede usar para hacer referencia al dispositivo a fin de activar, cambiar el tamaño, etc., desde la instancia.

Si no se especifica, el servidor elige un nombre de dispositivo predeterminado para aplicar a este disco, con el formato persistent-disk-x, en el que x es un número asignado por Google Compute Engine.Este campo solo se aplica a los discos persistentes.
disk_size_gb

int64

Indica el tamaño del disco en GB base 2.
guest_os_features[]

GuestOsFeature

Indica una lista de funciones para habilitar en el sistema operativo invitado. Solo se aplica a imágenes de arranque. Consulta Habilita las funciones del sistema operativo invitado para ver una lista de las opciones disponibles.
index

int64

Es un índice basado en cero para este disco, en el que el 0 está reservado para el disco de arranque. Si tienes muchos discos conectados a una instancia, cada uno tendrá un número de índice único.
interface

string

Indica la interfaz de disco que se usará para conectar este disco, que puede ser SCSI o NVMe. El valor predeterminado es SCSI. Los discos persistentes siempre deben usar SCSI, y la solicitud fallará si intentas adjuntar un disco persistente en cualquier otro formato que no sea SCSI. Las SSD locales pueden usar NVMe o SCSI. Para conocer las características de rendimiento de SCSI a través de NVMe, consulta Rendimiento de SSD locales. Valores válidos:

  • NVME
  • SCSI
kind

string

Tipo de recurso. Siempre calcula#attachedDisk para los discos conectados.
licenses[]

string

Es una lista de licencias visibles públicamente. Reservado para el uso de Google. Una licencia representa los datos de facturación y de uso agregados para las imágenes públicas y de Marketplace.
mode

string

Es el modo en el que se conectará este disco, ya sea READ_WRITE o READ_ONLY. Si no se especifica, la opción predeterminada es adjuntar el disco en modo READ_WRITE. Valores válidos:

  • READ_ONLY
  • READ_WRITE
source

string

Indica una URL parcial o completa válida para un recurso de Persistent Disk existente.
type

string

Indica el tipo de disco, ya sea SCRATCH o PERSISTENT. Valores válidos:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

Son las funciones del SO invitado para el disco de arranque.

Campos
type

string

Es el ID de una función admitida. Consulta Habilita las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. Valores válidos:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

DiskEncryption

Es la definición de las opciones de encriptación de disco.

Enums
DISK_ENCRYPTION_UNSPECIFIED No se especificó la encriptación de disco.
GMEK Usa claves de encriptación administradas por Google para encriptar el disco de arranque.
CMEK Usa claves de encriptación administradas por el cliente para encriptar el disco de arranque.

DiskType

Son los tipos de discos posibles para las instancias de notebook.

Enums
DISK_TYPE_UNSPECIFIED No se estableció el tipo de disco.
PD_STANDARD Es el tipo de disco persistente estándar.
PD_SSD Es el tipo de disco persistente SSD.
PD_BALANCED Es el tipo de disco persistente balanceado.
PD_EXTREME Es el tipo de disco persistente extremo.

NicType

Es el tipo de controlador de la NIC virtual. El valor predeterminado debe ser UNSPECIFIED_NIC_TYPE.

Enums
UNSPECIFIED_NIC_TYPE No se especificó ningún tipo.
VIRTIO_NET VIRTIO
GVNIC GVNIC

ShieldedInstanceConfig

Es un conjunto de opciones de instancias protegidas. Consulta Imágenes que usan funciones compatibles de VM protegida. No todas las combinaciones son válidas.

Campos
enable_secure_boot

bool

Define si la instancia tiene habilitado el inicio seguro.

El arranque seguro ayuda a garantizar que el sistema solo ejecute software auténtico a través de la verificación de la firma digital de todos los componentes del inicio y la detención del proceso de inicio si falla la verificación de la firma. Está inhabilitado de forma predeterminada.
enable_vtpm

bool

Define si la instancia tiene habilitado el vTPM. Habilitada de forma predeterminada.
enable_integrity_monitoring

bool

Define si la instancia tiene habilitada la supervisión de integridad.

Habilita la supervisión y la certificación de la integridad del inicio de la instancia. La certificación se realiza en función del modelo de referencia de la política de integridad. Este valor de referencia se deriva inicialmente de la imagen de arranque de confianza implícita cuando se crea la instancia. Habilitada de forma predeterminada.

Estado

Es la definición de los estados de esta instancia.

Enums
STATE_UNSPECIFIED No se especifica el estado.
STARTING La lógica de control está iniciando la instancia.
PROVISIONING La lógica de control instala los frameworks requeridos y registra la instancia con el proxy de notebook.
ACTIVE Indica que la instancia está en ejecución.
STOPPING La lógica de control está deteniendo la instancia.
STOPPED Se detuvo la instancia.
DELETED Se borró la instancia.
UPGRADING La instancia se está actualizando.
INITIALIZING Se está creando la instancia.
REGISTERING Se está registrando la instancia.
SUSPENDING La instancia se está suspendiendo.
SUSPENDED La instancia está suspendida.

UpgradeHistoryEntry

Es la entrada del historial de actualización de la imagen de VM.

Campos
snapshot

string

Es la instantánea del disco de arranque de esta instancia de notebook antes de la actualización.
vm_image

string

Es la imagen de la VM antes de la actualización de esta instancia.
container_image

string

Es la imagen del contenedor antes de la actualización de la instancia.
framework

string

Es el framework de esta instancia de notebook.
version

string

Es la versión de la instancia de notebook anterior a esta actualización.
state

State

Es el estado de esta entrada del historial de actualizaciones de instancias.
create_time

Timestamp

Es la fecha y hora en que se creó esta entrada del historial de actualizaciones de la instancia.
target_image
(deprecated)

string

Es la imagen de VM de destino. Formato: ainotebooks-vm/project/image-name/name.
action

Action

Acción. Revertir o actualizar
target_version

string

Versión de la VM de destino, como m63.

Acción

Es la definición de las operaciones de esta entrada del historial de actualización.

Enums
ACTION_UNSPECIFIED No se especificó la operación.
UPGRADE Actualiza.
ROLLBACK Es una reversión.

Estado

Es la definición de los estados de esta entrada del historial de actualización.

Enums
STATE_UNSPECIFIED No se especifica el estado.
STARTED Se inició la actualización de la instancia.
SUCCEEDED La actualización de la instancia se completó correctamente.
FAILED No se pudo actualizar la instancia.

InstanceConfig

Son los parámetros de configuración de la instancia de notebook que se pueden actualizar.

Campos
notebook_upgrade_schedule

string

Es una expresión cron en la zona horaria UTC que se usa para programar la actualización automática de la instancia. Sigue el formato cron.
enable_health_monitoring

bool

Verifica que los servicios internos principales estén en ejecución.

InstanceMigrationEligibility

InstanceMigrationEligibility representa la información de viabilidad de una migración de UmN a WbI.

Campos
warnings[]

Warning

Solo salida. Durante la migración, se establecerán ciertos parámetros de configuración de forma predeterminada.
errors[]

Error

Solo salida. Algunos parámetros de configuración hacen que la UmN no sea apta para una migración automática. Se requiere una migración manual.

Error

Un mensaje de error de migración significa que ciertos parámetros de configuración hacen que UmN no sea apto para una migración automática. Se requiere una migración manual.

Enums
ERROR_UNSPECIFIED Es el tipo predeterminado.
DATAPROC_HUB El UmN usa Dataproc Hub y no se puede migrar.

Advertencia

Un mensaje de advertencia de migración significa que ciertos parámetros de configuración se establecerán de forma predeterminada durante la migración.

Enums
WARNING_UNSPECIFIED Es el tipo predeterminado.
UNSUPPORTED_MACHINE_TYPE La UmN usa un tipo de máquina que no es compatible con WbI. Se migrará con el tipo de máquina predeterminado e2-standard-4. Los usuarios pueden cambiar el tipo de máquina después de la migración.
UNSUPPORTED_ACCELERATOR_TYPE El UmN usa un tipo de acelerador que no se admite en WbI. Se migrará sin un acelerador. El usuario puede adjuntar un acelerador después de la migración.
UNSUPPORTED_OS La UmN usa un sistema operativo que no es compatible con la WbI (p.ej., Debian 10, Ubuntu). Se reemplazará por Debian 11 en WbI.
NO_REMOVE_DATA_DISK Este UmN se configuró con no_remove_data_disk, que ya no está disponible en WbI.
GCS_BACKUP Este UmN se configuró con la función de copia de seguridad de Cloud Storage, que ya no está disponible en WbI.
POST_STARTUP_SCRIPT Este UmN está configurado con una secuencia de comandos posterior al inicio. De manera opcional, proporciona el post_startup_script_option para la migración.

IsInstanceUpgradeableRequest

Es una solicitud para verificar si una instancia de notebook se puede actualizar.

Campos
notebook_instance

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado notebookInstance:

  • notebooks.instances.checkUpgradability
type

UpgradeType

Es opcional. Es el UpgradeType opcional. Si configuras este campo, se buscarán imágenes de procesamiento adicionales para actualizar esta instancia.

IsInstanceUpgradeableResponse

Es la respuesta para verificar si una instancia de notebook se puede actualizar.

Campos
upgradeable

bool

Indica si una instancia se puede actualizar.
upgrade_version

string

Es la versión a la que se actualizará esta instancia si se llama al extremo de actualización. Este campo solo se completará si field upgradeable es verdadero.
upgrade_info

string

Es información adicional sobre la actualización.
upgrade_image

string

Es el vínculo propio de la imagen nueva a la que se actualizará esta instancia si se llama al extremo de actualización. Este campo solo se completará si field upgradeable es verdadero.

ListEnvironmentsRequest

Es una solicitud para enumerar entornos.

Campos
parent

string

Obligatorio. Formato: projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.environments.list
page_size

int32

Es el tamaño máximo de devolución de la llamada de lista.
page_token

string

Es un token de página devuelto anteriormente que se puede usar para continuar la lista desde el último resultado.

ListEnvironmentsResponse

Es la respuesta para enumerar los entornos.

Campos
environments[]

Environment

Es una lista de los entornos devueltos.
next_page_token

string

Es un token de página que se puede usar para continuar la lista desde el último resultado en la siguiente llamada a la lista.
unreachable[]

string

Ubicaciones a las que no se pudo llegar.

ListExecutionsRequest

Es una solicitud para enumerar las ejecuciones programadas de notebooks.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.executions.list
page_size

int32

Es el tamaño máximo de devolución de la llamada de lista.
page_token

string

Es un token de página devuelto anteriormente que se puede usar para continuar la lista desde el último resultado.
filter

string

Es el filtro que se aplica a las ejecuciones resultantes. Actualmente, solo se admite el filtrado de ejecuciones por un schedule_id especificado. Formato: schedule_id=<Schedule_ID>
order_by

string

Es el campo por el que se ordena.

ListExecutionsResponse

Es la respuesta para enumerar las ejecuciones programadas de notebooks.

Campos
executions[]

Execution

Es una lista de instancias devueltas.
next_page_token

string

Es un token de página que se puede usar para continuar la lista desde el último resultado en la siguiente llamada a la lista.
unreachable[]

string

Son los IDs de las ejecuciones a las que no se pudo acceder. Por ejemplo:

['projects/{project_id}/location/{location}/executions/imagenet_test1',
 'projects/{project_id}/location/{location}/executions/classifier_train1']

ListInstancesRequest

Es una solicitud para enumerar instancias de notebooks.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.instances.list
page_size

int32

Es el tamaño máximo de devolución de la llamada de lista.
page_token

string

Es un token de página devuelto anteriormente que se puede usar para continuar la lista desde el último resultado.
order_by

string

Es opcional. Ordena resultados. Los valores admitidos son “name”, “name desc” o “” (sin orden).
filter

string

Es opcional. Es un filtro de lista.

ListInstancesResponse

Es la respuesta para enumerar instancias de notebooks.

Campos
instances[]

Instance

Es una lista de instancias devueltas.
next_page_token

string

Es un token de página que se puede usar para continuar la lista desde el último resultado en la siguiente llamada a la lista.
unreachable[]

string

Ubicaciones a las que no se pudo llegar. Por ejemplo, ['us-west1-a', 'us-central1-b']. Un ListInstancesResponse solo contendrá instancias o elementos no accesibles.

ListRuntimesRequest

Es una solicitud para enumerar los entornos de ejecución de notebooks administrados.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.runtimes.list
page_size

int32

Es el tamaño máximo de devolución de la llamada de lista.
page_token

string

Es un token de página devuelto anteriormente que se puede usar para continuar la lista desde el último resultado.
order_by

string

Es opcional. Ordena resultados. Los valores admitidos son “name”, “name desc” o “” (sin orden).
filter

string

Es opcional. Es un filtro de lista.

ListRuntimesResponse

Es la respuesta para enumerar los entornos de ejecución de Notebook administrado.

Campos
runtimes[]

Runtime

Es una lista de tiempos de ejecución devueltos.
next_page_token

string

Es un token de página que se puede usar para continuar la lista desde el último resultado en la siguiente llamada a la lista.
unreachable[]

string

Ubicaciones a las que no se pudo llegar. Por ejemplo, ['us-west1', 'us-central1']. Una respuesta ListRuntimesResponse solo contendrá tiempos de ejecución o elementos no accesibles.

ListSchedulesRequest

Es una solicitud para enumerar el trabajo programado del notebook.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.schedules.list
page_size

int32

Es el tamaño máximo de devolución de la llamada de lista.
page_token

string

Es un token de página devuelto anteriormente que se puede usar para continuar la lista desde el último resultado.
filter

string

Es el filtro que se aplica a los programas resultantes.
order_by

string

Es el campo según el cual se ordenan los resultados.

ListSchedulesResponse

Es la respuesta para enumerar los trabajos programados de notebooks.

Campos
schedules[]

Schedule

Es una lista de instancias devueltas.
next_page_token

string

Es un token de página que se puede usar para continuar la lista desde el último resultado en la siguiente llamada a la lista.
unreachable[]

string

Programaciones a las que no se pudo llegar. Por ejemplo:

['projects/{project_id}/location/{location}/schedules/monthly_digest',
 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']

LocalDisk

Es un recurso de disco local conectado.

Campos
auto_delete

bool

Es opcional. Solo salida. Especifica si el disco se borrará automáticamente cuando se borre la instancia (pero no cuando se separe el disco de la instancia).
boot

bool

Es opcional. Solo salida. Indica que este es un disco de arranque. La máquina virtual usará la primera partición del disco para su sistema de archivos raíz.
device_name

string

Es opcional. Solo salida. Especifica un nombre de dispositivo único de tu elección que se refleje en el árbol /dev/disk/by-id/google-* de un sistema operativo Linux que se ejecuta dentro de la instancia. Este nombre se puede usar para hacer referencia al dispositivo a fin de activar, cambiar el tamaño, etc., desde la instancia.

Si no se especifica, el servidor elige un nombre de dispositivo predeterminado para aplicar a este disco, con el formato persistent-disk-x, en el que x es un número asignado por Google Compute Engine. Este campo solo se aplica a los discos persistentes.
guest_os_features[]

RuntimeGuestOsFeature

Solo salida. Indica una lista de funciones para habilitar en el sistema operativo invitado. Solo se aplica a imágenes de arranque. Consulta Habilita las funciones del sistema operativo invitado para ver una lista de las opciones disponibles.
index

int32

Solo salida. Es un índice basado en cero para este disco, en el que el 0 está reservado para el disco de arranque. Si tienes muchos discos conectados a una instancia, cada uno tendrá un número de índice único.
initialize_params

LocalDiskInitializeParams

Solo entrada. Especifica los parámetros de un disco nuevo que se creará junto con la instancia nueva. Usa parámetros de inicialización para crear discos de arranque o SSD locales conectados a la instancia nueva.

Esta propiedad es mutuamente exclusiva con la propiedad fuente. Solo puedes definir una u otra, pero no ambas.
interface

string

Especifica la interfaz de disco que se usará para conectar este disco, que puede ser SCSI o NVMe. El valor predeterminado es SCSI. Los discos persistentes siempre deben usar SCSI, y la solicitud fallará si intentas adjuntar un disco persistente en cualquier otro formato que no sea SCSI. Las SSD locales pueden usar NVMe o SCSI. Para conocer las características de rendimiento de SCSI a través de NVMe, consulta Rendimiento de SSD locales. Valores válidos:

  • NVME
  • SCSI
kind

string

Solo salida. Tipo de recurso. Siempre calcula#attachedDisk para los discos conectados.
licenses[]

string

Solo salida. Cualquier licencia válida visible públicamente.
mode

string

Es el modo en el que se conectará este disco, ya sea READ_WRITE o READ_ONLY. Si no se especifica, la opción predeterminada es adjuntar el disco en modo READ_WRITE. Valores válidos:

  • READ_ONLY
  • READ_WRITE
source

string

Especifica una URL parcial o completa válida para un recurso de Persistent Disk existente.
type

string

Especifica el tipo de disco, ya sea SCRATCH o PERSISTENT. Si no se especifica, el valor predeterminado es PERSISTENT. Valores válidos:

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

Es opcional. Es una lista de funciones que se habilitarán en el sistema operativo invitado. Solo se aplica a imágenes de arranque. Lee Cómo habilitar las funciones del sistema operativo invitado para ver una lista de las opciones disponibles. Son las funciones del SO invitado para el disco de arranque.

Campos
type

string

Es el ID de una función admitida. Lee Cómo habilitar las funciones del sistema operativo invitado para ver una lista de las opciones disponibles.

Valores válidos:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

LocalDiskInitializeParams

Solo entrada. Especifica los parámetros de un disco nuevo que se creará junto con la instancia nueva. Usa parámetros de inicialización para crear discos de arranque o SSD locales conectados al nuevo entorno de ejecución. Esta propiedad es mutuamente exclusiva con la propiedad fuente. Solo puedes definir una u otra, pero no ambas.

Campos
description

string

Es opcional. Proporciona esta propiedad cuando crees el disco.
disk_name

string

Es opcional. Especifica el nombre del disco. Si no se especifica, el valor predeterminado es usar el nombre de la instancia. Si el disco con el nombre de la instancia ya existe en la zona o región determinada, se generará automáticamente un nombre nuevo.
disk_size_gb

int64

Es opcional. Especifica el tamaño del disco en GB en base 2. Si no se especifica, el disco tendrá el mismo tamaño que la imagen (por lo general, 10 GB). Si se especifica, el tamaño debe ser igual o mayor que 10 GB. El valor predeterminado es 100 GB.
disk_type

DiskType

Solo entrada. Tipo de disco de arranque conectado a esta instancia. El valor predeterminado es disco persistente estándar (PD_STANDARD).
labels

map<string, string>

Es opcional. Son las etiquetas que se aplicarán a este disco. Los discos pueden modificar estos parámetros más adelante con el método disks.setLabels. Este campo solo se aplica a los discos persistentes.

DiskType

Son los tipos de discos posibles.

Enums
DISK_TYPE_UNSPECIFIED No se estableció el tipo de disco.
PD_STANDARD Es el tipo de disco persistente estándar.
PD_SSD Es el tipo de disco persistente SSD.
PD_BALANCED Es el tipo de disco persistente balanceado.
PD_EXTREME Es el tipo de disco persistente extremo.

MigrateInstanceRequest

Solicitud para migrar un notebook administrado por el usuario a instancias de Workbench

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere uno o más de los siguientes permisos de IAM en el recurso name especificado:

  • notebooks.instances.get
  • notebooks.instances.create
post_startup_script_option

PostStartupScriptOption

Es opcional. Especifica el comportamiento de la secuencia de comandos de inicio posterior durante la migración.

PostStartupScriptOption

Especifica el comportamiento de la secuencia de comandos de inicio posterior durante la migración.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED No se especificó la opción de secuencia de comandos posterior al inicio. El valor predeterminado es POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP No migrar la secuencia de comandos posterior al inicio a la nueva instancia de Workbench
POST_STARTUP_SCRIPT_OPTION_RERUN Vuelve a descargar y ejecutar la misma secuencia de comandos de inicio que el notebook administrado por el usuario.

MigrateInstanceResponse

Este tipo no tiene campos.

Es el tipo de respuesta de mensaje en blanco para MigrateInstance.

MigrateRuntimeRequest

Es una solicitud para migrar un entorno de ejecución a una instancia de Workbench.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere uno o más de los siguientes permisos de IAM en el recurso name especificado:

  • notebooks.runtimes.get
  • notebooks.instances.create
network

string

Es opcional. Es el nombre de la VPC en la que se encuentra la instancia nueva. Esto es obligatorio si el entorno de ejecución usa una red administrada por Google. Si el entorno de ejecución usa una red propiedad del cliente, reutilizará la misma VPC, y este campo debe estar vacío. Formato: projects/{project_id}/global/networks/{network_id}
subnet

string

Es opcional. Nombre de la subred en la que se encuentra la instancia nueva. Esto es obligatorio si el entorno de ejecución usa una red administrada por Google. Si el entorno de ejecución usa una red propiedad del cliente, reutilizará la misma subred y este campo debe estar vacío. Formato: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account

string

Es opcional. Es la cuenta de servicio que se incluirá en la instancia de Compute Engine de la nueva instancia de Workbench cuando el tiempo de ejecución use el modo "solo usuario único" para el permiso. Si no se especifica, se usa la cuenta de servicio predeterminada de Compute Engine. Cuando el entorno de ejecución usa el modo de cuenta de servicio para el permiso, reutilizará la misma cuenta de servicio, y este campo debe estar vacío.
request_id

string

Es opcional. Es el UUID de la solicitud idempotente.
post_startup_script_option

PostStartupScriptOption

Es opcional. Especifica el comportamiento de la secuencia de comandos de inicio posterior durante la migración.

PostStartupScriptOption

Especifica el comportamiento de la secuencia de comandos de inicio posterior durante la migración.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED No se especificó la opción de secuencia de comandos posterior al inicio. El valor predeterminado es POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP No migrar la secuencia de comandos posterior al inicio a la nueva instancia de Workbench
POST_STARTUP_SCRIPT_OPTION_RERUN Vuelve a descargar y a ejecutar la misma secuencia de comandos de inicio que el notebook administrado por Google.

OperationMetadata

Representa los metadatos de la operación de larga duración.

Campos
create_time

Timestamp

Es la fecha y hora en que se creó la operación.
end_time

Timestamp

Es la hora a la que finalizó la operación.
target

string

Es la ruta de acceso al recurso definida por el servidor para el destino de la operación.
verb

string

Es el nombre del verbo que ejecuta la operación.
status_message

string

Estado legible de la operación, si lo hay.
requested_cancellation

bool

Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron de forma correcta tienen el valor google.longrunning.Operation.error con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.
api_version

string

Es la versión de la API que se usó para iniciar la operación.
endpoint

string

Nombre del extremo de API de esta operación.

RegisterInstanceRequest

Es una solicitud para registrar una instancia de notebook.

Campos
parent

string

Obligatorio. Formato: parent=projects/{project_id}/locations/{location}

La autorización requiere el siguiente permiso de IAM en el recurso especificado parent:

  • notebooks.instances.create
instance_id

string

Obligatorio. Es el ID único definido por el usuario de esta instancia. El parámetro instance_id debe tener entre 1 y 63 caracteres, y contener solo letras minúsculas, caracteres numéricos y guiones. El primer carácter debe ser una letra minúscula y el último no puede ser un guion.

ReportInstanceInfoRequest

Es una solicitud para que las instancias de notebook informen información a la API de Notebooks.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}
vm_id

string

Obligatorio. Es el token de hardware de la VM para autenticarla. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata

map<string, string>

Son los metadatos que se informan a la API de Notebooks. Se combinará con el almacén de metadatos de la instancia.

ReportRuntimeEventRequest

Es una solicitud para informar un evento de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • iam.permissions.none
vm_id

string

Obligatorio. Es el token de hardware de la VM para autenticarla. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event

Event

Obligatorio. Es el evento que se denunciará.

ReservationAffinity

Es la afinidad de reserva para consumir la reserva zonal.

Campos
consume_reservation_type

Type

Es opcional. Tipo de reserva que se consumirá
key

string

Es opcional. Corresponde a la clave de etiqueta del recurso de reserva.
values[]

string

Es opcional. Corresponde a los valores de etiqueta del recurso de reserva.

Tipo

Indica si se debe consumir capacidad de una reserva o no.

Enums
TYPE_UNSPECIFIED Es el tipo predeterminado.
NO_RESERVATION No consumen capacidad asignada.
ANY_RESERVATION Consume cualquier reserva disponible.
SPECIFIC_RESERVATION Debe consumir recursos de una reserva específica. Se deben especificar los campos de clave-valor para especificar las reservaciones.

ResetInstanceRequest

Solicitud para restablecer una instancia de notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.reset

ResetRuntimeRequest

Es una solicitud para restablecer un entorno de ejecución de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.runtimes.reset
request_id

string

Es el UUID de la solicitud idempotente.

RollbackInstanceRequest

Solicitud para revertir una instancia de notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • iam.permissions.none
target_snapshot

string

Obligatorio. Es la instantánea para la reversión. Ejemplo: projects/test-project/global/snapshots/krwlzipynril.

Entorno de ejecución

Es la definición de un entorno de ejecución para una instancia de notebook administrado.

Campos
name

string

Solo salida. Es el nombre del recurso del entorno de ejecución. Formato: projects/{project}/locations/{location}/runtimes/{runtimeId}
state

State

Solo salida. Es el estado del tiempo de ejecución.
health_state

HealthState

Solo salida. Es el estado de salud del entorno de ejecución.
access_config

RuntimeAccessConfig

Es la configuración para acceder al entorno de ejecución.
software_config

RuntimeSoftwareConfig

Es la configuración del software dentro del entorno de ejecución.
metrics

RuntimeMetrics

Solo salida. Contiene métricas del daemon de Runtime, como el estado del servicio y las estadísticas de JupyterLab.
create_time

Timestamp

Solo salida. Es la hora de creación del entorno de ejecución.
update_time

Timestamp

Solo salida. Es la fecha y hora de actualización del tiempo de ejecución.
labels

map<string, string>

Es opcional. Son las etiquetas que se asociarán con este notebook administrado o entorno de ejecución. Las claves de las etiquetas deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. Los valores de las etiquetas pueden estar vacíos, pero, si están presentes, deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. No se pueden asociar más de 32 etiquetas a un clúster.
runtime_migration_eligibility

RuntimeMigrationEligibility

Solo salida. Verifica qué tan factible es una migración de GmN a WbI.
Campo de unión runtime_type. Tipo de entorno de ejecución. Actualmente, solo admite la VM de Compute Engine. runtime_type puede ser solo uno de los parámetros siguientes:
virtual_machine

VirtualMachine

Usa una imagen de VM de Compute Engine para iniciar la instancia de notebook administrado.
migrated

bool

Solo salida. Es un valor booleano que indica si este notebook se migró a una instancia de Workbench.

HealthState

Es el subestado del tiempo de ejecución.

Enums
HEALTH_STATE_UNSPECIFIED Se desconoce el subestado del tiempo de ejecución.
HEALTHY Se sabe que el tiempo de ejecución está en buen estado (por ejemplo, los daemons críticos se están ejecutando). Se aplica al estado ACTIVE.
UNHEALTHY Se sabe que el tiempo de ejecución se encuentra en un estado no saludable (por ejemplo, no se están ejecutando los daemons críticos). Se aplica al estado ACTIVE.
AGENT_NOT_INSTALLED El entorno de ejecución no instaló el agente de supervisión del estado. Se aplica al estado ACTIVE.
AGENT_NOT_RUNNING El agente de supervisión del estado del tiempo de ejecución no se está ejecutando. Se aplica al estado ACTIVE.

Estado

Es la definición de los estados de este entorno de ejecución.

Enums
STATE_UNSPECIFIED No se especifica el estado.
STARTING La capa de procesamiento está iniciando el tiempo de ejecución. No está listo para usarse.
PROVISIONING La capa de procesamiento está instalando los frameworks necesarios y registrando el tiempo de ejecución con el proxy del notebook. No se puede usar.
ACTIVE El tiempo de ejecución se está ejecutando. Está lista para usarse.
STOPPING La lógica de control está deteniendo el tiempo de ejecución. No se puede usar.
STOPPED Se detuvo el tiempo de ejecución. No se puede usar.
DELETING Se está borrando el entorno de ejecución. No se puede usar.
UPGRADING Se está actualizando el tiempo de ejecución. No se puede usar.
INITIALIZING Se está creando y configurando el entorno de ejecución. No está listo para usarse.

RuntimeAcceleratorConfig

Es la definición de los tipos de aceleradores de hardware que se pueden usar. Consulta Compute Engine AcceleratorTypes. Ejemplos:

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

AcceleratorType

Es el modelo de acelerador.
core_count

int64

Es la cantidad de núcleos de este acelerador.

AcceleratorType

Es el tipo de acelerador.

Enums
ACCELERATOR_TYPE_UNSPECIFIED No se especificó el tipo de acelerador.
NVIDIA_TESLA_K80

El tipo de acelerador es Nvidia Tesla K80.
NVIDIA_TESLA_P100 El tipo de acelerador es Nvidia Tesla P100.
NVIDIA_TESLA_V100 El tipo de acelerador es Nvidia Tesla V100.
NVIDIA_TESLA_P4 El tipo de acelerador es Nvidia Tesla P4.
NVIDIA_TESLA_T4 El tipo de acelerador es Nvidia Tesla T4.
NVIDIA_TESLA_A100 El tipo de acelerador es Nvidia Tesla A100, 40 GB.
NVIDIA_L4 El tipo de acelerador es Nvidia L4.
TPU_V2 (Próximamente) El tipo de acelerador es TPU V2.
TPU_V3 (Próximamente) El tipo de acelerador es TPU V3.
NVIDIA_TESLA_T4_VWS El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla T4.
NVIDIA_TESLA_P100_VWS El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P100.
NVIDIA_TESLA_P4_VWS El tipo de acelerador son las estaciones de trabajo virtuales NVIDIA Tesla P4.

RuntimeAccessConfig

Especifica la configuración de acceso para el entorno de ejecución

Campos
access_type

RuntimeAccessType

Es el tipo de modo de acceso de esta instancia.
runtime_owner

string

Es el propietario de este tiempo de ejecución después de la creación. Formato: alias@example.com Actualmente, solo admite un propietario.
proxy_uri

string

Solo salida. Es el extremo de proxy que se usa para acceder al entorno de ejecución.

RuntimeAccessType

Son las formas posibles de acceder al tiempo de ejecución. Modo de autenticación. Actualmente, solo admite un solo usuario.

Enums
RUNTIME_ACCESS_TYPE_UNSPECIFIED Acceso sin especificar.
SINGLE_USER Acceso de usuario único
SERVICE_ACCOUNT Modo de cuenta de servicio. En el modo de cuenta de servicio, el creador del entorno de ejecución especificará una SA que exista en el proyecto del consumidor. Usa el campo Cuenta de servicio del entorno de ejecución. Los usuarios que acceden al entorno de ejecución necesitan el permiso ActAs (usuario de cuenta de servicio).

RuntimeMetrics

Contiene métricas del daemon de tiempo de ejecución, como estadísticas del SO, el kernel y las sesiones.

Campos
system_metrics

map<string, string>

Solo salida. Son las métricas del sistema.

RuntimeMigrationEligibility

RuntimeMigrationEligibility representa la información de factibilidad de una migración de GmN a WbI.

Campos
warnings[]

Warning

Solo salida. Durante la migración, se establecerán ciertos parámetros de configuración de forma predeterminada.
errors[]

Error

Solo salida. Algunos parámetros de configuración hacen que el GmN no sea apto para una migración automática. Se requiere una migración manual.

Error

Un mensaje de error de migración significa que ciertos parámetros de configuración hacen que el GmN no sea apto para una migración automática. Se requiere una migración manual.

Enums
ERROR_UNSPECIFIED Es el tipo predeterminado.
CUSTOM_CONTAINER El GMN está configurado con contenedores personalizados y no se puede migrar.

Advertencia

Un mensaje de advertencia de migración significa que ciertos parámetros de configuración se establecerán de forma predeterminada durante la migración.

Enums
WARNING_UNSPECIFIED Es el tipo predeterminado.
UNSUPPORTED_ACCELERATOR_TYPE El GmN usa un tipo de acelerador que no se admite en WbI. Se migrará sin un acelerador. Los usuarios pueden adjuntar un acelerador después de la migración.
UNSUPPORTED_OS El GmN usa un sistema operativo que no es compatible con WbI (p.ej., Debian 10). Se reemplazará por Debian 11 en WbI.
RESERVED_IP_RANGE Este GmN está configurado con un rango de IP reservado, que ya no se aplica en WbI.
GOOGLE_MANAGED_NETWORK Este GmN está configurado con una red administrada por Google. Proporciona las opciones network y subnet para la migración.
POST_STARTUP_SCRIPT Este GmN está configurado con una secuencia de comandos posterior al inicio. De manera opcional, proporciona el post_startup_script_option para la migración.
SINGLE_USER Este dispositivo GmN está configurado con el modo de un solo usuario. De manera opcional, proporciona la opción service_account para la migración.

RuntimeShieldedInstanceConfig

Es un conjunto de opciones de instancias protegidas. Consulta Imágenes que usan funciones compatibles de VM protegida. No todas las combinaciones son válidas.

Campos
enable_secure_boot

bool

Define si la instancia tiene habilitado el inicio seguro.

El arranque seguro ayuda a garantizar que el sistema solo ejecute software auténtico a través de la verificación de la firma digital de todos los componentes del inicio y la detención del proceso de inicio si falla la verificación de la firma. Está inhabilitado de forma predeterminada.
enable_vtpm

bool

Define si la instancia tiene habilitado el vTPM. Habilitada de forma predeterminada.
enable_integrity_monitoring

bool

Define si la instancia tiene habilitada la supervisión de integridad.

Habilita la supervisión y la certificación de la integridad del inicio de la instancia. La certificación se realiza en función del modelo de referencia de la política de integridad. Este valor de referencia se deriva inicialmente de la imagen de arranque de confianza implícita cuando se crea la instancia. Habilitada de forma predeterminada.

RuntimeSoftwareConfig

Especifica la selección y la configuración del software dentro del entorno de ejecución. Son las propiedades que se establecerán en el tiempo de ejecución. Las claves de propiedades se especifican en formato key:value, por ejemplo:

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • enable_health_monitoring: true
Campos
notebook_upgrade_schedule

string

Es una expresión cron en la zona horaria UTC que se usa para programar la actualización automática de la instancia. Sigue el formato cron.
idle_shutdown_timeout

int32

Tiempo en minutos que se debe esperar antes de cerrar el entorno de ejecución. Valor predeterminado: 180 minutos
install_gpu_driver

bool

Instala el controlador de Nvidia automáticamente. Valor predeterminado: Verdadero
custom_gpu_driver_path

string

Especifica una ruta de acceso personalizada de Cloud Storage en la que se almacena el controlador de GPU. Si no se especifica, elegiremos automáticamente entre los controladores oficiales de la GPU.
post_startup_script

string

Ruta de acceso a una secuencia de comandos de Bash que se ejecuta automáticamente después de que se inicia por completo una instancia de notebook. La ruta de acceso debe ser una URL o una ruta de Cloud Storage (gs://path-to-file/file-name).
kernels[]

ContainerImage

Es opcional. Es una lista de imágenes de contenedor que se usarán como kernels en la instancia del notebook.
post_startup_script_behavior

PostStartupScriptBehavior

Comportamiento de la secuencia de comandos de inicio posterior.
enable_health_monitoring

bool

Verifica que los servicios internos principales estén en ejecución. Valor predeterminado: Verdadero
idle_shutdown

bool

El entorno de ejecución se apagará automáticamente después de idle_shutdown_time. Valor predeterminado: Verdadero
upgradeable

bool

Solo salida. Es un valor booleano que indica si hay una imagen más reciente disponible en una familia de imágenes.
disable_terminal

bool

Es un valor booleano que indica si la terminal de JupyterLab estará disponible o no. Valor predeterminado: falso
version

string

Solo salida. Es la versión de la imagen de arranque, como M100, de la etiqueta de versión de la imagen.
mixer_disabled

bool

Es un valor booleano que indica si se debe inhabilitar el cliente del mezclador. Valor predeterminado: falso

PostStartupScriptBehavior

Comportamiento de la secuencia de comandos de inicio posterior.

Enums
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED Comportamiento de secuencia de comandos de inicio posterior sin especificar. Se ejecutará solo una vez en la creación.
RUN_EVERY_START Ejecuta la secuencia de comandos de inicio posterior proporcionada durante la creación en cada inicio.
DOWNLOAD_AND_RUN_EVERY_START Descarga y ejecuta la secuencia de comandos de inicio proporcionada en cada inicio.

Programa

Es la definición de un programa.

Campos
name

string

Solo salida. Es el nombre de este programa. Formato: projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name

string

Solo salida. Es el nombre visible que se usa para la IU. El nombre solo puede contener caracteres alfanuméricos, guiones - y guiones bajos _.
description

string

Es una breve descripción de este entorno.
state

State
cron_schedule

string

Es el programa con formato cron-tab según el cual se ejecutará el trabajo. Formato: minuto, hora, día del mes, mes, día de la semana, p. ej., 0 0 * * WED = todos los miércoles. Más ejemplos: https://crontab.guru/examples.html
time_zone

string

Zona horaria en la que se basa cron_schedule. El valor de este campo debe ser el nombre de una zona horaria de la base de datos tz. Base de datos de TZ: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Ten en cuenta que algunas zonas horarias incluyen una disposición para el horario de verano. Las reglas para el horario de verano se determinan según la zona horaria elegida. Para UTC, usa la cadena "utc". Si no se especifica una zona horaria, se usará la zona horaria UTC (también conocida como GMT) de forma predeterminada.
create_time

Timestamp

Solo salida. Fecha y hora en que se creó la programación.
update_time

Timestamp

Solo salida. Fecha y hora en que se actualizó el programa por última vez.
execution_template

ExecutionTemplate

Es la plantilla de ejecución de notebook correspondiente a esta programación.
recent_executions[]

Execution

Solo salida. Nombres de las ejecuciones más recientes que se activaron desde esta programación y sus estados correspondientes.

Estado

Es el estado del trabajo.

Enums
STATE_UNSPECIFIED Significa que el estado no se especificó.
ENABLED El trabajo se está ejecutando con normalidad.
PAUSED El usuario pausó el trabajo. No se ejecutará. Un usuario puede pausar el trabajo de forma intencional con Cloud Scheduler.
DISABLED El sistema inhabilitó el trabajo debido a un error. El usuario no puede configurar directamente un trabajo para que se inhabilite.
UPDATE_FAILED Es el estado del trabajo que resulta de una operación CloudScheduler.UpdateJob fallida. Para recuperar un trabajo de este estado, vuelve a intentar la operación CloudScheduler.UpdateJob hasta que se reciba una respuesta correcta.
INITIALIZING Se está creando el recurso de programación.
DELETING Se está borrando el recurso de programa.

SetInstanceAcceleratorRequest

Es una solicitud para configurar el acelerador de instancias.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.setAccelerator
type

AcceleratorType

Obligatorio. Es el tipo de acelerador.
core_count

int64

Obligatorio. Es la cantidad de núcleos de este acelerador. Ten en cuenta que no todas las combinaciones de type y core_count son válidas. Consulta GPU en Compute Engine para encontrar una combinación válida. Las TPU no son compatibles.

SetInstanceLabelsRequest

Es una solicitud para configurar etiquetas de instancias.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.setLabels
labels

map<string, string>

Son las etiquetas que se aplicarán a esta instancia. Estos se pueden modificar más adelante con el método setLabels.

SetInstanceMachineTypeRequest

Es una solicitud para configurar el tipo de máquina de la instancia.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.setMachineType
machine_type

string

Obligatorio. Es el tipo de máquina de Compute Engine.

StartInstanceRequest

Solicitud para iniciar una instancia de notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.start

StartRuntimeRequest

Es una solicitud para iniciar un entorno de ejecución de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.runtimes.start
request_id

string

Es el UUID de la solicitud idempotente.

StopInstanceRequest

Solicitud para detener una instancia de notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.stop

StopRuntimeRequest

Es una solicitud para detener un entorno de ejecución de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.runtimes.stop
request_id

string

Es el UUID de la solicitud idempotente.

SwitchRuntimeRequest

Es una solicitud para cambiar un tiempo de ejecución de notebook administrado.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.runtimes.switch
machine_type

string

tipo de máquina
accelerator_config

RuntimeAcceleratorConfig

configuración del acelerador.
request_id

string

Es el UUID de la solicitud idempotente.

UpdateInstanceConfigRequest

Solicitud para actualizar la configuración de instancias.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.updateConfig
config

InstanceConfig

Es la configuración de la instancia que se actualizará.

UpdateInstanceMetadataItemsRequest

Es una solicitud para agregar o cambiar elementos de metadatos de una instancia.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.updateConfig
items

map<string, string>

Son los elementos de metadatos que se agregarán o actualizarán para la instancia.

UpdateInstanceMetadataItemsResponse

Es la respuesta para agregar o cambiar elementos de metadatos de una instancia.

Campos
items

map<string, string>

Mapa de los elementos que se agregaron o actualizaron en los metadatos.

UpdateRuntimeRequest

Es una solicitud para actualizar la configuración de un notebook administrado.

Campos
runtime

Runtime

Obligatorio. Es el entorno de ejecución que se actualizará.

La autorización requiere el siguiente permiso de IAM en el recurso especificado runtime:

  • notebooks.runtimes.update
update_mask

FieldMask

Obligatorio. Especifica la ruta de acceso, en relación con Runtime, del campo que se actualizará. Por ejemplo, para cambiar los kernels de configuración del software, el parámetro update_mask se especificaría como software_config.kernels, y el cuerpo de la solicitud PATCH especificaría el valor nuevo, de la siguiente manera:

{
  "software_config":{
    "kernels": [{
       'repository':
       'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
       'latest' }],
    }
}

Actualmente, solo se pueden actualizar los siguientes campos:

  • 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

Es el UUID de la solicitud idempotente.

UpdateShieldedInstanceConfigRequest

Es una solicitud para actualizar la configuración de la instancia protegida de una instancia de notebook. Solo puedes usar este método en una instancia detenida.

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

Es la configuración de ShieldedInstance que se actualizará.

UpgradeInstanceRequest

Solicitud para actualizar una instancia de notebook

Campos
name

string

Obligatorio. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

La autorización requiere el siguiente permiso de IAM en el recurso especificado name:

  • notebooks.instances.upgrade
type

UpgradeType

Es opcional. Es el UpgradeType opcional. Si configuras este campo, se buscarán imágenes de procesamiento adicionales para actualizar esta instancia.

UpgradeType

Es la definición de los tipos de actualización que se pueden usar en esta instancia.

Enums
UPGRADE_TYPE_UNSPECIFIED No se especificó el tipo de actualización.
UPGRADE_FRAMEWORK Se actualizó el framework de AA.
UPGRADE_OS Actualiza el sistema operativo.
UPGRADE_CUDA Actualiza CUDA.
UPGRADE_ALL Actualizar todo (SO, framework y CUDA)

VirtualMachine

Tiempo de ejecución que usa una máquina virtual para el procesamiento.

Campos
instance_name

string

Solo salida. Es el nombre fácil de usar de la instancia administrada de Compute Engine.
instance_id

string

Solo salida. Es el identificador único de la instancia administrada de Compute Engine.
virtual_machine_config

VirtualMachineConfig

Es la configuración de la máquina virtual.

VirtualMachineConfig

Es la configuración de la máquina virtual.

Campos
zone

string

Solo salida. Es la zona en la que se encuentra la máquina virtual. Si se usa una solicitud regional, el servicio de notebooks elegirá una ubicación en la región de ejecución correspondiente. En una solicitud de obtención, la zona siempre estará presente. Ejemplo: * us-central1-b
machine_type

string

Obligatorio. Es el tipo de máquina de Compute Engine que se usa para los tiempos de ejecución. El nombre corto es válido. Ejemplos: * n1-standard-2 * e2-standard-8
container_images[]

ContainerImage

Es opcional. Es una lista de imágenes de contenedor que se usarán como kernels en la instancia del notebook.
data_disk

LocalDisk

Obligatorio. Son los parámetros de configuración de la opción de disco de datos.
encryption_config

EncryptionConfig

Es opcional. Es la configuración de encriptación del disco de datos de la máquina virtual.
shielded_instance_config

RuntimeShieldedInstanceConfig

Es opcional. Es la configuración de la instancia de VM protegida.
accelerator_config

RuntimeAcceleratorConfig

Es opcional. Es la configuración del acelerador de Compute Engine para este entorno de ejecución.
network

string

Es opcional. Es la red de Compute Engine que se usará para las comunicaciones de la máquina. No se puede especificar con la subred. Si no se especifican network ni subnet, se usa la red "predeterminada" del proyecto, si existe.

Es una URL completa o un URI parcial. Ejemplos:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
  • projects/[project_id]/global/networks/default

Los tiempos de ejecución son recursos administrados dentro de la infraestructura de Google. Los tiempos de ejecución admiten los siguientes parámetros de configuración de red:

  • Red administrada por Google (la red y la subred están vacías)
  • VPC del proyecto del consumidor (se requieren la red y la subred). Requiere la configuración del acceso privado a servicios.
  • VPC compartida (se requieren la red y la subred) Requiere la configuración del acceso privado a servicios.
subnet

string

Es opcional. Es la subred de Compute Engine que se usará para las comunicaciones de la máquina. No se puede especificar con la red.

Se aceptan URLs completas o URIs parciales. Ejemplos:

  • 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

Es opcional. Si es verdadero, el entorno de ejecución solo tendrá direcciones IP internas. De forma predeterminada, los tiempos de ejecución no están restringidos a las direcciones IP internas y tendrán direcciones IP externas efímeras asignadas a cada VM. Esta restricción internal_ip_only solo se puede habilitar para las redes habilitadas para subredes, y todas las dependencias deben configurarse para que sean accesibles sin direcciones IP externas.
tags[]

string

Es opcional. Son las etiquetas de red de Compute Engine que se agregarán en el tiempo de ejecución (consulta Agrega etiquetas de red).
guest_attributes

map<string, string>

Solo salida. Son los atributos de invitado de Compute Engine. (consulta Atributos de invitado del proyecto y de la instancia).
metadata

map<string, string>

Es opcional. Son las entradas de metadatos de Compute Engine que se agregarán a la máquina virtual. (consulta Metadatos de proyecto y de instancia).
labels

map<string, string>

Es opcional. Son las etiquetas que se asociarán con este entorno de ejecución. Las claves de las etiquetas deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. Los valores de las etiquetas pueden estar vacíos, pero, si están presentes, deben contener entre 1 y 63 caracteres, y deben cumplir con el RFC 1035. No se pueden asociar más de 32 etiquetas a un clúster.
nic_type

NicType

Es opcional. Es el tipo de vNIC que se usará en esta interfaz. Puede ser gVNIC o VirtioNet.
reserved_ip_range

string

Es opcional. El nombre del rango de IP reservado se usa para el intercambio de tráfico de VPC. La asignación de la subred usará el nombre del rango si está asignado.

Ejemplo: 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

El valor del campo será managed-notebooks-range-c.
boot_image

BootImage

Es opcional. Son los metadatos de la imagen de arranque que se usan para la capacidad de actualización del tiempo de ejecución.

BootImage

Este tipo no tiene campos.

Es la definición de la imagen de arranque que usa el tiempo de ejecución. Se usa para facilitar la capacidad de actualización del tiempo de ejecución.

NicType

Es el tipo de controlador de la NIC virtual. El valor predeterminado debe ser UNSPECIFIED_NIC_TYPE.

Enums
UNSPECIFIED_NIC_TYPE No se especificó ningún tipo.
VIRTIO_NET VIRTIO
GVNIC GVNIC

VmImage

Es la definición de una imagen de máquina virtual personalizada de Compute Engine para iniciar una instancia de notebook con el entorno instalado directamente en la VM.

Campos
project

string

Obligatorio. Es el nombre del proyecto de Google Cloud al que pertenece esta imagen de VM. Formato: {project_id}
Campo de unión image. Es la referencia a una imagen de VM externa de Compute Engine. image puede ser solo uno de los parámetros siguientes:
image_name

string

Usa el nombre de la imagen de VM para encontrarla.
image_family

string

Usa esta familia de imágenes de VM para encontrar la imagen. Se usará la imagen más reciente de esta familia.