Package google.cloud.notebooks.v2

インデックス

NotebookService

Workbench Notebooks インスタンスの API v2 サービス。

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

ノートブック インスタンスがアップグレード可能かどうかを確認します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

指定されたプロジェクトとロケーションで新しいインスタンスを作成します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

1 つのインスタンスを削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
DiagnoseInstance

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

インスタンスを指定して診断ファイルを作成し、診断ツールを実行します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

さまざまな構成パラメータを返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

1 つのインスタンスの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

指定されたプロジェクトとロケーションのインスタンスを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
ResetInstance

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

ノートブック インスタンスをリセットします。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

ノートブック インスタンスのディスクの容量を増やします。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
RestoreInstance

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance は、BackupSource からインスタンスを復元します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

ノートブック インスタンスを以前のバージョンにロールバックします。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
StartInstance

rpc StartInstance(StartInstanceRequest) returns (Operation)

ノートブック インスタンスを起動します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
StopInstance

rpc StopInstance(StopInstanceRequest) returns (Operation)

ノートブック インスタンスを停止します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance はインスタンスを更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。
UpgradeInstance

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

ノートブック インスタンスを最新バージョンにアップグレードします。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

AcceleratorConfig

VM インスタンスのアクセラレータ構成。ハードウェア アクセラレータの定義。type と core_count の組み合わせはチェックされません。TPU はサポートされていません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。

フィールド
type

AcceleratorType

省略可。このアクセラレータのタイプ。
core_count

int64

省略可。このアクセラレータのコア数。

AcceleratorType

このインスタンスで使用できるハードウェア アクセラレータのタイプの定義。

列挙型
ACCELERATOR_TYPE_UNSPECIFIED アクセラレータ タイプが指定されていません。
NVIDIA_TESLA_P100 アクセラレータ タイプは Nvidia Tesla P100 です。
NVIDIA_TESLA_V100 アクセラレータ タイプは Nvidia Tesla V100 です。
NVIDIA_TESLA_P4 アクセラレータ タイプは Nvidia Tesla P4 です。
NVIDIA_TESLA_T4 アクセラレータ タイプは Nvidia Tesla T4 です。
NVIDIA_TESLA_A100 アクセラレータ タイプは Nvidia Tesla A100 - 40 GB です。
NVIDIA_A100_80GB アクセラレータ タイプは Nvidia Tesla A100 - 80 GB です。
NVIDIA_L4 アクセラレータ タイプは Nvidia Tesla L4 です。
NVIDIA_H100_80GB アクセラレータ タイプは Nvidia Tesla H100 - 80 GB です。
NVIDIA_H100_MEGA_80GB アクセラレータ タイプは Nvidia Tesla H100 - MEGA 80 GB です。
NVIDIA_H200_141GB アクセラレータ タイプは Nvidia Tesla H200 - 141 GB です。
NVIDIA_TESLA_T4_VWS アクセラレータ タイプは NVIDIA Tesla T4 仮想ワークステーションです。
NVIDIA_TESLA_P100_VWS アクセラレータ タイプは NVIDIA Tesla P100 仮想ワークステーションです。
NVIDIA_TESLA_P4_VWS アクセラレータ タイプは NVIDIA Tesla P4 仮想ワークステーションです。
NVIDIA_B200 アクセラレータ タイプは NVIDIA B200 です。

AccessConfig

インスタンスのネットワーク インターフェースに接続されたアクセス構成。

フィールド
external_ip

string

このインスタンスに関連付けられている外部 IP アドレス。プロジェクトで使用可能な未使用の静的外部 IP アドレスを指定するか、このフィールドを未定義のままにして、共有エフェメラル IP アドレスプールの IP を使用します。静的外部 IP アドレスを指定する場合は、インスタンスのゾーンと同じリージョンに存在している必要があります。

BootDisk

ブートディスクの定義。

フィールド
disk_size_gb

int64

