Package google.cloud.notebooks.v1

Índice

ManagedNotebookService

Serviço da API v1 para notebooks gerenciados.

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

Cria um novo ambiente de execução em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

Exclui um único ambiente de execução.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

Recebe detalhes de um único ambiente de execução. O local precisa ser um endpoint regional, não zonal.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

Lista os runtimes em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation)

Migrar um ambiente de execução atual para uma nova instância do Workbench.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

Gera relatórios e processa um evento de tempo de execução.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

Redefine um ambiente de execução de notebook gerenciado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

Inicia um ambiente de execução de notebook gerenciado. Execute "Iniciar" em instâncias de GPU e "Retomar" em instâncias de CPU. Consulte: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

Interrompe um ambiente de execução de notebook gerenciado. Execute "Parar" em instâncias de GPU e "Suspender" em instâncias de CPU. Consulte: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

Trocar um ambiente de execução de notebook gerenciado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

Atualize a configuração do ambiente de execução do notebook.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

NotebookService

Serviço da API v1 para Notebooks do AI Platform do Cloud.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

Cria um novo ambiente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

Cria uma nova execução em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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 um dos seguintes escopos do OAuth:

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

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

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

Cria um notebook programado em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

Exclui um único ambiente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc DeleteExecution(DeleteExecutionRequest) returns (Operation)

Exclui a execução

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Exclui uma única instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation)

Exclui a programação e todos os jobs subjacentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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 com base em uma instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

Recebe detalhes de um único ambiente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc GetExecution(GetExecutionRequest) returns (Execution)

Recebe detalhes das execuções

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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 um dos seguintes escopos do OAuth:

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

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

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

Verifica se uma instância de notebook está íntegra.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

Recebe detalhes da programação

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

Lista os ambientes em um projeto.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

Lista as execuções em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Lista as instâncias em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

Lista os agendamentos em determinado projeto e local.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc MigrateInstance(MigrateInstanceRequest) returns (Operation)

Migra um notebook gerenciado pelo usuário para instâncias do Workbench.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

Registra uma instância de notebook legada no servidor da API Notebooks. As instâncias legadas são criadas com as chamadas legadas do Compute Engine. Eles não podem ser gerenciados pela API Notebooks de imediato. Essa chamada torna essas instâncias gerenciáveis pela API Notebooks.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

Permite que as instâncias de notebook informem as informações mais recentes da instância ao servidor da API Notebooks. O servidor vai mesclar as informações informadas ao armazenamento de metadados da instância. Não use esse método diretamente.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

Redefine uma instância de notebook.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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 um dos seguintes escopos do OAuth:

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

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

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

Atualiza os aceleradores convidados de uma única instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

Substitui todos os rótulos de uma instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation)

Atualiza o tipo de máquina de uma única instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc StartInstance(StartInstanceRequest) returns (Operation)

Inicia uma instância de notebook.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc StopInstance(StopInstanceRequest) returns (Operation)

Interrompe uma instância de notebook.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

Atualize as configurações da instância de notebook.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

Adiciona/atualiza itens de metadados para uma instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

Atualiza a configuração de instância protegida de uma única instância.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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 um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

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

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

CreateEnvironmentRequest

Solicitação para criar um ambiente de notebook.

Campos
parent

string

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

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

  • notebooks.environments.create
environment_id

string

Obrigatório. ID exclusivo definido pelo usuário deste ambiente. O environment_id precisa ter de 1 a 63 caracteres e conter apenas letras minúsculas, caracteres numéricos e traços. O primeiro caractere precisa ser uma letra minúscula, e o último não pode ser um traço.
environment

Environment

Obrigatório. O ambiente a ser criado.

CreateExecutionRequest

Solicitação para criar uma execução 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.executions.create
execution_id

string

Obrigatório. ID exclusivo definido pelo usuário desta execução.
execution

Execution

Obrigatório. A execução a ser criada.

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.

CreateRuntimeRequest

Solicitação para criar um ambiente de execução de notebook gerenciado.

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.runtimes.create
runtime_id

string

Obrigatório. ID exclusivo definido pelo usuário deste ambiente de execução.
runtime

Runtime

Obrigatório. O ambiente de execução a ser criado.
request_id

string

UUID da solicitação idempotente.

CreateScheduleRequest

Solicitação de notebooks programados criados

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.schedules.create
schedule_id

string

Obrigatório. ID exclusivo definido pelo usuário desta programação.
schedule

Schedule

Obrigatório. A programação a ser criada.

DeleteEnvironmentRequest

Solicitação para excluir um ambiente de notebook.

Campos
name

string

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

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

  • notebooks.environments.delete

DeleteExecutionRequest

Solicitação para excluir uma execução programada de notebook

Campos
name

string

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

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

  • notebooks.executions.delete

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

DeleteRuntimeRequest

Solicitação para excluir um ambiente de execução de notebook gerenciado.

Campos
name

string

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

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

  • notebooks.runtimes.delete
request_id

string

UUID da solicitação idempotente.

DeleteScheduleRequest

Solicitação para excluir uma programação

Campos
name

string

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

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

  • notebooks.schedules.delete

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}
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 atingir o tempo limite.

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/
repair_flag_enabled

bool

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

bool

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

bool

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

EncryptionConfig

Representa uma configuração de chave de criptografia personalizada que pode ser aplicada a um recurso. Isso vai criptografar todos os discos na máquina virtual.

Campos
kms_key

string

O identificador de recurso do Cloud KMS da chave de criptografia gerenciada pelo cliente usada para proteger um recurso, como um disco. Ele tem o seguinte formato: projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

Ambiente

Definição de um ambiente de software usado para iniciar uma instância de notebook.

Campos
name

string

Apenas saída. Nome deste ambiente. Formato: projects/{project_id}/locations/{location}/environments/{environment_id}
display_name

string

Nome de exibição deste ambiente para a UI.
description

string

Uma breve descrição do ambiente.
post_startup_script

string

Caminho para um script Bash executado automaticamente após a inicialização completa de uma instância de notebook. O caminho precisa ser um URL ou do Cloud Storage. Exemplo: "gs://path-to-file/file-name"
create_time

Timestamp

Apenas saída. O horário em que este ambiente foi criado.
Campo de união image_type. Tipo do ambiente. Pode ser uma imagem de VM ou imagem do contêiner. image_type pode ser apenas de um dos tipos a seguir:
vm_image

VmImage

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

ContainerImage

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

Evento

A definição de um evento para uma instância de notebook gerenciada / semigerenciada.

Campos
report_time

Timestamp

Horário do relatório de eventos.
type

EventType

Tipo de evento.
details

map<string, string>

Opcional. Detalhes do evento. Esse campo é usado para transmitir informações de eventos.

EventType

A definição dos tipos de evento.

Tipos enumerados
EVENT_TYPE_UNSPECIFIED O evento não foi especificado.
IDLE A instância / o ambiente de execução está inativo
HEARTBEAT A instância / o ambiente de execução está disponível. Esse evento indica que a instância / o tempo de execução do cálculo subjacente está operacional.
HEALTH A integridade da instância / do ambiente de execução está disponível. Esse evento indica informações de integridade da instância / do ambiente de execução.
MAINTENANCE A instância / o ambiente de execução está disponível. Esse evento permite que a instância / o tempo de execução envie informações de manutenção do host para o plano de controle. https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

Execução

A definição de um único notebook executado.

Campos
execution_template

ExecutionTemplate

executar metadados, incluindo nome, especificação de hardware, região, rótulos etc.
name

string

