Package google.cloud.notebooks.v2

Índice

NotebookService

Serviço da API v2 para instâncias de notebooks do Workbench.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

Verifica se uma instância de notebook pode ser atualizada.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Cria uma nova instância em um determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Exclui uma única instância.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

Cria um arquivo de diagnóstico e executa a ferramenta de diagnóstico em uma instância.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Retorna vários parâmetros de configuração.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Recebe detalhes de uma única instância.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Lista instâncias em um determinado projeto e local.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Redefine uma instância de notebook.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

Redimensione o disco de uma instância de notebook para uma capacidade maior.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

"RestoreInstance" restaura uma instância de um "BackupSource".

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

Reverte uma instância de notebook para a versão anterior.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

Inicia uma instância de notebook.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

Interrompe uma instância de notebook.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

O UpdateInstance atualiza uma instância.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

Faz upgrade de uma instância de notebook para a versão mais recente.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

AcceleratorConfig

Uma configuração de acelerador para uma definição de instância de VM de um acelerador de hardware. Observação: não há verificação nas combinações de type e core_count. TPUs não são compatíveis. Consulte GPUs no Compute Engine para encontrar uma combinação válida.

Campos
type

AcceleratorType

Opcional. Tipo deste acelerador.
core_count

int64

Opcional. Contagem de núcleos deste acelerador.

AcceleratorType

Definição dos tipos de aceleradores de hardware que podem ser usados nessa instância.

Tipos enumerados
ACCELERATOR_TYPE_UNSPECIFIED O tipo de acelerador não foi especificado.
NVIDIA_TESLA_P100 O tipo de acelerador é Nvidia Tesla P100.
NVIDIA_TESLA_V100 O tipo de acelerador é Nvidia Tesla V100.
NVIDIA_TESLA_P4 O tipo de acelerador é Nvidia Tesla P4.
NVIDIA_TESLA_T4 O tipo de acelerador é Nvidia Tesla T4.
NVIDIA_TESLA_A100 O tipo de acelerador é Nvidia Tesla A100 - 40 GB.
NVIDIA_A100_80GB O tipo de acelerador é Nvidia Tesla A100 - 80 GB.
NVIDIA_L4 O tipo de acelerador é Nvidia Tesla L4.
NVIDIA_H100_80GB O tipo de acelerador é Nvidia Tesla H100 - 80 GB.
NVIDIA_H100_MEGA_80GB O tipo de acelerador é Nvidia Tesla H100 - MEGA 80 GB.
NVIDIA_H200_141GB O tipo de acelerador é Nvidia Tesla H200 - 141 GB.
NVIDIA_TESLA_T4_VWS O tipo de acelerador é NVIDIA Tesla T4 Virtual Workstations.
NVIDIA_TESLA_P100_VWS O tipo de acelerador é NVIDIA Tesla P100 Virtual Workstations.
NVIDIA_TESLA_P4_VWS O tipo de acelerador é NVIDIA Tesla P4 Virtual Workstations.
NVIDIA_B200 O tipo de acelerador é NVIDIA B200.

AccessConfig

Uma configuração de acesso anexada à interface de rede de uma instância.

Campos
external_ip

string

Um endereço IP externo associado a esta instância. Especifique um endereço IP externo estático não utilizado disponível para o projeto ou deixe esse campo indefinido para usar um IP de um pool compartilhado de endereços IP temporários. Se você especificar um endereço IP externo estático, ele precisará estar na mesma região que a zona da instância.

BootDisk

A definição de um disco de inicialização.

Campos
disk_size_gb

int64

Opcional. O tamanho do disco de inicialização em GB anexado a esta instância, até um máximo de 64.000 GB (64 TB). Se não for especificado, o padrão será o valor recomendado de 150 GB.
disk_type

DiskType

Opcional. Indica o tipo do disco.
disk_encryption

DiskEncryption

Opcional. Somente entrada. Método de criptografia de disco usado nos discos de inicialização e de dados. O padrão é GMEK.
kms_key

string

Opcional. Somente entrada. A chave do KMS usada para criptografar os discos. Só é aplicável se disk_encryption for CMEK. Formato: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Saiba mais sobre como usar suas próprias chaves de criptografia.

CheckInstanceUpgradabilityRequest

Solicitação para verificar se uma instância de notebook pode ser atualizada.

Campos
notebook_instance

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado notebookInstance:

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