省略可。このインスタンスにアタッチされているブートディスクのサイズ（GB 単位）。最大 64, 000 GB（64 TB）まで。指定しない場合、デフォルトは推奨値の 150 GB になります。
disk_type

DiskType

省略可。ディスクのタイプを示します。
disk_encryption

DiskEncryption

省略可。入力専用。ブートディスクとデータディスクで使用されるディスク暗号化方式。デフォルトは GMEK です。
kms_key

string

省略可。入力専用。ディスクの暗号化に使用される KMS 鍵。disk_encryption が CMEK の場合にのみ適用されます。形式: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

独自の暗号鍵の使用について学習する。

CheckInstanceUpgradabilityRequest

ノートブック インスタンスがアップグレード可能かどうかを確認するリクエスト。

フィールド
notebook_instance

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース notebookInstance に対する次の IAM の権限が必要です。

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

ノートブック インスタンスがアップグレード可能かどうかを確認するためのレスポンス。

フィールド
upgradeable

bool

インスタンスがアップグレード可能かどうか。
upgrade_version

string

アップグレード エンドポイントを呼び出す場合に、このインスタンスがアップグレードされるバージョン。このフィールドは、フィールドのアップグレードが可能である場合にのみ入力されます。
upgrade_info

string

アップグレードに関する追加情報。
upgrade_image

string

アップグレード エンドポイントを呼び出す場合に、このインスタンスがアップグレードされる新しいイメージのセルフリンク。このフィールドは、フィールドのアップグレードが可能である場合にのみ入力されます。

ConfidentialInstanceConfig

一連の Confidential Instance オプション。

フィールド
confidential_instance_type

ConfidentialInstanceType

省略可。機密インスタンスで使用されるテクノロジーのタイプを定義します。

ConfidentialInstanceType

機密インスタンスのタイプ。

列挙型
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED タイプが指定されていません。この値は使用しないでください。
SEV AMD Secure Encrypted Virtualization。

構成

ロケーション内の WbI 構成を取得するレスポンス

フィールド
default_values

DefaultValues

出力専用。構成のデフォルト値。
supported_values

SupportedValues

出力専用。構成でサポートされている値。
available_images[]

ImageRelease

出力専用。WbI の作成に使用できるイメージのリスト。
disable_workbench_legacy_creation

bool

出力専用。以前の Workbench ノートブック（ユーザー管理のノートブックと Google 管理のノートブック）の作成を無効にするフラグ。

ContainerImage

コンテナにインストールされた環境でノートブック インスタンスを起動するためのコンテナ イメージの定義。

フィールド
repository

string

必須。コンテナ イメージ リポジトリのパス。例: gcr.io/{project_id}/{image_name}
tag

string

省略可。コンテナ イメージのタグ。指定しない場合、デフォルトで最新のタグが使用されます。

CreateInstanceRequest

ノートブック インスタンスの作成リクエスト。

フィールド
parent

string

必須。形式: parent=projects/{project_id}/locations/{location}

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • notebooks.instances.create
instance_id

string

必須。このインスタンスのユーザー定義の一意の ID。
instance

Instance

必須。作成するインスタンス。
request_id

string

省略可。べき等リクエストの UUID。

DataDisk

インスタンスにアタッチされたディスク リソース。

フィールド
disk_size_gb

int64

省略可。この VM インスタンスに接続されているディスクのサイズ（GB 単位）。最大 64, 000 GB（64 TB）まで。指定しない場合、デフォルトは 100 です。
disk_type

DiskType

省略可。入力専用。ディスクのタイプを示します。
disk_encryption

DiskEncryption

省略可。入力専用。ブートディスクとデータディスクで使用されるディスク暗号化方式。デフォルトは GMEK です。
kms_key

string

省略可。入力専用。ディスクの暗号化に使用される KMS 鍵。disk_encryption が CMEK の場合にのみ適用されます。形式: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

独自の暗号鍵の使用について学習する。
resource_policies[]

string

省略可。データディスクに適用するリソース ポリシー。

