Package google.cloud.notebooks.v2

Índice

NotebookService

Es el servicio de la versión 2 de la API para las instancias de Notebooks de Workbench.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

Verifica si se puede actualizar una instancia de notebook.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Requiere el siguiente permiso de OAuth:

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

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

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Borra una sola instancia.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Requiere el siguiente permiso de OAuth:

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

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

rpc GetConfig(GetConfigRequest) returns (Config)

Devuelve varios parámetros de configuración.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc GetInstance(GetInstanceRequest) returns (Instance)

Obtiene los detalles de una sola instancia.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

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

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Restablece una instancia de notebook.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

Cambia el tamaño del disco de una instancia de notebook a una capacidad mayor.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance restablece una instancia a partir de un BackupSource.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Requiere el siguiente permiso de OAuth:

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

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

rpc StartInstance(StartInstanceRequest) returns (Operation)

Inicia una instancia de notebook.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc StopInstance(StopInstanceRequest) returns (Operation)

Detiene una instancia de notebook.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance actualiza una instancia.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Requiere el siguiente permiso de OAuth:

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

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

AcceleratorConfig

Es la configuración de un acelerador para una instancia de VM. Es la definición de un acelerador de hardware. Ten en cuenta que no se realiza ninguna verificación en las combinaciones de type y core_count. Las TPU no son compatibles. Consulta GPU en Compute Engine para encontrar una combinación válida.

Campos
type

AcceleratorType

Es opcional. Es el tipo de este acelerador.
core_count

int64

Es opcional. 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_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_A100_80GB El tipo de acelerador es Nvidia Tesla A100, 80 GB.
NVIDIA_L4 El tipo de acelerador es Nvidia Tesla L4.
NVIDIA_H100_80GB El tipo de acelerador es Nvidia Tesla H100 - 80 GB.
NVIDIA_H100_MEGA_80GB El tipo de acelerador es Nvidia Tesla H100 - MEGA 80 GB.
NVIDIA_H200_141GB El tipo de acelerador es Nvidia Tesla H200, 141 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_B200 El tipo de acelerador es NVIDIA B200.

AccessConfig

Es una configuración de acceso adjunta a la interfaz de red de una instancia.

Campos
external_ip

string

Una dirección IP externa asociada con esta instancia. Especifica una dirección IP externa estática sin usar que esté disponible para el proyecto o deja este campo sin definir para usar una IP de un grupo compartido de direcciones IP efímeras. Si especificas una dirección IP externa estática, esta debe estar en la misma región que la zona de la instancia.

BootDisk

Es la definición de un disco de arranque.

Campos
disk_size_gb

int64

Es opcional. Tamaño del disco de arranque en GB asociado a esta instancia, hasta un máximo de 64,000 GB (64 TB). Si no se especifica, se usará el valor recomendado de 150 GB.
disk_type

DiskType

Es opcional. Indica el tipo de disco.
disk_encryption

DiskEncryption

Es opcional. 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

Es opcional. 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.

CheckInstanceUpgradabilityRequest

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

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

CheckInstanceUpgradabilityResponse

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

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 propagará si el campo actualizable 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 propagará si el campo actualizable es verdadero.

ConfidentialInstanceConfig

Es un conjunto de opciones de instancias confidenciales.

Campos
confidential_instance_type

ConfidentialInstanceType

Es opcional. Define el tipo de tecnología que usa la instancia confidencial.

ConfidentialInstanceType

Es el tipo de instancia confidencial.

Enums
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED No se especificó ningún tipo. No uses este valor.
SEV Virtualización encriptada segura de AMD

Configuración

Es la respuesta para obtener la configuración de WbI en una ubicación.

Campos
default_values

DefaultValues

Solo salida. Son los valores predeterminados de la configuración.
supported_values

SupportedValues

Solo salida. Son los valores admitidos para la configuración.
available_images[]

ImageRelease

Solo salida. Es la lista de imágenes disponibles para crear un WbI.
disable_workbench_legacy_creation

bool

Solo salida. Es una marca para inhabilitar la creación de notebooks heredados de Workbench (notebooks administrados por el usuario y notebooks administrados por Google).

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 opcional. Es la etiqueta de la imagen del contenedor. Si no se especifica, el valor predeterminado es la etiqueta más reciente.

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. Instancia que se creará.
request_id

string

Es opcional. Es el UUID de la solicitud idempotente.

DataDisk

Es un recurso de disco conectado a una instancia.

Campos
disk_size_gb

int64

Es opcional. Tamaño del disco en GB conectado a esta instancia de VM, hasta un máximo de 64,000 GB (64 TB). Si no se especifica, el valor predeterminado es 100.
disk_type

DiskType

Es opcional. Solo entrada. Indica el tipo de disco.
disk_encryption

DiskEncryption

Es opcional. 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

Es opcional. 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.
resource_policies[]

string

Es opcional. Son las políticas de recursos que se aplicarán al disco de datos.

DefaultValues

DefaultValues representa los valores de configuración predeterminados.

Campos
machine_type

string

Solo salida. Es el tipo de máquina predeterminado que usa el backend si el usuario no lo proporciona.

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
request_id