Resposta para verificar se uma instância de notebook pode ser atualizada.

Campos
upgradeable

bool

Se uma instância pode ser atualizada.
upgrade_version

string

A versão para a qual esta instância será atualizada se o endpoint de upgrade for chamado. Esse campo só será preenchido se "upgradeable" for verdadeiro.
upgrade_info

string

Informações adicionais sobre o upgrade.
upgrade_image

string

O novo link independente da imagem para que esta instância será atualizada se o endpoint de upgrade for chamado. Esse campo só será preenchido se "upgradeable" for verdadeiro.

ConfidentialInstanceConfig

Um conjunto de opções de instância confidencial.

Campos
confidential_instance_type

ConfidentialInstanceType

Opcional. Define o tipo de tecnologia usada pela instância confidencial.

ConfidentialInstanceType

O tipo de instância confidencial.

Tipos enumerados
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED Nenhum tipo especificado. Não use esse valor.
SEV AMD Secure Encrypted Virtualization.

Configuração

Resposta para receber configurações da WBI em um local

Campos
default_values

DefaultValues

Apenas saída. Os valores padrão para configuração.
supported_values

SupportedValues

Apenas saída. Os valores aceitos para configuração.
available_images[]

ImageRelease

Apenas saída. A lista de imagens disponíveis para criar um WbI.
disable_workbench_legacy_creation

bool

Apenas saída. Flag para desativar a criação de notebooks legados do Workbench (notebooks gerenciados pelo usuário e pelo Google).

ContainerImage

Definição de uma imagem de contêiner para iniciar uma instância de notebook com o ambiente instalado em um contêiner.

Campos
repository

string

Obrigatório. O caminho para o repositório de imagens do contêiner. Por exemplo: gcr.io/{project_id}/{image_name}
tag

string

Opcional. A tag da imagem do contêiner. Se não for especificado, o padrão será a tag mais recente.

CreateInstanceRequest

Solicitação para criar uma instância de notebook.

Campos
parent

string

Obrigatório. Formato: parent=projects/{project_id}/locations/{location}

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • notebooks.instances.create
instance_id

string

Obrigatório. ID exclusivo definido pelo usuário desta instância.
instance

Instance

Obrigatório. A instância a ser criada.
request_id

string

Opcional. UUID da solicitação idempotente.

DataDisk

Um recurso de disco anexado à instância.

Campos
disk_size_gb

int64

Opcional. O tamanho do disco em GB anexado a esta instância de VM, até um máximo de 64.000 GB (64 TB). Se não for especificado, o padrão será 100.
disk_type

DiskType

Opcional. Somente entrada. Indica o tipo do disco.
disk_encryption

DiskEncryption

Opcional. Somente entrada. Método de criptografia de disco usado nos discos de inicialização e de dados. O padrão é GMEK.
kms_key

string

Opcional. Somente entrada. A chave do KMS usada para criptografar os discos. Só é aplicável se disk_encryption for CMEK. Formato: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Saiba mais sobre como usar suas próprias chaves de criptografia.
resource_policies[]

string

Opcional. As políticas de recursos a serem aplicadas ao disco de dados.

DefaultValues

"DefaultValues" representa os valores de configuração padrão.

Campos
machine_type

string

Apenas saída. O tipo de máquina padrão usado pelo back-end se não for fornecido pelo usuário.

DeleteInstanceRequest

Solicitação para excluir uma instância de notebook.

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.delete
request_id

string

Opcional. UUID da solicitação idempotente.

DiagnoseInstanceRequest

Solicitação para criar um arquivo de diagnóstico de instância de notebook.

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

Obrigatório. Define flags usadas para executar a ferramenta de diagnóstico
timeout_minutes

int32

Opcional. Tempo máximo em minutos antes de a operação expirar.

DiagnosticConfig

Define flags usadas para executar a ferramenta de diagnóstico

Campos
gcs_bucket

string