DefaultValues

DefaultValues は、デフォルトの構成値を表します。

フィールド
machine_type

string

出力専用。ユーザーが指定しない場合にバックエンドで使用されるデフォルトのマシンタイプ。

DeleteInstanceRequest

ノートブック インスタンスの削除リクエスト。

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.delete
request_id

string

省略可。べき等リクエストの UUID。

DiagnoseInstanceRequest

ノートブック インスタンスの診断ファイルの作成リクエスト。

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.diagnose
diagnostic_config

DiagnosticConfig

必須。診断ツールの実行に使用されるフラグを定義します
timeout_minutes

int32

省略可。オペレーションがタイムアウトになるまでの最大時間（分単位）。

DiagnosticConfig

診断ツールの実行に使用されるフラグを定義します

フィールド
gcs_bucket

string

必須。ユーザーの Cloud Storage バケットのロケーション（必須）。パス接頭辞（gs://$GCS_BUCKET）でフォーマットする必要があります。

権限: ユーザー管理ノートブック: - storage.buckets.writer: VM に接続されているプロジェクトのサービス アカウントに付与する必要があります。Google マネージド ノートブック: - storage.buckets.writer: 認証モードに応じて、プロジェクトのサービス アカウントまたは VM に関連付けられたユーザー認証情報を付与する必要があります。

Cloud Storage バケット ログファイルは gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz に書き込まれます
relative_path

string

省略可。診断ログが書き込まれる Cloud Storage バケット内の相対ストレージ パスを定義します。デフォルトのパスは Cloud Storage バケットのルート ディレクトリ（gs://$GCS_BUCKET/$DATE_$TIME.tar.gz）です。ログファイルが書き込まれるフルパスの例: gs://$GCS_BUCKET/$RELATIVE_PATH/
enable_repair_flag

bool

省略可。インスタンスのサービスを修復するフラグを有効にします
enable_packet_capture_flag

bool

省略可。インスタンスから 30 秒間パケットをキャプチャするフラグを有効にします
enable_copy_home_files_flag

bool

省略可。すべての /home/jupyter フォルダのコンテンツをコピーするフラグを有効化

DiskEncryption

ディスク暗号化オプションの定義。

列挙型
DISK_ENCRYPTION_UNSPECIFIED ディスク暗号化が指定されていません。
GMEK Google が管理する暗号鍵を使用してブートディスクを暗号化します。
CMEK 顧客管理の暗号鍵を使用してブートディスクを暗号化します。

DiskType

使用可能なディスクタイプ。

列挙型
DISK_TYPE_UNSPECIFIED ディスクタイプが設定されていません。
PD_STANDARD 標準永続ディスクタイプ。
PD_SSD SSD 永続ディスクのタイプ。
PD_BALANCED バランス永続ディスクタイプ。
PD_EXTREME エクストリーム永続ディスクタイプ。
HYPERDISK_BALANCED Hyperdisk Balanced 永続ディスクタイプを表します。ブートディスクまたはデータディスクとして使用できます。
HYPERDISK_EXTREME Hyperdisk Extreme 永続ディスク タイプを表します。データディスクとしてのみ使用できます。
HYPERDISK_THROUGHPUT Hyperdisk Throughput 永続ディスク タイプを表します。データディスクとしてのみ使用できます。
HYPERDISK_BALANCED_HIGH_AVAILABILITY Hyperdisk Balanced High Availability 永続ディスク タイプを表します。ブートディスクまたはデータディスクとして使用できます。
HYPERDISK_ML Hyperdisk ML 永続ディスク タイプを表します。ブートディスクまたはデータディスクとして使用できます。

GPUDriverConfig

GPU ドライバの構成

フィールド
enable_gpu_driver

bool

省略可。エンドユーザーが Google Cloud にこの VM インスタンスへの GPU ドライバのインストールを承認するかどうか。このフィールドが空の場合や false に設定されている場合、GPU ドライバはインストールされません。GPU を使用するインスタンスにのみ適用されます。
custom_gpu_driver_path