Apenas saída. O nome do recurso da execução. Formato: projects/{project_id}/locations/{location}/executions/{execution_id}
display_name

string

Apenas saída. Nome usado para fins UI. O nome só pode conter caracteres alfanuméricos e sublinhados "_".
description

string

Uma breve descrição desta execução.
create_time

Timestamp

Apenas saída. Hora em que a execução foi instanciada.
update_time

Timestamp

Apenas saída. Hora em que a execução foi atualizada pela última vez.
state

State

Apenas saída. Estado do job da AI Platform subjacente.
output_notebook_file

string

Arquivo de notebook de saída gerado por esta execução
job_uri

string

Apenas saída. O URI do job externo usado para executar o notebook.

Estado

Descrição da enumeração do estado do job do AIP subjacente.

Tipos enumerados
STATE_UNSPECIFIED O estado do job não foi especificado.
QUEUED O job acabou de ser criado e o processamento ainda não começou.
PREPARING O serviço está se preparando para executar o job.
RUNNING O job está em andamento.
SUCCEEDED O job foi concluído.
FAILED O job falhou. error_message deve conter os detalhes da falha.
CANCELLING O job está sendo cancelado. error_message deve descrever o motivo do cancelamento.
CANCELLED O job foi cancelado. error_message deve descrever o motivo do cancelamento.
EXPIRED O job expirou (relevante para jobs da Vertex AI)
INITIALIZING A execução está sendo criada.

ExecutionTemplate

A descrição de uma carga de trabalho de execução de notebook.

Campos
scale_tier
(deprecated)

ScaleTier

Obrigatório. Nível de escalonamento do hardware usado para a execução do notebook. DEPRECATED Será descontinuado. No momento, apenas PERSONALIZADA é compatível.
master_type

string

Especifica o tipo de máquina virtual que será usado para o worker mestre do job de treinamento. Especifique esse campo quando scaleTier estiver definido como CUSTOM.

É possível usar certos tipos de máquina do Compute Engine diretamente nesse campo. Veja a seguir os tipos compatíveis:

  • 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, use os seguintes tipos de máquina legados:

  • 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 fim, se você quiser usar uma TPU para treinamento, especifique cloud_tpu neste campo. Saiba mais sobre as opções especiais de configuração para treinamento com TPU.
accelerator_config

SchedulerAcceleratorConfig

Configuração (contagem e tipo de acelerador) para a execução do notebook em hardware.
labels

map<string, string>

Rótulos para execução. Se a execução for programada, um campo incluído será "nbs-scheduled". Caso contrário, será uma execução imediata, e um campo incluído será "nbs-immediate". Use campos para indexar com eficiência entre vários tipos de execuções.
input_notebook_file

string

Caminho para o arquivo de notebook a ser executado. Precisa estar em um bucket do Google Cloud Storage. Formato: gs://{bucket_name}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
container_image_uri

string

URI da imagem do contêiner para um exemplo de DLVM: "gcr.io/deeplearning-platform-release/base-cu100". Mais exemplos podem ser encontrados em: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
output_notebook_folder

string

Caminho para a pasta do notebook em que será feita a gravação. Precisa estar em um caminho de bucket do Google Cloud Storage. Formato: gs://{bucket_name}/{folder} Ex: gs://notebook_user/scheduled_notebooks
params_yaml_file

string

Parâmetros a serem substituídos no notebook durante a execução. Consulte https://papermill.readthedocs.io/en/latest/usage-parameterize.html para saber como especificar parâmetros no notebook de entrada e transmiti-los aqui em um arquivo YAML. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

Parâmetros usados no notebook "input_notebook_file".
service_account

string

O endereço de e-mail de uma conta de serviço a ser usada ao executar a execução. Você precisa ter a permissão iam.serviceAccounts.actAs para a conta de serviço especificada.
job_type

JobType

O tipo de trabalho a ser usado nesta execução.
kernel_spec

string

Nome da especificação do kernel a ser usada. Isso precisa ser especificado se o nome da especificação do kernel no destino de execução não corresponder ao nome no arquivo de notebook de entrada.
tensorboard

string

O nome de um recurso do [TensorBoard] da Vertex AI em que esta execução vai fazer upload dos registros do TensorBoard. Formato: projects/{project}/locations/{location}/tensorboards/{tensorboard}
Campo de união job_parameters. Parâmetros para um tipo de execução. OBSERVAÇÃO: no momento, não há parâmetros extras para jobs da Vertex AI. job_parameters pode ser apenas de um dos tipos a seguir:
dataproc_parameters

DataprocParameters

Parâmetros usados em execuções de JobType do Dataproc.
vertex_ai_parameters

VertexAIParameters

Parâmetros usados em execuções de JobType da Vertex AI.

DataprocParameters

Parâmetros usados em execuções de JobType do Dataproc.

Campos
cluster

string

URI do cluster usado para executar o Dataproc. Formato: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

O back-end usado para esta execução.

Tipos enumerados
JOB_TYPE_UNSPECIFIED Nenhum tipo especificado.
VERTEX_AI Job personalizado em aiplatform.googleapis.com. Valor padrão de uma execução.
DATAPROC Execute a execução em um cluster com o Dataproc como um job. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

Obrigatório. Especifica os tipos de máquina, o número de réplicas dos workers e os servidores de parâmetros.

Tipos enumerados
SCALE_TIER_UNSPECIFIED Nível de escalonamento não especificado.
BASIC Uma única instância de worker. Esse nível é adequado para aprender a usar o Cloud ML e testar novos modelos usando pequenos conjuntos de dados.
STANDARD_1 Muitos workers e poucos servidores de parâmetros.
PREMIUM_1 Um grande número de workers com muitos servidores de parâmetros.
BASIC_GPU Uma única instância de worker com uma GPU K80.
BASIC_TPU Uma única instância de worker com um Cloud TPU.
CUSTOM

CUSTOM não é um nível definido. Na verdade, ela permite que você use sua própria especificação de cluster. Ao usá-lo, defina valores para configurar o cluster de processamento de acordo com estas diretrizes:

  • É necessário definir ExecutionTemplate.masterType para especificar o tipo de máquina que será usado para o nó mestre. Essa é a única configuração obrigatória.

SchedulerAcceleratorConfig

Definição de um acelerador de hardware. Nem todas as combinações de type e core_count são válidas. Consulte GPUs no Compute Engine para encontrar uma combinação válida. TPUs não são compatíveis.

Campos
type

SchedulerAcceleratorType

Tipo do acelerador.
core_count

int64

Contagem de núcleos deste acelerador.

SchedulerAcceleratorType

Tipos de aceleradores de hardware para jobs do AI Platform Training.

Tipos enumerados
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED Tipo de acelerador não especificado. O padrão é nenhuma GPU.
NVIDIA_TESLA_K80 GPU Nvidia Tesla K80.
NVIDIA_TESLA_P100 GPU Nvidia Tesla P100.
NVIDIA_TESLA_V100 GPU Nvidia Tesla V100.
NVIDIA_TESLA_P4 GPU Nvidia Tesla P4.
NVIDIA_TESLA_T4 GPU NVIDIA Tesla T4.
NVIDIA_TESLA_A100 GPU Nvidia Tesla A100.
TPU_V2 TPU v2.
TPU_V3 TPU v3.

VertexAIParameters

Parâmetros usados em execuções de JobType da Vertex AI.

Campos
network

string

O nome completo da rede do Compute Engine com que o job fará peering. Por exemplo, projects/12345/global/networks/myVPC. O formato está na forma projects/{project}/global/networks/{network}. Em que {project} é um número de projeto, como em 12345, e {network} é um nome de rede.