Obrigatório. Local do bucket do Cloud Storage do usuário (OBRIGATÓRIO). Precisa ser formatado com o prefixo do caminho (gs://$GCS_BUCKET).

Permissões: notebooks gerenciados pelo usuário: - storage.buckets.writer: precisa ser concedida à conta de serviço do projeto anexada à VM. Notebooks gerenciados pelo Google: - storage.buckets.writer: precisa ser concedido à conta de serviço do projeto ou às credenciais do usuário anexadas à VM, dependendo do modo de autenticação.

O arquivo de registro do bucket do Cloud Storage será gravado em gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relative_path

string

Opcional. Define o caminho de armazenamento relativo no bucket do Cloud Storage em que os registros de diagnóstico serão gravados. O caminho padrão é o diretório raiz do bucket do Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Exemplo de caminho completo em que o arquivo de registro será gravado: gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

Opcional. Ativa a flag para reparar o serviço da instância.
enable_packet_capture_flag

bool

Opcional. Ativa a flag para capturar pacotes da instância por 30 segundos
enable_copy_home_files_flag

bool

Opcional. Ativa a flag para copiar todo o conteúdo da pasta /home/jupyter.

DiskEncryption

Definição das opções de criptografia de disco.

Tipos enumerados
DISK_ENCRYPTION_UNSPECIFIED A criptografia de disco não foi especificada.
GMEK Use chaves de criptografia gerenciadas pelo Google para criptografar o disco de inicialização.
CMEK Use chaves de criptografia gerenciadas pelo cliente para criptografar o disco de inicialização.

DiskType

Tipos de disco possíveis.

Tipos enumerados
DISK_TYPE_UNSPECIFIED Tipo de disco não definido.
PD_STANDARD Tipo de disco permanente padrão.
PD_SSD Tipo de disco permanente SSD.
PD_BALANCED Tipo de disco permanente equilibrado.
PD_EXTREME Tipo de disco permanente extremo.
HYPERDISK_BALANCED Representa o tipo de disco permanente Hyperdisk Balanced. Pode ser usado como disco de inicialização ou de dados.
HYPERDISK_EXTREME Representa o tipo de disco permanente Hyperdisk Extreme. Só pode ser usado como um disco de dados.
HYPERDISK_THROUGHPUT Representa o tipo de disco permanente Hyperdisk Throughput. Só pode ser usado como um disco de dados.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Representa o tipo de disco permanente do Hyperdisk Balanced High Availability. Pode ser usado como disco de inicialização ou de dados.
HYPERDISK_ML Representa o tipo de disco permanente do Hyperdisk ML. Pode ser usado como disco de inicialização ou de dados.

GPUDriverConfig

Uma configuração de driver de GPU

Campos
enable_gpu_driver

bool

Opcional. Se o usuário final autoriza o Google Cloud a instalar o driver de GPU nessa instância de VM. Se esse campo estiver vazio ou definido como "false", o driver da GPU não será instalado. Aplicável somente a instâncias com GPUs.
custom_gpu_driver_path

string

Opcional. Especifique um caminho personalizado do Cloud Storage em que o driver de GPU está armazenado. Se não for especificado, vamos escolher automaticamente entre os drivers oficiais de GPU.

GceSetup

A definição de como configurar uma instância de VM fora de "Recursos e identidade".

Campos
machine_type

string

Opcional. O tipo de máquina da instância de VM. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

Opcional. A plataforma de CPU mínima a ser usada para esta instância. A lista de valores válidos pode ser encontrada em https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones
accelerator_configs[]

AcceleratorConfig

Opcional. Os aceleradores de hardware usados nesta instância. Se você usar aceleradores, verifique se a configuração tem vCPUs e memória suficientes para oferecer suporte ao machine_type selecionado. No momento, só há suporte para uma configuração de acelerador.
service_accounts[]

ServiceAccount

Opcional. A conta de serviço que serve como uma identidade para a instância de VM. No momento, só é possível usar uma conta de serviço.
boot_disk

BootDisk

Opcional. O disco de inicialização da VM.
data_disks[]

DataDisk

Opcional. Discos de dados anexados à instância de VM. No momento, só há suporte para um disco de dados.
shielded_instance_config

ShieldedInstanceConfig

Opcional. Configuração de VM protegida. Imagens que usam recursos de VM protegida compatíveis.
network_interfaces[]

NetworkInterface

Opcional. As interfaces de rede da VM. Aceita apenas uma interface.
disable_public_ip

bool

Opcional. Se for "true", nenhum IP externo será atribuído a esta instância de VM.
tags[]

string

Opcional. As tags de rede do Compute Engine a serem adicionadas ao ambiente de execução. Consulte Adicionar tags de rede.
metadata

map<string, string>

Opcional. Metadados personalizados a serem aplicados a esta instância.
enable_ip_forwarding

bool

Opcional. Flag para ativar ou não o encaminhamento de IP. O padrão é "false"/desativado. https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

Opcional. Configuração para drivers de GPU.
confidential_instance_config

ConfidentialInstanceConfig

Opcional. Configuração de instância confidencial.
instance_id

string

Apenas saída. O ID exclusivo do recurso de instância do Compute Engine.
Campo de união image. Tipo da imagem. Pode ser uma imagem de VM ou imagem do contêiner. image pode ser apenas de um dos tipos a seguir:
vm_image

VmImage

Opcional. Use uma imagem de VM do Compute Engine para iniciar a instância do notebook.
container_image

ContainerImage

Opcional. Use uma imagem de contêiner para iniciar a instância do notebook.

GetConfigRequest

Solicitação para receber parâmetros de configuração do Workbench.

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}