string

省略可。GPU ドライバが保存されているカスタム Cloud Storage パスを指定します。指定しない場合、公式の GPU ドライバから自動的に選択されます。

GceSetup

リソースと ID の外部で VM インスタンスを構成する方法の定義。

フィールド
machine_type

string

省略可。VM インスタンスのマシンタイプ。https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

省略可。このインスタンスで使用する最小 CPU プラットフォーム。有効な値のリストは、https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones で確認できます。
accelerator_configs[]

AcceleratorConfig

省略可。このインスタンスで使用されるハードウェア アクセラレータ。アクセラレータを使用する場合は、選択した machine_type をサポートするのに十分な vCPU とメモリが構成に含まれていることを確認してください。現在、サポートされているアクセラレータ構成は 1 つのみです。
service_accounts[]

ServiceAccount

省略可。VM インスタンスの ID として機能するサービス アカウント。現在、サポートされているサービス アカウントは 1 つのみです。
boot_disk

BootDisk

省略可。VM のブートディスク。
data_disks[]

DataDisk

省略可。VM インスタンスにアタッチされたデータディスク。現在サポートされているデータディスクは 1 つのみです。
shielded_instance_config

ShieldedInstanceConfig

省略可。Shielded VM の構成。サポートされている Shielded VM 機能を使用するイメージ。
network_interfaces[]

NetworkInterface

省略可。VM のネットワーク インターフェース。サポートされるインターフェースは 1 つのみです。
disable_public_ip

bool

省略可。true の場合、この VM インスタンスに外部 IP は割り当てられません。
tags[]

string

省略可。ランタイムに追加する Compute Engine ネットワーク タグ（ネットワーク タグを追加するをご覧ください）。
metadata

map<string, string>

省略可。このインスタンスに適用するカスタム メタデータ。
enable_ip_forwarding

bool

省略可。IP 転送を有効にするかどうかを示すフラグ。デフォルトは false（オフ）です。https://cloud.google.com/vpc/docs/using-routes#canipforward
gpu_driver_config

GPUDriverConfig

省略可。GPU ドライバの構成。
confidential_instance_config

ConfidentialInstanceConfig

省略可。機密インスタンスの構成。
instance_id

string

出力専用。Compute Engine インスタンス リソースの一意の ID。
共用体フィールド image。イメージのタイプ。VM イメージまたはコンテナ イメージのいずれかになります。image は次のいずれかになります。
vm_image

VmImage

省略可。Compute Engine VM イメージを使用してノートブック インスタンスを起動します。
container_image

ContainerImage

省略可。コンテナ イメージを使用してノートブック インスタンスを起動します。

GetConfigRequest

Workbench 構成パラメータを取得するリクエスト。

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}

GetInstanceRequest

ノートブック インスタンスの取得リクエスト。

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.get

HealthState

インスタンスの健全性。

列挙型
HEALTH_STATE_UNSPECIFIED インスタンスのサブステートは不明です。
HEALTHY インスタンスが正常な状態であることがわかっている（たとえば、重要なデーモンが実行されている）。ACTIVE 状態に適用されます。
UNHEALTHY インスタンスが異常な状態であることがわかっている（たとえば、重要なデーモンが実行されていない）。ACTIVE 状態に適用されます。
AGENT_NOT_INSTALLED インスタンスにヘルス モニタリング エージェントがインストールされていません。ACTIVE 状態に適用されます。
AGENT_NOT_RUNNING インスタンスのヘルス モニタリング エージェントが実行されていません。ACTIVE 状態に適用されます。

ImageRelease

ConfigImage は、WbI の作成に使用できるイメージ リリースを表します

フィールド
image_name

string

出力専用。フォーム ワークベンチのイメージの名前（workbench-instances-vYYYYmmdd--）
release_name

string

出力専用。フォーム m123 の画像のリリース

インスタンス

ノートブック インスタンスの定義。

