Package google.cloud.notebooks.v2

AcceleratorType

Es opcional. Es el tipo de acelerador.

int64

Es opcional. Es la cantidad de núcleos de este acelerador.

string

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

int64

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

DiskType

Es opcional. Indica el tipo de disco.

DiskEncryption

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

string

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

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

bool

Indica si una instancia se puede actualizar.

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.

string

Es información adicional sobre la actualización.

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.

ConfidentialInstanceType

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

DefaultValues

Solo salida. Son los valores predeterminados para la configuración.

SupportedValues

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

ImageRelease

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

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

string

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

string

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

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

string

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

Instance

Obligatorio. Es la instancia que se creará.

string

Es opcional. Es el UUID de la solicitud idempotente.

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.

DiskType

Es opcional. Indica el tipo de disco.

DiskEncryption

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

string

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

string

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

string

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

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

string

Es opcional. Es el UUID de la solicitud idempotente.

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

DiagnosticConfig

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

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.

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

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/

bool

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

bool

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

bool

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

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 GPU. Solo se aplica a instancias con GPUs.

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.

string

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

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.

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.

ServiceAccount

Es opcional. Es la cuenta de servicio que actúa como identidad de la instancia de VM. Actualmente, solo admite una cuenta de servicio.

BootDisk

Es opcional. Es el disco de arranque de la VM.

DataDisk

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

ShieldedInstanceConfig

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

NetworkInterface

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

bool

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

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

map<string, string>

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

map<string, string>

Solo salida. Representa los metadatos administrados por el sistema para esta instancia: el subconjunto de metadata cuyas claves son claves del sistema de Workbench reconocidas.

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

GPUDriverConfig

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

ConfidentialInstanceConfig

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

string

Solo salida. Es el ID único del recurso de instancia de Compute Engine.

VmImage

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

ContainerImage

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

string

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

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

string

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

string

Solo salida. Lanzamiento de la imagen del formulario m123

string

Solo salida. Es la familia de imágenes de la imagen. (p. ej., workbench-instances o workbench-2603)

string

Solo salida. Es la descripción de la imagen.

string

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

string

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

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.

string

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

State

Solo salida. Es el estado de esta instancia.

UpgradeHistoryEntry

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

string

Solo salida. Es el ID único del recurso.

HealthState

Solo salida. Es el estado de health_state de la instancia.

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"
}

Timestamp

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

Timestamp

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

bool

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

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.

string

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

bool

Solo salida. Reservado para uso futuro para la separación de zonas.

bool

Solo salida. Reservado para uso futuro para el aislamiento de zonas.

bool

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

bool

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

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.

GceSetup

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

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

int32

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

string

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

string

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

string

Es opcional. Es un filtro de lista.

Instance

Es una lista de instancias devueltas.

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.

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']. Un ListInstancesResponse solo contendrá instancias o elementos no accesibles.

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}

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}

NicType

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

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.

string

Es opcional. Es una dirección IP interna asociada a esta instancia. Especifica una dirección IP interna estática sin usar que esté disponible para la subred en la que se encuentra esta instancia o deja este campo sin definir para usar una IP del rango efímero de la subred.

Timestamp

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

Timestamp

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

string

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

string

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

string

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

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.

string

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

string

Nombre del extremo de API de esta operación.

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

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

BootDisk

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

DataDisk

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

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

Snapshot

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

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

string

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

string

Obligatorio. Solo salida. ID de revisión

string

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

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.

bool

Es opcional. Define si la instancia de VM 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.

bool

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

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. Esta referencia se deriva inicialmente de la imagen de arranque de confianza implícita cuando se crea la instancia de VM.

string

Obligatorio. Es el ID de la instantánea.

string

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

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

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

string

Solo salida. Son los tipos de máquinas compatibles con WbI.

string

Solo salida. Son los tipos de aceleradores que admite WbI.

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

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

Nota: gce_setup.disable_public_ip y disable_proxy_access son unidireccionales en la actualización: solo se pueden usar para inhabilitar la función (establecer el campo en true). Las solicitudes que vuelven a establecer cualquiera de los campos en false (para volver a habilitar el acceso a la IP externa o al proxy) se rechazan con INVALID_ARGUMENT.

string

Es opcional. Es el UUID de la solicitud idempotente.

string

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

string

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

string

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

string

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

string

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

State

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

Timestamp

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

Action

Es opcional. Acción. Revertir o actualizar

string

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

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

string

Es opcional. Es el nombre del recurso de la familia de imágenes de Compute Engine al que se actualizará. Formato: projects/{project_id}/global/images/family/{image_family} Si se especifica, la instancia se actualizará a la imagen más reciente de la familia de imágenes especificada, lo que permitirá actualizaciones en todas las familias de imágenes. Si no se especifica, la instancia se actualizará a la imagen más reciente de su familia de imágenes actual.

string

Obligatorio. Es el nombre del proyecto de Google Cloud al que pertenece esta imagen de VM. Formato: {project_id}

string

Solo salida. Es una descripción legible por humanos de la imagen que se ejecuta en la instancia (por ejemplo, "Debian 11, Python 3.10"), que se deriva en el momento de la lectura de la configuración de la versión de la imagen (la fuente de información). Se establece en "Personalizado" para las imágenes de disco de arranque no reconocidas.

string

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

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.