string

Es opcional. Es el UUID de la solicitud idempotente.

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}

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

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

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

int32

Es opcional. 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 de acceso (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/
enable_repair_flag

bool

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

bool

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

bool

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

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.

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.
HYPERDISK_BALANCED Representa el tipo de disco persistente balanceado Hyperdisk Balanced. Se puede usar como disco de arranque o disco de datos.
HYPERDISK_EXTREME Representa el tipo de disco persistente Hyperdisk Extreme. Solo se puede usar como disco de datos.
HYPERDISK_THROUGHPUT Representa el tipo de disco persistente Hyperdisk Throughput. Solo se puede usar como disco de datos.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Representa el tipo de disco persistente Hyperdisk Balanced High Availability. Se puede usar como disco de arranque o disco de datos.
HYPERDISK_ML Representa el tipo de disco persistente Hyperdisk ML. Se puede usar como disco de arranque o disco de datos.

GPUDriverConfig

Una configuración del controlador de GPU

Campos
enable_gpu_driver

bool

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

string

Es opcional. 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.

GceSetup

Es la definición de cómo configurar una instancia de VM fuera de Recursos e Identidad.

Campos
machine_type

string

Es opcional. Es el tipo de máquina de la instancia de VM. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

Es opcional. Es la plataforma de CPU mínima que se usará para esta instancia. Puedes encontrar la lista de valores válidos en https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
accelerator_configs[]

AcceleratorConfig

Es opcional. Son los aceleradores de hardware que se usan 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. Actualmente, solo admite una configuración de acelerador.
service_accounts[]

ServiceAccount

Es opcional. Es la cuenta de servicio que funciona como identidad para la instancia de VM. Actualmente, solo se admite una cuenta de servicio.
boot_disk

BootDisk

Es opcional. Es el disco de arranque de la VM.
data_disks[]

DataDisk

Es opcional. Son los discos de datos conectados a la instancia de VM. Actualmente, solo admite un disco de datos.
shielded_instance_config

ShieldedInstanceConfig

Es opcional. Configuración de VM protegida. Imágenes que usan funciones compatibles de la VM protegida
network_interfaces[]

NetworkInterface

Es opcional. Son las interfaces de red de la VM. Solo admite una interfaz.
disable_public_ip

bool

Es opcional. Si es verdadero, no se asignará ninguna IP externa a esta instancia de VM.
tags[]

string

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

map<string, string>

Es opcional. Son los metadatos personalizados que se aplicarán a esta instancia.
enable_ip_forwarding

bool

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

GPUDriverConfig

Es opcional. Es la configuración de los controladores de GPU.
confidential_instance_config

ConfidentialInstanceConfig

Es opcional. Es la configuración de la instancia confidencial.
instance_id

string

Solo salida. Es el ID único del recurso de instancia de Compute Engine.
Campo de unión image. Es el tipo de imagen, que puede ser de VM o de imagen de contenedor. image puede ser solo uno de los parámetros siguientes:
vm_image

VmImage

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

ContainerImage

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

GetConfigRequest

Es una solicitud para obtener parámetros de configuración de Workbench.

Campos
name

string

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

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

HealthState

Es el estado de la instancia.

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.

ImageRelease

ConfigImage representa una versión de imagen disponible para crear una WbI

Campos
image_name

string

Solo salida. Nombre de la imagen con el formato workbench-instances-vAAAAmmdd--
release_name

string

Solo salida. Publicación de la imagen del formulario m123

Instancia

Es la definición de una instancia de notebook.

Campos
name

string

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

string

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

string

Es opcional. 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.
creator

string

Solo salida. Dirección de correo electrónico de la entidad que envió la solicitud original de CreateInstance.
state

State

Solo salida. Es el estado de esta instancia.
upgrade_history[]

UpgradeHistoryEntry

Solo salida. Es el historial de actualizaciones de esta instancia.
id

string

Solo salida. Es el ID único del recurso.
health_state

HealthState

Solo salida. Es el estado de la instancia.
health_info

map<string, string>

Solo salida. Es información adicional sobre el estado de la instancia. Ejemplo:

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

Timestamp

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

Timestamp

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

bool

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

map<string, string>

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

string

Solo salida. Es el extremo del proxy de grupos de personal que se usa para acceder al notebook de Jupyter.
satisfies_pzs

bool

Solo salida. Se reserva para uso futuro en la separación de zonas.
satisfies_pzi

bool

Solo salida. Se reserva para uso futuro en el aislamiento de zonas.
enable_third_party_identity

bool

Es opcional. Es una marca que especifica que se puede acceder a un notebook con un proveedor de identidad externo.
enable_managed_euc

bool

Es opcional. Es una marca para habilitar las credenciales de usuario final administradas para la instancia.
enable_deletion_protection

bool

Es opcional. Si es verdadero, se habilitará la protección contra eliminaciones para esta instancia de Workbench. Si es falso, se inhabilitará la protección contra eliminaciones para esta instancia de Workbench.
Campo de unión infrastructure. Es la configuración de la instancia de Notebook. infrastructure puede ser solo uno de los parámetros siguientes:
gce_setup

GceSetup

Es opcional. Es la configuración de Compute Engine para el notebook. Usa campos definidos en el notebook.

ListInstancesRequest

Es una solicitud para enumerar instancias de notebooks.

Campos
parent

string

Obligatorio. Es el elemento superior de la instancia. Formatos: - projects/{project_id}/locations/{location} para enumerar instancias en una zona específica. - projects/{project_id}/locations/- para enumerar instancias en todas las ubicaciones

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

  • notebooks.instances.list
page_size

int32

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

string

Es opcional. 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 el filtro de la 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

Lista sin ordenar. Ubicaciones a las que no se pudo llegar. Por ejemplo, ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. Una respuesta ListInstancesResponse solo contendrá instancias o elementos no accesibles.

NetworkInterface

Es la definición de un recurso de interfaz de red conectado a una VM.

Campos
network

string

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

string

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

NicType

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

AccessConfig

Es opcional. Es un array de configuraciones para esta interfaz. Actualmente, solo se admite una configuración de acceso, ONE_TO_ONE_NAT. Si no se especifica ningún accessConfig, la instancia tendrá acceso externo a Internet a través de una dirección IP externa efímera.

NicType

Es el tipo de controlador de vNIC. El valor predeterminado debe ser NIC_TYPE_UNSPECIFIED.

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

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

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

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

string

Es el nombre del extremo de API de esta operación.

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

ResizeDiskRequest

Solicitud para cambiar el tamaño de los discos de la instancia de notebook

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.update
Campo de unión Disk. Tipo de disco cuyo tamaño se puede cambiar: El disco de arranque o de datos Disk solo puede ser uno de los siguientes:
boot_disk

BootDisk

Obligatorio. Es el disco de arranque al que se le cambiará el tamaño. Solo se usará disk_size_gb.
data_disk

DataDisk

Obligatorio. Es el disco de datos al que se le cambiará el tamaño. Solo se usará disk_size_gb.

RestoreInstanceRequest

Es una solicitud para restablecer la instancia del notebook desde un BackupSource.

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.update
Campo de unión Source. Es la fuente desde la que se restablecerá. Source puede ser solo uno de los parámetros siguientes:
snapshot

Snapshot

Es la instantánea que se usará para el restablecimiento.

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:

  • notebooks.instances.rollback
target_snapshot

string

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

string

Obligatorio. Solo salida. ID de revisión

ServiceAccount

Una cuenta de servicio que actúa como identidad

Campos
email

string

Es opcional. Es la dirección de correo electrónico de la cuenta de servicio.
scopes[]

string

Solo salida. Es la lista de permisos que estarán disponibles para esta cuenta de servicio. El CLH lo establece en https://www.googleapis.com/auth/cloud-platform.

ShieldedInstanceConfig

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

Campos
enable_secure_boot

bool

Es opcional. Define si la instancia de VM tiene habilitado el inicio seguro.

El inicio 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

Es opcional. Define si la instancia de VM tiene habilitado el vTPM.
enable_integrity_monitoring

bool

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

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

Instantánea

La instantánea representa la instantánea del disco de datos que se usó para restablecer la instancia de Workbench. Hace referencia a: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

Campos
snapshot_id

string

Obligatorio. Es el ID de la instantánea.
project_id

string

Obligatorio. Es el ID del proyecto de la instantánea.

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

Estado

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

Enums
STATE_UNSPECIFIED No se especificó el estado.
STARTING La lógica de control está iniciando la instancia.
PROVISIONING La lógica de control instala los frameworks necesarios 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.
SUSPENDING La instancia se está suspendiendo.
SUSPENDED La instancia está suspendida.

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

SupportedValues

SupportedValues representa los valores admitidos por la configuración.

Campos
machine_types[]

string

Solo salida. Son los tipos de máquinas que admite WbI.
accelerator_types[]

string

Solo salida. Son los tipos de aceleradores compatibles con WbI.

UpdateInstanceRequest

Es una solicitud para actualizar una instancia de notebook.

Campos
instance

Instance

Obligatorio. Es una representación de una instancia.

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

  • iam.permissions.none
update_mask

FieldMask

Obligatorio. Es la máscara que se usa para actualizar una instancia. Campos actualizables:

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

string

Es opcional. Es el UUID de la solicitud idempotente.

UpgradeHistoryEntry

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

Campos
snapshot

string

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

string

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

string

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

string

Es opcional. Es el framework de esta instancia de notebook.
version

string

Es opcional. Es la versión de la instancia de notebook antes de esta actualización.
state

State

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

Timestamp

Inmutable. Es la fecha y hora en que se creó esta entrada del historial de actualizaciones de la instancia.
action

Action

Es opcional. Acción. Revertir o actualizar.
target_version

string

Es opcional. 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 actualizaciones.

Enums
STATE_UNSPECIFIED No se especificó 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.

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

VmImage

Es la definición de una imagen personalizada de máquina virtual 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:
name

string

Es opcional. Usa el nombre de la imagen de VM para encontrarla.
family

string

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