フィールド
name

string

出力専用。ID。このノートブック インスタンスの名前。形式: projects/{project_id}/locations/{location}/instances/{instance_id}
proxy_uri

string

出力専用。Jupyter ノートブックへのアクセスに使用されるプロキシ エンドポイント。
instance_owners[]

string

省略可。作成後のこのインスタンスのオーナー。形式: alias@example.com

現在、サポートされているオーナーは 1 人のみです。指定しない場合、VM インスタンスのサービス アカウントのすべてのサービス アカウント ユーザーがインスタンスを使用できます。
creator

string

出力専用。元の CreateInstance リクエストを送信したエンティティのメールアドレス。
state

State

出力専用。このインスタンスの状態。
upgrade_history[]

UpgradeHistoryEntry

出力専用。このインスタンスのアップグレード履歴。
id

string

出力専用。リソースの一意の ID。
health_state

HealthState

出力専用。インスタンスの health_state。
health_info

map<string, string>

出力専用。インスタンスのヘルス状態に関する追加情報。例:

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

Timestamp

出力専用。インスタンスの作成時刻。
update_time

Timestamp

出力専用。インスタンスの更新時刻。
disable_proxy_access

bool

省略可。true の場合、ノートブック インスタンスはプロキシに登録されません。
labels

map<string, string>

省略可。このインスタンスに適用するラベル。これらは、後で UpdateInstance メソッドで変更できます。
third_party_proxy_url

string

出力専用。Jupyter Notebook へのアクセスに使用される Workforce プール プロキシ エンドポイント。
satisfies_pzs

bool

出力専用。ゾーン分離のために将来の使用のために予約されています。
satisfies_pzi

bool

出力専用。ゾーン分離の将来の使用のために予約されています。
enable_third_party_identity

bool

省略可。ノートブックにサードパーティ ID プロバイダを使用してアクセスできることを指定するフラグ。
enable_managed_euc

bool

省略可。インスタンスの管理対象エンドユーザー認証情報を有効にするフラグ。
enable_deletion_protection

bool

省略可。true の場合、この Workbench インスタンスで削除からの保護が有効になります。false の場合、この Workbench インスタンスの削除からの保護は無効になります。
共用体フィールド infrastructure。ノートブック インスタンスの設定。infrastructure は次のいずれかになります。
gce_setup

GceSetup

省略可。ノートブックの Compute Engine の設定。ノートブックで定義されたフィールドを使用します。

ListInstancesRequest

ノートブック インスタンスのリストを取得するリクエスト。

フィールド
parent

string

必須。インスタンスの親。形式: - projects/{project_id}/locations/{location}: 特定のゾーンのインスタンスを一覧表示します。- すべてのロケーションのインスタンスを一覧表示する projects/{project_id}/locations/-。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • notebooks.instances.list
page_size

int32

省略可。リスト呼び出しの最大戻りサイズ。
page_token

string

省略可。前回の結果からリストを続行するために使用できる、以前に返されたページトークン。
order_by

string

省略可。結果の並べ替え。サポートされている値は「name」、「name desc」、または「」（並べ替えなし）です。
filter

string

省略可。リストフィルタ。

ListInstancesResponse

ノートブック インスタンスを一覧表示するためのレスポンス。

フィールド
instances[]

Instance

返されたインスタンスのリスト。
next_page_token

string

次のリスト呼び出しで最後の結果からリストを続行するために使用できるページトークン。
unreachable[]

string

順序なしリスト。到達できなかったロケーション。たとえば、['projects/{project_id}/locations/us-west1-a', 'projects/{project_id}/locations/us-central1-b'] などです。ListInstancesResponse には、インスタンスまたは到達不能のいずれかのみが含まれます。

NetworkInterface

VM にアタッチされたネットワーク インターフェース リソースの定義。

フィールド
network

string

省略可。この VM インスタンスが存在する VPC の名前。形式: projects/{project_id}/global/networks/{network_id}
subnet