GetInstanceRequest

Solicitação para receber uma instância de notebook.

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.get

HealthState

O estado de integridade da instância.

Tipos enumerados
HEALTH_STATE_UNSPECIFIED O subestado da instância é desconhecido.
HEALTHY A instância está em um estado íntegro (por exemplo, daemons críticos estão em execução). Aplica-se ao estado "ACTIVE".
UNHEALTHY A instância está em um estado não íntegro (por exemplo, daemons críticos não estão em execução). Aplica-se ao estado ACTIVE.
AGENT_NOT_INSTALLED A instância não tem o agente de monitoramento de integridade instalado. Aplicável ao estado ATIVO.
AGENT_NOT_RUNNING O agente de monitoramento de integridade da instância não está em execução. Aplicável ao estado ATIVO.

ImageRelease

"ConfigImage" representa uma versão de imagem disponível para criar uma WbI.

Campos
image_name

string

Apenas saída. O nome da imagem no formato workbench-instances-vYYYYmmdd--
release_name

string

Apenas saída. A divulgação da imagem do formulário m123

Instância

A definição de uma instância de notebook.

Campos
name

string

Apenas saída. Identificador. O nome desta instância de notebook. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

Apenas saída. O endpoint de proxy usado para acessar o notebook Jupyter.
instance_owners[]

string

Opcional. O proprietário dessa instância após a criação. Formato: alias@example.com

No momento, só há suporte para um proprietário. Se não for especificado, todos os usuários da conta de serviço da instância de VM poderão usar a instância.
creator

string

Apenas saída. Endereço de e-mail da entidade que enviou a solicitação CreateInstance original.
state

State

Apenas saída. O estado desta instância.
upgrade_history[]

UpgradeHistoryEntry

Apenas saída. O histórico de upgrades desta instância.
id

string

Apenas saída. ID exclusivo do recurso.
health_state

HealthState

Apenas saída. health_state da instância.
health_info

map<string, string>

Apenas saída. Informações adicionais sobre a integridade da instância. Exemplo:

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

Apenas saída. Hora de criação da instância.
update_time

Timestamp

Apenas saída. Horário de atualização da instância.
disable_proxy_access

bool

Opcional. Se for "true", a instância do notebook não será registrada no proxy.
labels

map<string, string>

Opcional. Rótulos a serem aplicados a esta instância. Elas podem ser modificadas posteriormente pelo método "UpdateInstance".
third_party_proxy_url

string

Apenas saída. O endpoint de proxy dos pools de colaboradores usado para acessar o notebook Jupyter.
satisfies_pzs

bool

Apenas saída. Reservado para uso futuro na separação de zonas.
satisfies_pzi

bool

Apenas saída. Reservado para uso futuro no isolamento de zona.
enable_third_party_identity

bool

Opcional. Flag que especifica que um notebook pode ser acessado com um provedor de identidade de terceiros.
enable_managed_euc

bool

Opcional. Flag para ativar as credenciais gerenciadas de usuário final para a instância.
enable_deletion_protection

bool

Opcional. Se for "true", a proteção contra exclusão será ativada para esta instância do Workbench. Se for "false", a proteção contra exclusão será desativada para esta instância do Workbench.
Campo de união infrastructure. Configuração da instância de notebook. infrastructure pode ser apenas de um dos tipos a seguir:
gce_setup

GceSetup

Opcional. Configuração do Compute Engine para o notebook. Usa campos definidos no notebook.

ListInstancesRequest

Solicitação para listar instâncias de Notebooks.

Campos
parent

string

Obrigatório. O pai da instância. Formatos: - projects/{project_id}/locations/{location} para listar instâncias em uma zona específica. - projects/{project_id}/locations/- para listar instâncias em todos os locais.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • notebooks.instances.list
page_size