O acesso a serviços particulares já precisa estar configurado na rede. Se não for especificado, o job não fará peering com nenhuma rede.
env

map<string, string>

Variáveis de ambiente. É possível especificar no máximo 100 variáveis de ambiente exclusivas. Exemplo: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

Solicitação para receber um ambiente de notebook.

Campos
name

string

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

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

  • notebooks.environments.get

GetExecutionRequest

Solicitação para receber a execução programada do notebook

Campos
name

string

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

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

  • notebooks.executions.get

GetInstanceHealthRequest

Solicitação para verificar se uma instância de notebook está íntegra.

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

GetInstanceHealthResponse

Resposta para verificar se uma instância de notebook está íntegra.

Campos
health_state

HealthState

Apenas saída. Runtime health_state.
health_info

map<string, string>

Apenas saída. Informações adicionais sobre a integridade da instância. 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

Se uma instância está íntegra ou não.

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

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

GetRuntimeRequest

Solicitação para receber um ambiente de execução de notebook gerenciado.

Campos
name

string

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

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

  • notebooks.runtimes.get

GetScheduleRequest

Solicitação para receber um notebook programado.

Campos
name

string

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

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

  • notebooks.schedules.get

Instância

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

Campos
name

string

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

string

Caminho para um script Bash executado automaticamente após a inicialização completa de uma instância de notebook. O caminho precisa ser um URL ou do Cloud Storage (gs://path-to-file/file-name).
proxy_uri

string

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

string

Somente entrada. 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.
service_account

string

A conta de serviço nessa instância, que dá acesso a outros serviços do Google Cloud. É possível usar qualquer conta de serviço no mesmo projeto, mas você precisa ter a permissão de usuário da conta de serviço para usar a instância.

Se não for especificada, a conta de serviço padrão do Compute Engine será usada.
service_account_scopes[]

string

Opcional. Os URIs dos escopos de conta de serviço a serem incluídos nas instâncias do Compute Engine.

Se não forem especificados, os seguintes escopos serão definidos: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email Se você não estiver usando os escopos padrão, precisará de pelo menos: https://www.googleapis.com/auth/compute
machine_type

string

Obrigatório. O tipo de máquina do Compute Engine desta instância.
accelerator_config

AcceleratorConfig

O acelerador de hardware usado 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.
state

State

Apenas saída. O estado desta instância.
install_gpu_driver

bool

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

string

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

DiskType

Somente entrada. O tipo do disco de inicialização anexado a esta instância, que tem como padrão o disco permanente padrão (PD_STANDARD).
boot_disk_size_gb

int64

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

DiskType

Somente entrada. O tipo de disco de dados anexado a esta instância, que tem como padrão o disco permanente padrão (PD_STANDARD).
data_disk_size_gb

int64

Somente entrada. O tamanho do disco de dados em GB anexado a esta instância, até um máximo de 64.000 GB (64 TB). Você pode escolher o tamanho do disco de dados com base no tamanho dos notebooks e dos dados. Se não for especificado, o padrão será 100.
no_remove_data_disk

bool

Somente entrada. Se for "true", o disco de dados não será excluído automaticamente ao excluir a instância.
disk_encryption

DiskEncryption

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

string

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.
disks[]

Disk

Apenas saída. Discos anexados à instância de notebook.
shielded_instance_config

ShieldedInstanceConfig

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

bool

Se for "true", nenhum IP externo será atribuído a essa instância.
no_proxy_access

bool

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

string

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

string

O nome da sub-rede em que a instância está. Formato: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
labels

map<string, string>

Rótulos a serem aplicados a esta instância. Elas podem ser modificadas mais tarde pelo método "setLabels".
metadata

map<string, string>

Metadados personalizados para aplicar a esta instância. Por exemplo, para especificar um bucket do Cloud Storage para backup automático, use a tag de metadados gcs-data-bucket. Formato: "--metadata=gcs-data-bucket=BUCKET".
tags[]

string

Opcional. As tags de rede do Compute Engine a serem adicionadas ao tempo de execução. Consulte Adicionar tags de rede.
upgrade_history[]

UpgradeHistoryEntry

O histórico de upgrades desta instância.
nic_type

NicType

Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet.
reservation_affinity

ReservationAffinity

Opcional. A afinidade de reserva opcional. Definir esse campo vai aplicar a reserva de computação zonal especificada a esta instância de notebook.
creator

string

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

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

InstanceMigrationEligibility

Apenas saída. Verifica a viabilidade de uma migração do UmN para o WbI.
Campo de união environment. Tipo do ambiente. Pode ser uma imagem de VM ou imagem do contêiner. environment pode ser apenas de um dos tipos a seguir:
vm_image

VmImage

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

ContainerImage

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

bool

Apenas saída. Booleano que indica se este notebook foi migrado para uma instância do Workbench

AcceleratorConfig

Definição de um acelerador de hardware. Nem todas as combinações de type e core_count são válidas. Consulte GPUs no Compute Engine para encontrar uma combinação válida. TPUs não são compatíveis.

Campos
type

AcceleratorType

Tipo do acelerador.
core_count

int64

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_K80 O tipo de acelerador é Nvidia Tesla K80.
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.
NVIDIA_L4 O tipo de acelerador é Nvidia Tesla L4.
NVIDIA_A100_80GB O tipo de acelerador é Nvidia Tesla A100 de 80 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_H100_80GB O tipo de acelerador é NVIDIA H100 de 80 GB.
NVIDIA_H100_MEGA_80GB O tipo de acelerador é NVIDIA H100 Mega de 80 GB.
TPU_V2 (Em breve) O tipo de acelerador é TPU V2.
TPU_V3 (Em breve) O tipo de acelerador é TPU V3.

Disco

Um recurso de disco anexado à instância.

Campos
auto_delete

bool

Indica se o disco será excluído automaticamente quando a instância for excluída (mas não quando o disco for desconectado da instância).
boot

bool

Indica que este é um disco de inicialização. A máquina virtual vai usar a primeira partição do disco para o sistema de arquivos raiz.
device_name

string

Indica um nome de dispositivo exclusivo de sua escolha que é refletido na árvore /dev/disk/by-id/google-* de um sistema operacional Linux em execução na instância. Esse nome pode ser usado para fazer referência ao dispositivo durante a montagem, o redimensionamento e outras ações na instância.

Se não for especificado, o servidor vai escolher um nome de dispositivo padrão para aplicar a esse disco, no formato persistent-disk-x, em que x é um número atribuído pelo Google Compute Engine.Esse campo só é aplicável a discos permanentes.
disk_size_gb

int64

Indica o tamanho do disco em GB de base 2.
guest_os_features[]

GuestOsFeature

Indica uma lista de recursos a serem ativados no sistema operacional convidado. Aplicável apenas a imagens inicializáveis. Leia "Ativar recursos do sistema operacional convidado" para conferir uma lista de opções disponíveis.
index

int64

Um índice baseado em zero para este disco, em que 0 é reservado para o disco de inicialização. Se você tiver muitos discos anexados a uma instância, cada um terá um número de índice exclusivo.
interface

string

Indica a interface de disco a ser usada para anexar este disco, que é SCSI ou NVME. O padrão é SCSI. Os discos permanentes sempre precisam usar SCSI, e a solicitação vai falhar se você tentar anexar um disco permanente em qualquer outro formato. Os SSDs locais podem usar NVME ou SCSI. Para conhecer as características de desempenho do SCSI no NVMe, consulte "Desempenho do SSD local". Valores válidos:

  • NVME
  • SCSI
kind

string

Tipo do recurso. Sempre compute#attachedDisk para discos anexados.
licenses[]

string

Uma lista de licenças visíveis publicamente. Reservado para uso do Google. Uma licença representa dados de faturamento e uso agregado para imagens públicas e do marketplace.
mode

string

O modo em que este disco será anexado, READ_WRITE ou READ_ONLY. Se não for especificado, o padrão será anexar o disco no modo READ_WRITE. Valores válidos:

  • READ_ONLY
  • READ_WRITE
source

string

Indica um URL parcial ou completo válido para um recurso de Persistent Disk existente.
type

string

Indica o tipo de disco, SCRATCH ou PERSISTENT. Valores válidos:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

Recursos do SO convidado para o disco de inicialização.

Campos
type

string

O ID de um recurso compatível. Leia "Ativar recursos do sistema operacional convidado" para conferir uma lista de opções disponíveis. Valores válidos:

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

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 para instâncias de notebook.

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.

NicType

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

Tipos enumerados
UNSPECIFIED_NIC_TYPE Nenhum tipo especificado.
VIRTIO_NET VIRTIO
GVNIC GVNIC

ShieldedInstanceConfig

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

Campos
enable_secure_boot

bool

Define se a Inicialização segura está ativada na instância.

A Inicialização segura ajuda a garantir que o sistema execute apenas um software autêntico por meio da verificação da assinatura digital de todos os componentes de inicialização e da interrupção do processo de inicialização se a verificação da assinatura falhar. Essa configuração está desativada por padrão.
enable_vtpm

bool

Define se a instância tem o vTPM ativado. Ativado por padrão.
enable_integrity_monitoring

bool

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

Permite o monitoramento e o atestado da integridade da inicialização da instância. 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 é criada. Ativado por padrão.

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.
REGISTERING A instância está sendo registrada.
SUSPENDING A instância está sendo suspensa.
SUSPENDED A instância está suspensa.

UpgradeHistoryEntry

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

Campos
snapshot

string

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

string

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

string

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

string

O framework desta instância de notebook.
version

string

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

State

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

Timestamp

O horário em que esta entrada do histórico de upgrade da instância foi criada.
target_image
(deprecated)

string

Imagem da VM de destino. Formato: ainotebooks-vm/project/image-name/name.
action

Action

Ação. Reverter ou fazer upgrade.
target_version

string

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 Nenhuma operaçã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.

InstanceConfig

Configurações de instâncias de notebook que podem ser atualizadas.

Campos
notebook_upgrade_schedule

string

Expressão cron no fuso horário UTC, usada para programar o upgrade automático da instância. Siga o formato cron.
enable_health_monitoring

bool

Verifica se os serviços internos principais estão em execução.

InstanceMigrationEligibility

"InstanceMigrationEligibility" representa as informações de viabilidade de uma migração do UmN para o WbI.

Campos
warnings[]

Warning

Apenas saída. Algumas configurações serão definidas como padrão durante a migração.
errors[]

Error

Apenas saída. Algumas configurações tornam o UmN inelegível para uma migração automática. É necessária uma migração manual.

Erro

Uma mensagem de erro de migração significa que determinadas configurações tornam o UmN inelegível para uma migração automática. É necessária uma migração manual.

Tipos enumerados
ERROR_UNSPECIFIED Tipo padrão.
DATAPROC_HUB O UmN usa o hub do Dataproc e não pode ser migrado.

Aviso

Uma mensagem de aviso de migração significa que algumas configurações serão definidas como padrão durante a migração.

Tipos enumerados
WARNING_UNSPECIFIED Tipo padrão.
UNSUPPORTED_MACHINE_TYPE O UmN usa um tipo de máquina que não tem suporte no WbI. Ele será migrado com o tipo de máquina padrão e2-standard-4. Os usuários podem mudar o tipo de máquina depois da migração.
UNSUPPORTED_ACCELERATOR_TYPE O UmN usa um tipo de acelerador que não é compatível com o WbI. Ele será migrado sem um acelerador. O usuário pode anexar um acelerador após a migração.
UNSUPPORTED_OS O UmN usa um sistema operacional que não é compatível com o WbI (por exemplo, Debian 10, Ubuntu). Ele será substituído pelo Debian 11 no WbI.
NO_REMOVE_DATA_DISK Esta UmN está configurada com no_remove_data_disk, que não está mais disponível no WbI.
GCS_BACKUP Este UmN é configurado com o recurso de backup do Cloud Storage, que não está mais disponível no WbI.
POST_STARTUP_SCRIPT Essa UmN está configurada com um script pós-inicialização. Se quiser, forneça o post_startup_script_option para a migração.

IsInstanceUpgradeableRequest

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
type

UpgradeType

Opcional. O UpgradeType opcional. Definir esse campo vai pesquisar outras imagens de computação para fazer upgrade da instância.

IsInstanceUpgradeableResponse

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 autônomo da imagem para o qual esta instância será atualizada se o endpoint de upgrade for chamado. Esse campo só será preenchido se "upgradeable" for verdadeiro.

ListEnvironmentsRequest

Solicitação para listar ambientes.

Campos
parent

string

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

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

  • notebooks.environments.list
page_size

int32

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

string

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

ListEnvironmentsResponse

Resposta para listar ambientes.

Campos
environments[]

Environment

Uma lista de ambientes retornados.
next_page_token

string

Um token de página que pode ser usado para continuar listando do último resultado na próxima chamada de lista.
unreachable[]

string

Locais que não puderam ser alcançados.

ListExecutionsRequest

Solicitação para listar execuções programadas de notebooks.

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.executions.list
page_size

int32

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

string

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

string

Filtro aplicado às execuções resultantes. No momento, só é possível filtrar execuções por um schedule_id especificado. Formato: schedule_id=<Schedule_ID>
order_by

string

Ordenar por campo.

ListExecutionsResponse

Resposta para listar execuções programadas de notebooks

Campos
executions[]

Execution

Uma lista de instâncias retornadas.
next_page_token

string

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

string

IDs de execução que não puderam ser alcançados. Por exemplo:

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

ListInstancesRequest

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

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.list
page_size

int32

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

string

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 do último resultado na próxima chamada de lista.
unreachable[]

string

Locais que não puderam ser alcançados. Por exemplo, ['us-west1-a', 'us-central1-b'] Um ListInstancesResponse só vai conter instâncias ou inacessíveis.

ListRuntimesRequest

Solicitação para listar ambientes de execução de notebooks gerenciados.

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.runtimes.list
page_size

int32

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

string

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.

ListRuntimesResponse

Resposta para listar tempos de execução de notebooks gerenciados.

Campos
runtimes[]

Runtime

Uma lista de tempos de execução retornados.
next_page_token

string

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

string

Locais que não puderam ser alcançados. Por exemplo, ['us-west1', 'us-central1'] Uma ListRuntimesResponse só vai conter runtimes ou unreachables.

ListSchedulesRequest

Solicitação para listar o job de notebook programado.

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.schedules.list
page_size

int32

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

string

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

string

Filtro aplicado às programações resultantes.
order_by

string

Campo para ordenar os resultados.

ListSchedulesResponse

Resposta para listar um job de notebook programado.

Campos
schedules[]

Schedule

Uma lista de instâncias retornadas.
next_page_token

string

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

string

Programações que não puderam ser alcançadas. Por exemplo:

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

LocalDisk

Um recurso de disco anexado local.

Campos
auto_delete

bool

Opcional. Apenas saída. Especifica se o disco será excluído automaticamente quando a instância for excluída (mas não quando o disco for desanexado da instância).
boot

bool

Opcional. Apenas saída. Indica que este é um disco de inicialização. A máquina virtual vai usar a primeira partição do disco para o sistema de arquivos raiz.
device_name

string

Opcional. Apenas saída. Especifica um nome de dispositivo exclusivo de sua escolha que é refletido na árvore /dev/disk/by-id/google-* de um sistema operacional Linux em execução na instância. Esse nome pode ser usado para fazer referência ao dispositivo durante a montagem, o redimensionamento e outras ações na instância.

Se não for especificado, o servidor vai escolher um nome de dispositivo padrão para aplicar a esse disco, no formato persistent-disk-x, em que x é um número atribuído pelo Google Compute Engine. Esse campo só é aplicável a discos permanentes.
guest_os_features[]

RuntimeGuestOsFeature

Apenas saída. Indica uma lista de recursos a serem ativados no sistema operacional convidado. Aplicável apenas a imagens inicializáveis. Leia "Ativar recursos do sistema operacional convidado" para conferir uma lista de opções disponíveis.
index

int32

Apenas saída. Um índice baseado em zero para este disco, em que 0 é reservado para o disco de inicialização. Se você tiver muitos discos anexados a uma instância, cada um terá um número de índice exclusivo.
initialize_params

LocalDiskInitializeParams

Somente entrada. Especifica os parâmetros de um novo disco que será criado junto com a nova instância. Use parâmetros de inicialização para criar discos de inicialização ou SSDs locais anexados à nova instância.

Essa propriedade é mutuamente exclusiva com a propriedade de origem. Só é possível definir uma ou outra, mas não ambas.
interface

string

Especifica a interface de disco a ser usada para anexar este disco, que é SCSI ou NVME. O padrão é SCSI. Os discos permanentes sempre precisam usar SCSI, e a solicitação vai falhar se você tentar anexar um disco permanente em qualquer outro formato. Os SSDs locais podem usar NVME ou SCSI. Para conhecer as características de desempenho do SCSI no NVMe, consulte "Desempenho do SSD local". Valores válidos:

  • NVME
  • SCSI
kind

string

Apenas saída. Tipo do recurso. Sempre compute#attachedDisk para discos anexados.
licenses[]

string

Apenas saída. Quaisquer licenças válidas visíveis publicamente.
mode

string

O modo em que este disco será anexado, READ_WRITE ou READ_ONLY. Se não for especificado, o padrão será anexar o disco no modo READ_WRITE. Valores válidos:

  • READ_ONLY
  • READ_WRITE
source

string

Especifica um URL parcial ou completo válido para um recurso de disco permanente.
type

string

Especifica o tipo de disco, SCRATCH ou PERSISTENT. Se não for especificado, o padrão será PERSISTENT. Valores válidos:

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

Opcional. Uma lista de recursos a serem ativados no sistema operacional convidado. Aplicável apenas a imagens inicializáveis. Leia Ativar recursos do sistema operacional convidado para conferir uma lista de opções disponíveis. Recursos do SO convidado para o disco de inicialização.

Campos
type

string

O ID de um recurso compatível. Leia Ativar recursos do sistema operacional convidado para conferir uma lista de opções disponíveis.

Valores válidos:

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

LocalDiskInitializeParams

Somente entrada. Especifica os parâmetros de um novo disco que será criado junto com a nova instância. Use parâmetros de inicialização para criar discos de inicialização ou SSDs locais anexados ao novo ambiente de execução. Essa propriedade é mutuamente exclusiva com a propriedade de origem. Só é possível definir uma ou outra, mas não ambas.

Campos
description

string

Opcional. Informe essa propriedade ao criar o disco.
disk_name

string

Opcional. Especifica o nome do disco. Se não for especificado, o padrão será usar o nome da instância. Se o disco com o nome da instância já existir na zona/região especificada, um novo nome será gerado automaticamente.
disk_size_gb

int64

Opcional. Especifica o tamanho do disco em GB de base 2. Se não for especificado, o disco terá o mesmo tamanho da imagem (geralmente 10 GB). Se especificado, o tamanho precisa ser igual ou maior que 10 GB. Padrão de 100 GB.
disk_type

DiskType

Somente entrada. O tipo do disco de inicialização anexado a esta instância, que tem como padrão o disco permanente padrão (PD_STANDARD).
labels

map<string, string>

Opcional. Rótulos a serem aplicados a este disco. Elas podem ser modificadas posteriormente pelo método "disks.setLabels". Esse campo só é aplicável a discos permanentes.

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.

MigrateInstanceRequest

Solicitação de migração de um notebook gerenciado pelo usuário para instâncias do Workbench.

Campos
name

string

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

A autorização requer uma ou mais das seguintes permissões de IAM no recurso name especificado:

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

PostStartupScriptOption

Opcional. Especifica o comportamento do script pós-inicialização durante a migração.

PostStartupScriptOption

Especifica o comportamento do script pós-inicialização durante a migração.

Tipos enumerados
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED A opção de script pós-inicialização não foi especificada. O padrão é POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP Não migrar o script de pós-inicialização para a nova instância do Workbench.
POST_STARTUP_SCRIPT_OPTION_RERUN Faça o download e execute novamente o mesmo script de pós-inicialização do notebook gerenciado pelo usuário.

MigrateInstanceResponse

Esse tipo não tem campos.

Tipo de resposta de mensagem em branco para MigrateInstance.

MigrateRuntimeRequest

Solicitação para migrar um ambiente de execução para uma instância do Workbench.

Campos
name

string

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

A autorização requer uma ou mais das seguintes permissões de IAM no recurso name especificado:

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

string

Opcional. Nome da VPC em que a nova instância está. Isso é obrigatório se o ambiente de execução usar uma rede gerenciada pelo Google. Se o ambiente de execução usar uma rede de propriedade do cliente, ele vai reutilizar a mesma VPC, e esse campo precisa estar vazio. Formato: projects/{project_id}/global/networks/{network_id}
subnet

string

Opcional. Nome da sub-rede em que a nova instância está. Isso é obrigatório se o ambiente de execução usar uma rede gerenciada pelo Google. Se o ambiente de execução usar a rede do cliente, ele vai reutilizar a mesma sub-rede, e esse campo precisa estar vazio. Formato: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account

string

Opcional. A conta de serviço a ser incluída na instância do Compute Engine da nova instância do Workbench quando o ambiente de execução usa o modo "somente usuário único" para permissão. Se não for especificada, a conta de serviço padrão do Compute Engine será usada. Quando o ambiente de execução usa o modo de conta de serviço para permissão, ele reutiliza a mesma conta de serviço, e esse campo precisa estar vazio.
request_id

string

Opcional. UUID da solicitação idempotente.
post_startup_script_option

PostStartupScriptOption

Opcional. Especifica o comportamento do script pós-inicialização durante a migração.

PostStartupScriptOption

Especifica o comportamento do script pós-inicialização durante a migração.

Tipos enumerados
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED A opção de script pós-inicialização não foi especificada. O padrão é POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP Não migrar o script de pós-inicialização para a nova instância do Workbench.
POST_STARTUP_SCRIPT_OPTION_RERUN Baixe e execute novamente o mesmo script de inicialização pós-inicialização do notebook gerenciado pelo Google.

OperationMetadata

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

Campos
create_time

Timestamp

O horário em que a operação foi criada.
end_time

Timestamp

A hora 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.

RegisterInstanceRequest

Solicitação para registrar 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. O instance_id precisa ter de 1 a 63 caracteres e conter apenas letras minúsculas, caracteres numéricos e traços. O primeiro caractere precisa ser uma letra minúscula, e o último não pode ser um traço.

ReportInstanceInfoRequest

Solicitação para que as instâncias de notebook informem dados à API Notebooks.

Campos
name

string

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

string

Obrigatório. O token de hardware da VM para autenticar a VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata

map<string, string>

Os metadados informados à API Notebooks. Isso será mesclado ao repositório de metadados da instância.

ReportRuntimeEventRequest

Solicitação para informar um evento de notebook gerenciado.

Campos
name

string

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

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

  • iam.permissions.none
vm_id

string

Obrigatório. O token de hardware da VM para autenticar a VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event

Event

Obrigatório. O evento a ser denunciado.

ReservationAffinity

Afinidade de reserva para consumir uma reserva zonal.

Campos
consume_reservation_type

Type

Opcional. Tipo de reserva a ser consumida
key

string

Opcional. Corresponde à chave do rótulo do recurso de reserva.
values[]

string

Opcional. Corresponde aos valores de rótulo do recurso de reserva.

Tipo

Indica se é necessário consumir capacidade de uma reserva ou não.

Tipos enumerados
TYPE_UNSPECIFIED Tipo padrão.
NO_RESERVATION Não consumir de nenhuma capacidade alocada.
ANY_RESERVATION Consumir qualquer reserva disponível.
SPECIFIC_RESERVATION Precisa consumir de uma reserva específica. É necessário especificar campos de valor-chave para especificar as reservas.

ResetInstanceRequest

Solicitação de redefinição 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.reset

ResetRuntimeRequest

Solicitação para redefinir um ambiente de execução de notebook gerenciado.

Campos
name

string

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

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

  • notebooks.runtimes.reset
request_id

string

UUID da solicitação idempotente.

RollbackInstanceRequest

Solicitação para fazer o rollback 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:

  • iam.permissions.none
target_snapshot

string

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

Ambiente de execução

A definição de um ambiente de execução para uma instância de notebook gerenciado.

Campos
name

string

Apenas saída. O nome do recurso do ambiente de execução. Formato: projects/{project}/locations/{location}/runtimes/{runtimeId}
state

State

Apenas saída. Estado do ambiente de execução.
health_state

HealthState

Apenas saída. Runtime health_state.
access_config

RuntimeAccessConfig

As configurações de configuração para acessar o tempo de execução.
software_config

RuntimeSoftwareConfig

As configurações de configuração para software no tempo de execução.
metrics

RuntimeMetrics

Apenas saída. Contém métricas do daemon do ambiente de execução, como status do serviço e estatísticas do JupyterLab.
create_time

Timestamp

Apenas saída. Tempo de criação do ambiente de execução.
update_time

Timestamp

Apenas saída. Horário da atualização do ambiente de execução.
labels

map<string, string>

Opcional. Os rótulos a serem associados a este notebook gerenciado ou ambiente de execução. As chaves de rótulo precisam ter de 1 a 63 caracteres e estar em conformidade com a RFC 1035. Os valores de rótulo podem estar vazios, mas, se estiverem presentes, precisam ter de 1 a 63 caracteres e estar em conformidade com o RFC 1035. Não é possível associar mais de 32 rótulos a um cluster.
runtime_migration_eligibility

RuntimeMigrationEligibility

Apenas saída. Verifica a viabilidade de uma migração do GmN para o WbI.
Campo de união runtime_type. Tipo do ambiente de execução. No momento, só é compatível com a VM do Compute Engine. runtime_type pode ser apenas de um dos tipos a seguir:
virtual_machine

VirtualMachine

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

bool

Apenas saída. Booleano que indica se este notebook foi migrado para uma instância do Workbench

HealthState

O subestado de execução.

Tipos enumerados
HEALTH_STATE_UNSPECIFIED O subestado do ambiente de execução é desconhecido.
HEALTHY O ambiente de execução está em um estado íntegro (por exemplo, daemons críticos estão em execução). Aplica-se ao estado ACTIVE.
UNHEALTHY O ambiente de execução está em um estado não íntegro (por exemplo, daemons críticos não estão em execução). Aplica-se ao estado ATIVO.
AGENT_NOT_INSTALLED O ambiente de execução não instalou o agente de monitoramento de integridade. Aplicável ao estado ATIVO.
AGENT_NOT_RUNNING O agente de monitoramento de integridade do tempo de execução não está em execução. Aplicável ao estado ATIVO.

Estado

A definição dos estados desse ambiente de execução.

Tipos enumerados
STATE_UNSPECIFIED O estado não foi especificado.
STARTING A camada de computação está iniciando o ambiente de execução. Ele não está pronto para uso.
PROVISIONING A camada de computação está instalando os frameworks necessários e registrando o tempo de execução com o proxy do notebook. Ela não pode ser usada.
ACTIVE O tempo de execução está em execução. Ele está pronto para uso.
STOPPING A lógica de controle está interrompendo o tempo de execução. Ela não pode ser usada.
STOPPED O ambiente de execução é interrompido. Ela não pode ser usada.
DELETING O ambiente de execução está sendo excluído. Ela não pode ser usada.
UPGRADING O ambiente de execução está sendo atualizado. Ela não pode ser usada.
INITIALIZING O ambiente de execução está sendo criado e configurado. Ele não está pronto para uso.

RuntimeAcceleratorConfig

Definição dos tipos de aceleradores de hardware que podem ser usados. Consulte AcceleratorTypes do Compute Engine. Exemplos:

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

AcceleratorType

Modelo de acelerador.
core_count

int64

Contagem de núcleos deste acelerador.

AcceleratorType

Tipo do acelerador.

Tipos enumerados
ACCELERATOR_TYPE_UNSPECIFIED O tipo de acelerador não foi especificado.
NVIDIA_TESLA_K80

O tipo de acelerador é Nvidia Tesla K80.
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 de 40 GB.
NVIDIA_L4 O tipo de acelerador é Nvidia L4.
TPU_V2 (Em breve) O tipo de acelerador é TPU V2.
TPU_V3 (Em breve) O tipo de acelerador é TPU V3.
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.

RuntimeAccessConfig

Especifica a configuração de login para o ambiente de execução.

Campos
access_type

RuntimeAccessType

O tipo de modo de acesso desta instância.
runtime_owner

string

O proprietário deste ambiente de execução após a criação. Formato: alias@example.com. No momento, só é possível ter um proprietário.
proxy_uri

string

Apenas saída. O endpoint de proxy usado para acessar o ambiente de execução.

RuntimeAccessType

Possíveis maneiras de acessar o ambiente de execução. Modo de autenticação. No momento, só há suporte para um único usuário.

Tipos enumerados
RUNTIME_ACCESS_TYPE_UNSPECIFIED Acesso não especificado.
SINGLE_USER Login de usuário único.
SERVICE_ACCOUNT Modo de conta de serviço. No modo "Conta de serviço", o criador do ambiente de execução especifica uma conta de serviço que existe no projeto do consumidor. Usando o campo "Conta de serviço do ambiente de execução". Os usuários que acessam o ambiente de execução precisam da permissão ActAs (usuário da conta de serviço).

RuntimeMetrics

Contém métricas de daemon de ambiente de execução, como SO, kernels e estatísticas de sessões.

Campos
system_metrics

map<string, string>

Apenas saída. As métricas do sistema.

RuntimeMigrationEligibility

"RuntimeMigrationEligibility" representa as informações de viabilidade de uma migração do GmN para o WbI.

Campos
warnings[]

Warning

Apenas saída. Algumas configurações serão definidas como padrão durante a migração.
errors[]

Error

Apenas saída. Algumas configurações tornam o GmN inelegível para uma migração automática. É necessária uma migração manual.

Erro

Uma mensagem de erro de migração significa que determinadas configurações tornam o GmN inelegível para uma migração automática. É necessária uma migração manual.

Tipos enumerados
ERROR_UNSPECIFIED Tipo padrão.
CUSTOM_CONTAINER A GmN está configurada com contêineres personalizados e não pode ser migrada.

Aviso

Uma mensagem de aviso de migração significa que algumas configurações serão definidas como padrão durante a migração.

Tipos enumerados
WARNING_UNSPECIFIED Tipo padrão.
UNSUPPORTED_ACCELERATOR_TYPE A GmN usa um tipo de acelerador que não é compatível com a WbI. Ele será migrado sem um acelerador. Os usuários podem anexar um acelerador após a migração.
UNSUPPORTED_OS O GmN usa um sistema operacional que não é compatível com o WbI (por exemplo, Debian 10). Ele será substituído pelo Debian 11 no WbI.
RESERVED_IP_RANGE Este GmN está configurado com um intervalo de IP reservado, que não é mais aplicável no WbI.
GOOGLE_MANAGED_NETWORK Essa GmN é configurada com uma rede gerenciada pelo Google. Informe as opções network e subnet para a migração.
POST_STARTUP_SCRIPT Essa GmN é configurada com um script de pós-inicialização. Se quiser, forneça o post_startup_script_option para a migração.
SINGLE_USER Este GmN está configurado com o modo de usuário único. Se quiser, informe a opção service_account para a migração.

RuntimeShieldedInstanceConfig

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

Campos
enable_secure_boot

bool

Define se a Inicialização segura está ativada na instância.

A Inicialização segura ajuda a garantir que o sistema execute apenas um software autêntico por meio da verificação da assinatura digital de todos os componentes de inicialização e da interrupção do processo de inicialização se a verificação da assinatura falhar. Essa configuração está desativada por padrão.
enable_vtpm

bool

Define se a instância tem o vTPM ativado. Ativado por padrão.
enable_integrity_monitoring

bool

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

Permite o monitoramento e o atestado da integridade da inicialização da instância. 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 é criada. Ativado por padrão.

RuntimeSoftwareConfig

Especifica a seleção e a configuração do software no ambiente de execução. As propriedades a serem definidas no tempo de execução. As chaves de propriedades são especificadas no formato key:value. Por exemplo:

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

string

Expressão cron no fuso horário UTC, usada para programar o upgrade automático da instância. Siga o formato cron.
idle_shutdown_timeout

int32

Tempo em minutos para aguardar antes de encerrar o ambiente de execução. Padrão: 180 minutos
install_gpu_driver

bool

Instale o driver da Nvidia automaticamente. Padrão: True
custom_gpu_driver_path

string

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

string

Caminho para um script Bash executado automaticamente após a inicialização completa de uma instância de notebook. O caminho precisa ser um URL ou do Cloud Storage (gs://path-to-file/file-name).
kernels[]

ContainerImage

Opcional. Use uma lista de imagens de contêiner para usar como kernels na instância de notebook.
post_startup_script_behavior

PostStartupScriptBehavior

Comportamento do script de inicialização pós-inicialização.
enable_health_monitoring

bool

Verifica se os serviços internos principais estão em execução. Padrão: True
idle_shutdown

bool

O ambiente de execução será desligado automaticamente após idle_shutdown_time. Padrão: True
upgradeable

bool

Apenas saída. Booleano que indica se uma imagem mais recente está disponível em uma família de imagens.
disable_terminal

bool

Booleano que indica se o terminal do JupyterLab vai estar disponível ou não. Padrão: False.
version

string

Somente saída. Versão da imagem de inicialização, como M100, do rótulo de lançamento da imagem.
mixer_disabled

bool

Booleano que indica se o cliente do mixer precisa ser desativado. Padrão: False.

PostStartupScriptBehavior

Comportamento do script de inicialização pós-inicialização.

Tipos enumerados
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED Comportamento não especificado do script de inicialização pós-inicialização. Será executado apenas uma vez na criação.
RUN_EVERY_START Executa o script de inicialização fornecido durante a criação em cada inicialização.
DOWNLOAD_AND_RUN_EVERY_START Faz o download e executa o script de inicialização fornecido a cada inicialização.

Programação

A definição de uma programação.

Campos
name

string

Apenas saída. O nome desta programação. Formato: projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name

string

Apenas saída. Nome de exibição usado para fins UI. O nome só pode conter caracteres alfanuméricos, hífens - e sublinhados _.
description

string

Uma breve descrição do ambiente.
state

State
cron_schedule

string

Programação formatada em crontab para execução do job. Formato: minuto, hora, dia do mês, mês, dia da semana.Por exemplo, 0 0 * * WED = todas as quartas-feiras. Mais exemplos: https://crontab.guru/examples.html
time_zone

string

Fuso horário em que o cron_schedule. O valor desse campo precisa ser um nome de fuso horário do banco de dados tz. Banco de dados TZ: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Alguns fusos horários incluem uma disposição para o horário de verão. As regras do horário de verão são determinadas pela tz escolhida. Para UTC, use a string "utc". Se um fuso horário não for especificado, o padrão será UTC (também conhecido como GMT).
create_time

Timestamp

Apenas saída. Hora em que a programação foi criada.
update_time

Timestamp

Apenas saída. Hora em que a programação foi atualizada pela última vez.
execution_template

ExecutionTemplate

Modelo de execução do notebook correspondente a essa programação.
recent_executions[]

Execution

Apenas saída. Os nomes das execuções mais recentes acionadas por essa programação e os estados correspondentes.

Estado

Estado do job.

Tipos enumerados
STATE_UNSPECIFIED Estado não especificado.
ENABLED O job está sendo executado normalmente.
PAUSED O job foi pausado pelo usuário. Ele não será executado. Um usuário pode pausar intencionalmente o job usando o Cloud Scheduler.
DISABLED O job foi desativado pelo sistema devido a um erro. O usuário não pode definir diretamente um job para ser desativado.
UPDATE_FAILED O estado do job resultante de uma operação CloudScheduler.UpdateJob com falha. Para recuperar um job desse estado, repita a CloudScheduler.UpdateJob até que uma resposta bem-sucedida seja recebida.
INITIALIZING O recurso de programação está sendo criado.
DELETING O recurso de programação está sendo excluído.

SetInstanceAcceleratorRequest

Solicitação para definir o acelerador da instância.

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.setAccelerator
type

AcceleratorType

Obrigatório. Tipo do acelerador.
core_count

int64

Obrigatório. Contagem de núcleos deste acelerador. Nem todas as combinações de type e core_count são válidas. Consulte GPUs no Compute Engine para encontrar uma combinação válida. TPUs não são compatíveis.

SetInstanceLabelsRequest

Solicitação para definir rótulos de instância.

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.setLabels
labels

map<string, string>

Rótulos a serem aplicados a esta instância. Elas podem ser modificadas mais tarde pelo método "setLabels".

SetInstanceMachineTypeRequest

Solicitação para definir o tipo de máquina da instância.

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.setMachineType
machine_type

string

Obrigatório. O tipo de máquina do Compute Engine.

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

StartRuntimeRequest

Solicitação para iniciar um ambiente de execução de notebook gerenciado.

Campos
name

string

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

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

  • notebooks.runtimes.start
request_id

string

UUID da solicitação idempotente.

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

StopRuntimeRequest

Solicitação para interromper um ambiente de execução de notebook gerenciado.

Campos
name

string

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

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

  • notebooks.runtimes.stop
request_id

string

UUID da solicitação idempotente.

SwitchRuntimeRequest

Solicitação para alternar um ambiente de execução de notebook gerenciado.

Campos
name

string

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

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

  • notebooks.runtimes.switch
machine_type

string

tipo de máquina.
accelerator_config

RuntimeAcceleratorConfig

configuração do acelerador.
request_id

string

UUID da solicitação idempotente.

UpdateInstanceConfigRequest

Solicitação para atualizar configurações de instância.

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.updateConfig
config

InstanceConfig

As configurações da instância a serem atualizadas.

UpdateInstanceMetadataItemsRequest

Solicitação para adicionar/mudar itens de metadados de uma instância.

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.updateConfig
items

map<string, string>

Itens de metadados a serem adicionados/atualizados para a instância.

UpdateInstanceMetadataItemsResponse

Resposta para adicionar/mudar itens de metadados de uma instância.

Campos
items

map<string, string>

Mapa de itens que foram adicionados/atualizados nos metadados.

UpdateRuntimeRequest

Solicitação para atualizar uma configuração de notebook gerenciado.

Campos
runtime

Runtime

Obrigatório. O ambiente de execução a ser atualizado.

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

  • notebooks.runtimes.update
update_mask

FieldMask

Obrigatório. Especifica o caminho relativo a Runtime do campo a ser atualizado. Por exemplo, para mudar os kernels de configuração de software, o parâmetro update_mask seria especificado como software_config.kernels, e o corpo da solicitação PATCH especificaria o novo valor, da seguinte maneira:

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

No momento, apenas os seguintes campos podem ser atualizados:

  • software_config.kernels
  • software_config.post_startup_script
  • software_config.custom_gpu_driver_path
  • software_config.idle_shutdown
  • software_config.idle_shutdown_timeout
  • software_config.disable_terminal
  • labels
request_id

string

UUID da solicitação idempotente.

UpdateShieldedInstanceConfigRequest

Solicitação para atualizar a configuração da instância protegida de uma instância de notebook. Só é possível usar esse método em uma instância interrompida.

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.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

Configuração do ShieldedInstance a ser atualizada.

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
type

UpgradeType

Opcional. O UpgradeType opcional. Definir esse campo vai pesquisar outras imagens de computação para fazer upgrade da instância.

UpgradeType

Definição dos tipos de upgrade que podem ser usados nesta instância.

Tipos enumerados
UPGRADE_TYPE_UNSPECIFIED O tipo de upgrade não foi especificado.
UPGRADE_FRAMEWORK Faça upgrade do framework de ML.
UPGRADE_OS Fazer upgrade do sistema operacional.
UPGRADE_CUDA Faça upgrade do CUDA.
UPGRADE_ALL Fazer upgrade de tudo (SO, framework e CUDA).

VirtualMachine

Tempo de execução usando máquina virtual para computação.

Campos
instance_name

string

Apenas saída. O nome fácil de usar da instância gerenciada do Compute Engine.
instance_id

string

Apenas saída. O identificador exclusivo da instância gerenciada do Compute Engine.
virtual_machine_config

VirtualMachineConfig

Configurações de configuração da máquina virtual.

VirtualMachineConfig

As configurações de configuração da máquina virtual.

Campos
zone

string

Apenas saída. A zona em que a máquina virtual está localizada. Se você usar uma solicitação regional, o serviço de notebooks vai escolher um local na região de execução correspondente. Em uma solicitação GET, a zona sempre estará presente. Exemplo: * us-central1-b
machine_type

string

Obrigatório. O tipo de máquina do Compute Engine usado para ambientes de execução. O nome abreviado é válido. Exemplos: * n1-standard-2 * e2-standard-8
container_images[]

ContainerImage

Opcional. Use uma lista de imagens de contêiner para usar como kernels na instância de notebook.
data_disk

LocalDisk

Obrigatório. Configurações de configuração da opção de disco de dados.
encryption_config

EncryptionConfig

Opcional. Configurações de criptografia para o disco de dados da máquina virtual.
shielded_instance_config

RuntimeShieldedInstanceConfig

Opcional. Configurações de configuração da instância de VM protegida.
accelerator_config

RuntimeAcceleratorConfig

Opcional. A configuração do acelerador do Compute Engine para este ambiente de execução.
network

string

Opcional. A rede do Compute Engine a ser usada para comunicações da máquina. Não pode ser especificado com sub-rede. Se nem network nem subnet forem especificados, a rede "padrão" do projeto será usada, se existir.

Um URL completo ou um URI parcial. Exemplos:

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

Os runtimes são recursos gerenciados na infraestrutura do Google. Os ambientes de execução são compatíveis com as seguintes configurações de rede:

  • Rede gerenciada pelo Google (rede e sub-rede estão vazias)
  • VPC do projeto do consumidor (rede e sub-rede são obrigatórias). Requer a configuração do acesso a serviços particulares.
  • VPC compartilhada (rede e sub-rede são obrigatórias). Requer a configuração do acesso a serviços particulares.
subnet

string

Opcional. A sub-rede do Compute Engine a ser usada para comunicações da máquina. Não pode ser especificado com a rede.

Um URL completo ou um URI parcial são válidos. Exemplos:

  • 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

Opcional. Se for "true", o ambiente de execução terá apenas endereços IP internos. Por padrão, os runtimes não são restritos a endereços IP internos e têm endereços IP externo temporários atribuídos a cada VM. Essa restrição internal_ip_only só pode ser ativada para redes com sub-rede ativada, e todas as dependências precisam ser configuradas para serem acessíveis sem endereços IP externo.
tags[]

string

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

map<string, string>

Apenas saída. Os atributos de convidado do Compute Engine. Consulte Atributos de convidado do projeto e da instância.
metadata

map<string, string>

Opcional. As entradas de metadados do Compute Engine a serem adicionadas à máquina virtual. Consulte Metadados de projeto e instância.
labels

map<string, string>

Opcional. Os rótulos a serem associados a esse tempo de execução. As chaves de rótulo precisam ter de 1 a 63 caracteres e estar em conformidade com a RFC 1035. Os valores de rótulo podem estar vazios, mas, se estiverem presentes, precisam ter de 1 a 63 caracteres e estar em conformidade com o RFC 1035. Não é possível associar mais de 32 rótulos a um cluster.
nic_type

NicType

Opcional. O tipo de vNIC a ser usado nessa interface. Pode ser gVNIC ou VirtioNet.
reserved_ip_range

string

Opcional. O nome do intervalo de IP reservado é usado para o peering de VPC. A alocação de sub-rede usará o nome do intervalo se ele for atribuído.

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

O valor do campo será: managed-notebooks-range-c
boot_image

BootImage

Opcional. Metadados da imagem de inicialização usados para capacidade de upgrade do ambiente de execução.

BootImage

Esse tipo não tem campos.

Definição da imagem de inicialização usada pelo ambiente de execução. Usado para facilitar a capacidade de upgrade do ambiente de execução.

NicType

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

Tipos enumerados
UNSPECIFIED_NIC_TYPE Nenhum tipo especificado.
VIRTIO_NET VIRTIO
GVNIC GVNIC

VmImage

Definição de uma imagem de máquina virtual personalizada 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:
image_name

string

Use o nome da imagem da VM para encontrar a imagem.
image_family

string

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