string

省略可。この VM インスタンスが存在するサブネットの名前。形式: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
nic_type

NicType

省略可。このインターフェースで使用する vNIC のタイプ。これは gVNIC または VirtioNet になります。
access_configs[]

AccessConfig

省略可。このインターフェースの構成の配列。現在、サポートされているアクセス構成は ONE_TO_ONE_NAT のみです。accessConfigs が指定されていない場合、インスタンスはエフェメラル外部 IP アドレスを介して外部インターネットにアクセスします。

NicType

vNIC ドライバのタイプ。デフォルトは NIC_TYPE_UNSPECIFIED にする必要があります。

列挙型
NIC_TYPE_UNSPECIFIED タイプが指定されていません。
VIRTIO_NET Virtio
GVNIC GVNIC

OperationMetadata

長時間実行されているオペレーションのメタデータを表します。

フィールド
create_time

Timestamp

オペレーションが作成された時刻。
end_time

Timestamp

オペレーションの実行が終了した時刻。
target

string

オペレーションのターゲットに対応するサーバー定義のリソースパス。
verb

string

オペレーションによって実行される動詞の名前。
status_message

string

人が読める形式のオペレーションのステータス（存在する場合）。
requested_cancellation

bool

ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の google.longrunning.Operation.error 値を持ちます。これは Code.CANCELLED に相当します。
api_version

string

オペレーションを開始するために使用された API のバージョン。
endpoint

string

このオペレーションの API エンドポイント名。

ResetInstanceRequest

ノートブック インスタンスのリセットのリクエスト

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.reset

ResizeDiskRequest

ノートブック インスタンスのディスクのサイズ変更をリクエストする

フィールド
notebook_instance

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース notebookInstance に対する次の IAM の権限が必要です。

  • notebooks.instances.update
共用体フィールド Disk。サイズ変更可能なディスクのタイプ（ブートディスクまたはデータディスク）。Disk は次のいずれかになります。
boot_disk

BootDisk

必須。サイズ変更するブートディスク。disk_size_gb のみが使用されます。
data_disk

DataDisk

必須。サイズ変更するデータディスク。disk_size_gb のみが使用されます。

RestoreInstanceRequest

BackupSource からノートブック インスタンスを復元するリクエスト。

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.update
共用体フィールド Source。復元元のソース。Source は次のいずれかになります。
snapshot

Snapshot

復元に使用するスナップショット。

RollbackInstanceRequest

ノートブック インスタンスのロールバックのリクエスト

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.rollback
target_snapshot

string

必須。ロールバック用のスナップショット。例: 「projects/test-project/global/snapshots/krwlzipynril」。
revision_id

string

必須。出力専用。リビジョン ID

ServiceAccount

ID として機能するサービス アカウント。

フィールド
email

string

省略可。サービス アカウントのメールアドレス。
scopes[]

string

出力専用。このサービス アカウントで使用可能にするスコープのリスト。CLH によって https://www.googleapis.com/auth/cloud-platform に設定されます。

ShieldedInstanceConfig

一連のシールド インスタンス オプション。サポートされている Shielded VM 機能を使用するイメージをご覧ください。すべての組み合わせが有効なわけではありません。

フィールド
enable_secure_boot

bool

省略可。VM インスタンスでセキュアブートが有効になっているかどうかを定義します。

セキュアブートは、すべてのブート コンポーネントのデジタル署名を検証し、署名検証が失敗した場合にブートプロセスを停止することで、システムで正規のソフトウェアのみが実行されるようにします。デフォルトでは無効にされています。
enable_vtpm

bool

省略可。VM インスタンスで vTPM が有効になっているかどうかを定義します。
enable_integrity_monitoring

bool

省略可。VM インスタンスで整合性モニタリングを有効にするかどうかを定義します。

VM インスタンスの起動時の整合性のモニタリングと証明を有効にします。構成証明は、整合性ポリシー ベースラインに対して実行されます。このベースラインは、VM インスタンスの作成時に、暗黙的に信頼されているブートイメージから最初に派生します。