int32

Opcional. Tamanho máximo de retorno da chamada de lista.
page_token

string

Opcional. Um token de página retornado anteriormente que pode ser usado para continuar a listagem do último resultado.
order_by

string

Opcional. Classificar resultados. Os valores aceitos são "name", "name desc" ou " "(unsorted)".
filter

string

Opcional. Filtro de lista.

ListInstancesResponse

Resposta para listar instâncias de notebook.

Campos
instances[]

Instance

Uma lista de instâncias retornadas.
next_page_token

string

Token de página que pode ser usado para continuar a listagem a partir do último resultado na próxima chamada de lista.
unreachable[]

string

Lista não ordenada. Locais que não puderam ser alcançados. Por exemplo, ['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b']. Uma ListInstancesResponse só vai conter instâncias ou inatingíveis.

NetworkInterface

A definição de um recurso de interface de rede anexado a uma VM.

Campos
network

string

Opcional. O nome da VPC em que esta instância de VM está. Formato: projects/{project_id}/global/networks/{network_id}
subnet

string

Opcional. O nome da sub-rede em que esta instância de VM está. Formato: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
nic_type

NicType

Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet.
access_configs[]

AccessConfig

Opcional. Uma matriz de configurações para essa interface. No momento, apenas uma configuração de acesso, ONE_TO_ONE_NAT, é aceita. Se nenhum accessConfigs for especificado, a instância terá um acesso externo à Internet por um endereço IP externo temporário.

NicType

O tipo de driver de vNIC. O padrão precisa ser NIC_TYPE_UNSPECIFIED.

Tipos enumerados
NIC_TYPE_UNSPECIFIED Nenhum tipo especificado.
VIRTIO_NET VIRTIO
GVNIC GVNIC

OperationMetadata

Representa os metadados da operação de longa duração.

Campos
create_time

Timestamp

A hora em que a operação foi criada.
end_time

Timestamp

O horário em que a operação terminou de ser executada.
target

string

Caminho do recurso definido pelo servidor para o destino da operação.
verb

string

Nome do verbo executado pela operação.
status_message

string

Status legível da operação, caso haja um.
requested_cancellation

bool

Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas com êxito têm o valor google.longrunning.Operation.error com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.
api_version

string

Versão da API usada para iniciar a operação.
endpoint

string

Nome do endpoint de API desta operação.

ResetInstanceRequest

Solicitação para redefinir uma instância de notebook

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.reset

ResizeDiskRequest

Solicitação para redimensionar os discos da instância de notebook

Campos
notebook_instance

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado notebookInstance:

  • notebooks.instances.update
Campo de união Disk. Tipo do disco que pode ser redimensionado: disco de inicialização ou de dados. Disk só pode ser um dos seguintes:
boot_disk

BootDisk

Obrigatório. O disco de inicialização a ser redimensionado. Somente disk_size_gb será usado.
data_disk

DataDisk

Obrigatório. O disco de dados a ser redimensionado. Somente disk_size_gb será usado.

RestoreInstanceRequest

Solicitação para restaurar a instância de notebook de um BackupSource.

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.update
Campo de união Source. Origem a ser restaurada. Source pode ser apenas de um dos tipos a seguir:
snapshot

Snapshot

Snapshot a ser usado para restauração.

RollbackInstanceRequest

Solicitação para reverter uma instância de notebook

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.rollback
target_snapshot

string

Obrigatório. O snapshot para reversão. Exemplo: "projects/test-project/global/snapshots/krwlzipynril".
revision_id

string

Obrigatório. Apenas saída. ID da revisão

ServiceAccount

Uma conta de serviço que atua como uma identidade.

Campos
email

string

Opcional. Endereço de e-mail da conta de serviço.
scopes[]

string

Apenas saída. A lista de escopos a serem disponibilizados para essa conta de serviço. Definido pelo CLH como https://www.googleapis.com/auth/cloud-platform

ShieldedInstanceConfig

Um conjunto de opções de instância protegida. Consulte Imagens que usam recursos de VM protegida compatíveis. Nem todas as combinações são válidas.

Campos
enable_secure_boot

bool

Opcional. Define se a instância de VM tem a Inicialização segura ativada.

A Inicialização segura ajuda a garantir que o sistema execute apenas softwares autênticos. Para isso, ela verifica a assinatura digital de todos os componentes de inicialização e interrompe o processo de inicialização se a verificação da assinatura falhar. Essa configuração está desativada por padrão.
enable_vtpm

bool

Opcional. Define se a instância de VM tem o vTPM ativado.
enable_integrity_monitoring

bool

Opcional. Define se o monitoramento de integridade está ativado na instância de VM.

Ativa o monitoramento e o atestado da integridade da inicialização da instância de VM. O atestado é realizado em relação ao valor de referência da política de integridade. Esse valor de referência é derivado inicialmente da imagem de inicialização implicitamente confiável quando a instância de VM é criada.

Snapshot

Snapshot representa o snapshot do disco de dados usado para restaurar a instância do Workbench. Refere-se a: compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}

Campos
snapshot_id

string

Obrigatório. O ID do snapshot.
project_id

string

Obrigatório. O ID do projeto do snapshot.

StartInstanceRequest

Solicitação para iniciar uma instância de notebook

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.start

Estado

A definição dos estados dessa instância.

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
STARTING A lógica de controle está iniciando a instância.
PROVISIONING A lógica de controle está instalando os frameworks necessários e registrando a instância com o proxy do notebook.
ACTIVE A instância está em execução.
STOPPING A lógica de controle está interrompendo a instância.
STOPPED A instância está parada.
DELETED A instância é excluída.
UPGRADING A instância está sendo atualizada.
INITIALIZING A instância está sendo criada.
SUSPENDING A instância está sendo suspensa.
SUSPENDED A instância está suspensa.

StopInstanceRequest

Solicitação para interromper uma instância de notebook

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.stop

SupportedValues

"SupportedValues" representa os valores aceitos pela configuração.

Campos
machine_types[]

string

Apenas saída. Os tipos de máquina compatíveis com o WbI.
accelerator_types[]

string

Apenas saída. Os tipos de aceleradores compatíveis com o WbI.

UpdateInstanceRequest

Solicitação para atualizar uma instância de notebook.

Campos
instance

Instance

Obrigatório. Uma representação de uma instância.

A autorização requer a seguinte permissão do IAM no recurso especificado instance:

  • iam.permissions.none
update_mask

FieldMask

Obrigatório. Máscara usada para atualizar uma instância. Campos atualizáveis:

  • 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

Opcional. UUID da solicitação idempotente.

UpgradeHistoryEntry

A entrada do histórico de upgrade de imagem de VM.

Campos
snapshot

string

Opcional. O snapshot do disco de inicialização da instância do notebook antes do upgrade.
vm_image

string

Opcional. A imagem da VM antes do upgrade da instância.
container_image

string

Opcional. A imagem do contêiner antes do upgrade da instância.
framework

string

Opcional. A estrutura da instância do notebook.
version

string

Opcional. A versão da instância de notebook antes deste upgrade.
state

State

Apenas saída. O estado desta entrada do histórico de upgrades da instância.
create_time

Timestamp

Imutável. O horário em que esta entrada do histórico de upgrades da instância foi criada.
action

Action

Opcional. Ação. Reverter ou fazer upgrade.
target_version

string

Opcional. Versão da VM de destino, como m63.

Ação

A definição das operações desta entrada do histórico de upgrade.

Tipos enumerados
ACTION_UNSPECIFIED A operação não foi especificada.
UPGRADE Faça upgrade.
ROLLBACK Rollback.

Estado

A definição dos estados desta entrada do histórico de upgrade.

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
STARTED O upgrade da instância é iniciado.
SUCCEEDED O upgrade da instância foi concluído.
FAILED O upgrade da instância falhou.

UpgradeInstanceRequest

Solicitação para fazer upgrade de uma instância de notebook

Campos
name

string

Obrigatório. Formato: projects/{project_id}/locations/{location}/instances/{instance_id}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.upgrade

VmImage

Definição de uma imagem personalizada de máquina virtual do Compute Engine para iniciar uma instância de notebook com o ambiente instalado diretamente na VM.

Campos
project

string

Obrigatório. O nome do projeto na nuvem do Google Cloud a que esta imagem de VM pertence. Formato: {project_id}
Campo de união image. A referência a uma imagem de VM externa do Compute Engine. image pode ser apenas de um dos tipos a seguir:
name

string

Opcional. Use o nome da imagem da VM para encontrar a imagem.
family

string

Opcional. Use essa família de imagens de VM para encontrar a imagem. A imagem mais recente dessa família será usada.