スナップショット

スナップショットは、Workbench インスタンスの復元に使用されるデータディスクのスナップショットを表します。compute/v1/projects/{project_id}/global/snapshots/{snapshot_id} を参照します。

フィールド
snapshot_id

string

必須。スナップショットの ID。
project_id

string

必須。スナップショットのプロジェクト ID。

StartInstanceRequest

ノートブック インスタンスの起動リクエスト

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.start

状態

このインスタンスの状態の定義。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
STARTING 制御ロジックがインスタンスを起動しています。
PROVISIONING 制御ロジックは、必要なフレームワークをインストールし、インスタンスをノートブック プロキシに登録します。
ACTIVE インスタンスは実行中です。
STOPPING 制御ロジックがインスタンスを停止しています。
STOPPED インスタンスは停止しています。
DELETED インスタンスが削除された場合。
UPGRADING インスタンスがアップグレード中です。
INITIALIZING インスタンスを作成しています。
SUSPENDING インスタンスは一時停止中です。
SUSPENDED インスタンスは一時停止されています。

StopInstanceRequest

ノートブック インスタンスの停止リクエスト

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.stop

SupportedValues

SupportedValues は、構成でサポートされている値を表します。

フィールド
machine_types[]

string

出力専用。WbI でサポートされているマシンタイプ。
accelerator_types[]

string

出力専用。WbI でサポートされているアクセラレータ タイプ。

UpdateInstanceRequest

ノートブック インスタンスの更新リクエスト。

フィールド
instance

Instance

必須。インスタンスの表現。

認可には、指定されたリソース instance に対する次の IAM の権限が必要です。

  • iam.permissions.none
update_mask

FieldMask

必須。インスタンスの更新に使用されるマスク。更新可能なフィールド:

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

string

省略可。べき等リクエストの UUID。

UpgradeHistoryEntry

VM イメージのアップグレード履歴のエントリ。

フィールド
snapshot

string

省略可。アップグレード前のこのノートブック インスタンスのブートディスクのスナップショット。
vm_image

string

省略可。このインスタンスのアップグレード前の VM イメージ。
container_image

string

省略可。このインスタンスのアップグレード前のコンテナ イメージ。
framework

string

省略可。このノートブック インスタンスのフレームワーク。
version

string

省略可。このアップグレード前のノートブック インスタンスのバージョン。
state

State

出力専用。このインスタンス アップグレード履歴エントリの状態。
create_time

Timestamp

変更不可。このインスタンス アップグレード履歴エントリが作成された時刻。
action

Action

省略可。アクション:ロールバックまたはアップグレード。
target_version

string

省略可。ターゲット VM のバージョン（m63 など）。

アクション

このアップグレード履歴エントリのオペレーションの定義。

列挙型
ACTION_UNSPECIFIED オペレーションが指定されていません。
UPGRADE アップグレードしてください。
ROLLBACK Rollback のインスタンスを発生させることができます。

状態

このアップグレード履歴エントリの状態の定義。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
STARTED インスタンスのアップグレードが開始されます。
SUCCEEDED インスタンスのアップグレードが成功しました。
FAILED インスタンスのアップグレードが失敗しました。

UpgradeInstanceRequest

ノートブック インスタンスのアップグレードのリクエスト

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • notebooks.instances.upgrade

VmImage

環境が VM に直接インストールされたノートブック インスタンスを起動するためのカスタム Compute Engine 仮想マシン イメージの定義。

フィールド
project

string

必須。この VM イメージが属する Google Cloud プロジェクトの名前。形式: {project_id}
共用体フィールド image。外部の Compute Engine VM イメージへの参照。image は次のいずれかになります。
name

string

省略可。VM イメージ名を使用してイメージを見つけます。
family

string

省略可。この VM イメージ ファミリーを使用してイメージを検索します。このファミリーの最新のイメージが使用されます。