Package google.cloud.notebooks.v1

インデックス

ManagedNotebookService

マネージド ノートブックの API v1 サービス。

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

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

認可スコープ

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

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

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

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

1 つの Runtime を削除します。

認可スコープ

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

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

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

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

1 つの Runtime の詳細を取得します。ロケーションは、ゾーン エンドポイントではなくリージョン エンドポイントにする必要があります。

認可スコープ

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

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

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

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

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

認可スコープ

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

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

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

rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation)

既存のランタイムを新しい Workbench インスタンスに移行します。

認可スコープ

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

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

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

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

ランタイム イベントを報告して処理します。

認可スコープ

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

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

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

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

マネージド ノートブック ランタイムをリセットします。

認可スコープ

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

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

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

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

マネージド ノートブック ランタイムを開始します。GPU インスタンスで「開始」、CPU インスタンスで「再開」を実行します。参照: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

認可スコープ

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

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

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

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

マネージド ノートブック ランタイムを停止します。GPU インスタンスで「停止」、CPU インスタンスで「一時停止」を実行します。参照: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

認可スコープ

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

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

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

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

マネージド ノートブック ランタイムを切り替えます。

認可スコープ

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

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

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

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

ノートブック ランタイム構成を更新します。

認可スコープ

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

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

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

NotebookService

Cloud AI Platform Notebooks の API v1 サービス。

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

新しい環境を作成します。

認可スコープ

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

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

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

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

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

認可スコープ

次の 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 をご覧ください。
CreateSchedule

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

指定されたプロジェクトとロケーションで新しいスケジュール設定されたノートブックを作成します。

認可スコープ

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

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

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

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

1 つの環境を削除します。

認可スコープ

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

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

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

rpc DeleteExecution(DeleteExecutionRequest) 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 をご覧ください。
DeleteSchedule

rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation)

スケジュールと基盤となるすべてのジョブを削除します

認可スコープ

次の 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 をご覧ください。
GetEnvironment

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

1 つの Environment の詳細を取得します。

認可スコープ

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

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

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

rpc GetExecution(GetExecutionRequest) returns (Execution)

実行の詳細を取得する

認可スコープ

次の 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 をご覧ください。
GetInstanceHealth

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

ノートブック インスタンスが正常かどうかを確認します。

認可スコープ

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

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

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

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

スケジュールの詳細を取得する

認可スコープ

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

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

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

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

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

認可スコープ

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

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

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

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

プロジェクト内の環境を一覧表示します。

認可スコープ

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

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

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

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

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

認可スコープ

次の 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 をご覧ください。
ListSchedules

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

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

認可スコープ

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

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

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

rpc MigrateInstance(MigrateInstanceRequest) returns (Operation)

既存のユーザー管理ノートブックを Workbench インスタンスに移行します。

認可スコープ

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

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

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

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

既存のレガシー ノートブック インスタンスを Notebooks API サーバーに登録します。以前のインスタンスは、以前の Compute Engine 呼び出しで作成されたインスタンスです。Notebooks API でそのまま管理することはできません。この呼び出しにより、Notebooks API でこれらのインスタンスを管理できるようになります。

認可スコープ

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

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

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

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

ノートブック インスタンスが最新のインスタンス情報を Notebooks API サーバーに報告できるようにします。サーバーは、報告された情報をインスタンス メタデータ ストアに統合します。このメソッドを直接使用しないでください。

認可スコープ

次の 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 をご覧ください。
RollbackInstance

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

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

認可スコープ

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

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

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

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

単一インスタンスのゲスト アクセラレータを更新します。

認可スコープ

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

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

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

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

インスタンスのすべてのラベルを置き換えます。

認可スコープ

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

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

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

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) 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 をご覧ください。
UpdateInstanceConfig

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

ノートブック インスタンスの構成を更新します。

認可スコープ

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

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

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

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

インスタンスのメタデータ項目を追加または更新します。

認可スコープ

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

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

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

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

単一インスタンスのシールドされたインスタンス構成を更新します。

認可スコープ

次の 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 をご覧ください。

ContainerImage

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

フィールド
repository

string

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

string

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

CreateEnvironmentRequest

ノートブック環境の作成リクエスト。

フィールド
parent

string

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

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

  • notebooks.environments.create
environment_id

string

必須。この環境のユーザー定義の一意の ID。environment_id は 1 ～ 63 文字で、英小文字、数字、ダッシュのみを使用する必要があります。先頭文字は小文字でなければならず、最後の文字にはダッシュは使用できません。
environment

Environment

必須。作成する環境。

CreateExecutionRequest

ノートブック実行の作成リクエスト

フィールド
parent

string

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

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

  • notebooks.executions.create
execution_id

string

必須。この実行のユーザー定義の一意の ID。
execution

Execution

必須。作成する実行。

CreateInstanceRequest

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

フィールド
parent

string

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

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

  • notebooks.instances.create
instance_id

string

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

Instance

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

CreateRuntimeRequest

マネージド ノートブック ランタイムの作成リクエスト。

フィールド
parent

string

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

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

  • notebooks.runtimes.create
runtime_id

string

必須。このランタイムのユーザー定義の一意の ID。
runtime

Runtime

必須。作成するランタイム。
request_id

string

べき等リクエストの UUID。

CreateScheduleRequest

作成されたスケジュール設定済みノートブックのリクエスト

フィールド
parent

string

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

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

  • notebooks.schedules.create
schedule_id

string

必須。このスケジュールのユーザー定義の一意の ID。
schedule

Schedule

必須。作成するスケジュール。

DeleteEnvironmentRequest

ノートブック環境の削除リクエスト。

フィールド
name

string

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

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

  • notebooks.environments.delete

DeleteExecutionRequest

スケジュール設定されたノートブックの実行の削除リクエスト

フィールド
name

string

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

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

  • notebooks.executions.delete

DeleteInstanceRequest

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

フィールド
name

string

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

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

  • notebooks.instances.delete

DeleteRuntimeRequest

マネージド ノートブック ランタイムの削除リクエスト。

フィールド
name

string

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

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

  • notebooks.runtimes.delete
request_id

string

べき等リクエストの UUID。

DeleteScheduleRequest

Schedule の削除リクエスト

フィールド
name

string

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

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

  • notebooks.schedules.delete

DiagnoseInstanceRequest

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

フィールド
name

string

必須。形式: projects/{project_id}/locations/{location}/instances/{instance_id}
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/
repair_flag_enabled

bool

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

bool

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

bool

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

EncryptionConfig

リソースに適用できるカスタム暗号鍵構成を表します。これにより、仮想マシンのすべてのディスクが暗号化されます。

フィールド
kms_key

string

ディスクなどのリソースを保護するために使用される顧客管理の暗号鍵の Cloud KMS リソース ID。次の形式となります。projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

環境

ノートブック インスタンスの起動に使用されるソフトウェア環境の定義。

フィールド
name

string

出力専用。この環境の名前。形式: projects/{project_id}/locations/{location}/environments/{environment_id}
display_name

string

UI で使用されるこの環境の表示名。
description

string

この環境の簡単な説明。
post_startup_script

string

ノートブック インスタンスの起動が完了した後に自動的に実行される Bash スクリプトのパス。パスは、URL または Cloud Storage パスにする必要があります。例: "gs://path-to-file/file-name"
create_time

Timestamp

出力専用。この環境が作成された時刻。
共用体フィールド image_type。環境のタイプ。VM イメージまたはコンテナ イメージのいずれかになります。image_type は次のいずれかになります。
vm_image

VmImage

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

ContainerImage

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

イベント

マネージド / セミマネージド ノートブック インスタンスのイベントの定義。

フィールド
report_time

Timestamp

イベントのレポート時刻。
type

EventType

イベントタイプ。
details

map<string, string>

省略可。イベントの詳細。このフィールドは、イベント情報を渡すために使用されます。

EventType

イベントタイプの定義。

列挙型
EVENT_TYPE_UNSPECIFIED イベントが指定されていません。
IDLE インスタンス / ランタイムがアイドル状態である
HEARTBEAT インスタンス / ランタイムが使用可能です。このイベントは、インスタンス / ランタイムの基盤となるコンピューティングが動作していることを示します。
HEALTH インスタンス / ランタイムの健全性が利用可能です。このイベントは、インスタンス / ランタイムの健全性情報を示します。
MAINTENANCE インスタンス / ランタイムが使用可能です。このイベントにより、インスタンス / ランタイムはホスト メンテナンス情報をコントロール プレーンに送信できます。https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

実行

実行された単一のノートブックの定義。

フィールド
execution_template

ExecutionTemplate

名前、ハードウェア仕様、リージョン、ラベルなどのメタデータを実行します。
name

string

出力専用。実行のリソース名。形式: projects/{project_id}/locations/{location}/executions/{execution_id}
display_name

string

出力専用。UI で使用される名前。名前に使用できるのは、英数字とアンダースコア「_」のみです。
description

string

この実行の簡単な説明。
create_time

Timestamp

出力専用。実行がインスタンス化された時刻。
update_time

Timestamp

出力専用。実行が最後に更新された時刻。
state

State

出力専用。基盤となる AI Platform ジョブの状態。
output_notebook_file

string

この実行によって生成された出力ノートブック ファイル
job_uri

string

出力専用。ノートブックの実行に使用される外部ジョブの URI。

状態

基盤となる AIP ジョブの状態の列挙型の説明。

列挙型
STATE_UNSPECIFIED ジョブの状態は指定されていません。
QUEUED ジョブは作成されたばかりで、処理はまだ開始されていません。
PREPARING サービスはジョブを実行する準備をしています。
RUNNING ジョブは進行中です。
SUCCEEDED ジョブは正常に完了しました。
FAILED ジョブは失敗しました。error_message に失敗の詳細が格納されます。
CANCELLING ジョブをキャンセルしています。error_message にキャンセルの理由が記載されています。
CANCELLED ジョブがキャンセルされました。error_message にキャンセルの理由が記載されています。
EXPIRED ジョブの有効期限が切れた（Agent Platform ジョブに関連）https://cloud.google.com/gemini-enterprise-agent-platform/reference/rest/v1/JobState
INITIALIZING 実行を作成しています。

ExecutionTemplate

ノートブック実行ワークロードの説明。

フィールド
scale_tier
(deprecated)

ScaleTier

必須。ノートブックの実行に使用されるハードウェアのスケールティア。非推奨。廃止されます。現時点では CUSTOM のみがサポートされています。
master_type

string

トレーニング ジョブのマスター ワーカーに使用する仮想マシンのタイプを指定します。scaleTier が CUSTOM に設定されている場合は、このフィールドを指定する必要があります。

このフィールドには、特定の Compute Engine マシンタイプを直接使用できます。次の型がサポートされています。

  • 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

または、次の従来のマシンタイプを使用できます。

  • 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

最後に、トレーニングに TPU を使用する場合は、このフィールドに cloud_tpu を指定します。詳しくは、TPU を使用したトレーニングの特別な構成オプションをご覧ください。
accelerator_config

SchedulerAcceleratorConfig

ノートブック実行を実行するハードウェアの構成（数とアクセラレータ タイプ）。
labels

map<string, string>

実行のラベル。実行がスケジュールされている場合、含まれるフィールドは「nbs-scheduled」になります。それ以外の場合は、即時実行となり、含まれるフィールドは「nbs-immediate」になります。フィールドを使用して、さまざまなタイプの実行間で効率的にインデックス登録します。
input_notebook_file

string

実行するノートブック ファイルのパス。Google Cloud Storage バケットに保存されている必要があります。形式: gs://{bucket_name}/{folder}/{notebook_file_name}（例: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb）
container_image_uri

string

DLVM のコンテナ イメージ URI の例: 「gcr.io/deeplearning-platform-release/base-cu100」。その他の例については、https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container をご覧ください。
output_notebook_folder

string

書き込むノートブック フォルダのパス。Google Cloud Storage バケットパスにある必要があります。形式: gs://{bucket_name}/{folder}（例: gs://notebook_user/scheduled_notebooks）
params_yaml_file

string

実行中にノートブックでオーバーライドされるパラメータ。入力ノートブックでパラメータを指定し、YAML ファイルで渡す方法については、https://papermill.readthedocs.io/en/latest/usage-parameterize.html を参照してください。例: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

input_notebook_file ノートブック内で使用されるパラメータ。
service_account

string

実行時に使用するサービス アカウントのメールアドレス。指定されたサービス アカウントに対する iam.serviceAccounts.actAs 権限が必要です。
job_type

JobType

この実行で使用するジョブのタイプ。
kernel_spec

string

使用するカーネル仕様の名前。実行ターゲットのカーネル仕様名が入力ノートブック ファイルの名前と一致しない場合は、これを指定する必要があります。
tensorboard

string

この実行で TensorBoard ログがアップロードされる Agent Platform の [TensorBoard] リソースの名前。形式: projects/{project}/locations/{location}/tensorboards/{tensorboard}
共用体フィールド job_parameters。実行タイプのパラメータ。注: 現在、VertexAI ジョブに追加のパラメータはありません。job_parameters は次のいずれかになります。
dataproc_parameters

DataprocParameters

Dataproc JobType の実行で使用されるパラメータ。
vertex_ai_parameters

VertexAIParameters

Agent Platform JobType の実行で使用されるパラメータ。

DataprocParameters

Dataproc JobType の実行で使用されるパラメータ。

フィールド
cluster

string

Dataproc の実行に使用されるクラスタの URI。形式: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

この実行に使用されたバックエンド。

列挙型
JOB_TYPE_UNSPECIFIED タイプが指定されていません。
VERTEX_AI aiplatform.googleapis.com のカスタムジョブ。実行のデフォルト値。
DATAPROC Dataproc をジョブとして使用してクラスタで実行を実行します。https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

必須。マシンタイプ、ワーカーとパラメータ サーバーのレプリカの数を指定します。

列挙型
SCALE_TIER_UNSPECIFIED スケールティアが指定されていません。
BASIC 単一ワーカー インスタンス。この階層は、Cloud ML の使用方法を学習するため、および小さいデータセットを使用して新しいモデルを実験するために適しています。
STANDARD_1 多数のワーカーと少数のパラメータ サーバー。
PREMIUM_1 非常に多くのワーカーと多数のパラメータ サーバー。
BASIC_GPU K80 GPU を備えた 1 つのワーカー インスタンス。
BASIC_TPU Cloud TPU を備えた単一のワーカー インスタンス。
CUSTOM

CUSTOM 階層はあらかじめ設定された階層ではなく、独自のクラスタ仕様を使用するための階層です。この階層を使用するときは、処理クラスタを構成するための値を、以下のガイドラインに沿って設定します。

  • マスターノードに使用するマシンのタイプを指定するために ExecutionTemplate.masterType を設定する必要があります。これが唯一の必須の設定です。

SchedulerAcceleratorConfig

ハードウェア アクセラレータの定義。type と core_count のすべての組み合わせが有効であるとは限りません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。TPU はサポートされていません。

フィールド
type

SchedulerAcceleratorType

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

int64

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

SchedulerAcceleratorType

AI Platform Training ジョブのハードウェア アクセラレータ タイプ。

列挙型
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED 未指定のアクセラレータ タイプ。デフォルトは GPU なしです。
NVIDIA_TESLA_K80 Nvidia Tesla K80 GPU.
NVIDIA_TESLA_P100 Nvidia Tesla P100 GPU.
NVIDIA_TESLA_V100 Nvidia Tesla V100 GPU.
NVIDIA_TESLA_P4 Nvidia Tesla P4 GPU.
NVIDIA_TESLA_T4 Nvidia Tesla T4 GPU.
NVIDIA_TESLA_A100 Nvidia Tesla A100 GPU。
TPU_V2 TPU v2.
TPU_V3 TPU v3.

VertexAIParameters

Agent Platform JobType の実行で使用されるパラメータ。

フィールド
network

string

ジョブをピアリングする Compute Engine ネットワークのフルネーム。例: projects/12345/global/networks/myVPCFormat の形式は projects/{project}/global/networks/{network} です。ここで、{project} はプロジェクト番号（12345 など）、{network} はネットワーク名です。

このネットワークに対して、プライベート サービス アクセスがすでに構成されている必要があります。指定しない場合、ジョブはどのネットワークともピアリングされません。
env

map<string, string>

環境変数。指定できる環境変数は最大 100 個で、それぞれ一意である必要があります。例: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

ノートブック環境の取得リクエスト。

フィールド
name

string

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

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

  • notebooks.environments.get

GetExecutionRequest

スケジュール設定されたノートブック実行の取得リクエスト

フィールド
name

string

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

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

  • notebooks.executions.get

GetInstanceHealthRequest

ノートブック インスタンスが正常かどうかを確認するリクエスト。

フィールド
name

string

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

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

  • notebooks.instances.getHealth

GetInstanceHealthResponse

ノートブック インスタンスが正常かどうかを確認するためのレスポンス。

フィールド
health_state

HealthState

出力専用。ランタイムの health_state。
health_info

map<string, string>

出力専用。インスタンスのヘルス状態に関する追加情報。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

インスタンスが正常かどうか。

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

GetInstanceRequest

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

フィールド
name

string

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

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

  • notebooks.instances.get

GetRuntimeRequest

マネージド ノートブック ランタイムを取得するためのリクエスト。

フィールド
name

string

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

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

  • notebooks.runtimes.get

GetScheduleRequest

スケジュール設定されたノートブックを取得するリクエスト。

フィールド
name

string

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

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

  • notebooks.schedules.get

インスタンス

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

フィールド
name

string

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

string

ノートブック インスタンスの起動が完了した後に自動的に実行される Bash スクリプトのパス。パスは、URL または Cloud Storage パス（gs://path-to-file/file-name）にする必要があります。
proxy_uri

string

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

string

入力専用。作成後のこのインスタンスのオーナー。形式: alias@example.com

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

string

このインスタンスのサービス アカウント。他の Google Cloud サービスへのアクセス権を付与します。同じプロジェクト内ではどのサービス アカウントでも使用できますが、インスタンスを使用するには、サービス アカウントのユーザー権限が必要です。

指定しない場合は、Compute Engine のデフォルトのサービス アカウントが使用されます。
service_account_scopes[]

string

省略可。Compute Engine インスタンスに含めるサービス アカウント スコープの URI。

指定しない場合は、次のスコープが定義されます。- https://www.googleapis.com/auth/cloud-platform- https://www.googleapis.com/auth/userinfo.emailデフォルトのスコープを使用しない場合は、少なくとも https://www.googleapis.com/auth/compute が必要です。
machine_type

string

必須。このインスタンスの Compute Engine マシンタイプ。
accelerator_config

AcceleratorConfig

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

State

出力専用。このインスタンスの状態。
install_gpu_driver

bool

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

string

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

DiskType

入力専用。このインスタンスにアタッチされているブートディスクのタイプ。デフォルトは標準永続ディスク（PD_STANDARD）です。
boot_disk_size_gb

int64

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

DiskType

入力専用。このインスタンスにアタッチされているデータディスクのタイプ。デフォルトは標準永続ディスク（PD_STANDARD）です。
data_disk_size_gb

int64

入力専用。このインスタンスにアタッチされているデータディスクのサイズ（GB 単位）。最大 64, 000 GB（64 TB）。ノートブックとデータのサイズに基づいて、データディスクのサイズを選択できます。指定しない場合、デフォルトは 100 です。
no_remove_data_disk

bool

入力専用。true の場合、インスタンスを削除してもデータディスクは自動的に削除されません。
disk_encryption

DiskEncryption

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

string

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

独自の暗号鍵の使用の詳細を確認する。
disks[]

Disk

出力専用。ノートブック インスタンスにアタッチされたディスク。
shielded_instance_config

ShieldedInstanceConfig

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

bool

true の場合、このインスタンスに外部 IP は割り当てられません。
no_proxy_access

bool

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

string

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

string

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

map<string, string>

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

map<string, string>

このインスタンスに適用するカスタム メタデータ。たとえば、自動バックアップ用の Cloud Storage バケットを指定するには、gcs-data-bucket メタデータタグを使用できます。形式: "--metadata=gcs-data-bucket=BUCKET"。
tags[]

string

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

UpgradeHistoryEntry

このインスタンスのアップグレード履歴。
nic_type

NicType

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

ReservationAffinity

省略可。省略可能な予約アフィニティ。このフィールドを設定すると、指定されたゾーン コンピューティング予約がこのノートブック インスタンスに適用されます。
creator

string

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

bool

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

Timestamp

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

Timestamp

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

InstanceMigrationEligibility

出力専用。UmN から WbI への移行の実現可能性を確認します。
共用体フィールド environment。環境のタイプ。VM イメージまたはコンテナ イメージのいずれかになります。environment は次のいずれかになります。
vm_image

VmImage

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

ContainerImage

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

bool

出力専用。このノートブックが Workbench インスタンスに移行されたかどうかを示すブール値

AcceleratorConfig

ハードウェア アクセラレータの定義。type と core_count のすべての組み合わせが有効であるとは限りません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。TPU はサポートされていません。

フィールド
type

AcceleratorType

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

int64

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

AcceleratorType

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

列挙型
ACCELERATOR_TYPE_UNSPECIFIED アクセラレータ タイプが指定されていません。
NVIDIA_TESLA_K80 アクセラレータ タイプは Nvidia Tesla K80 です。
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 です。
NVIDIA_L4 アクセラレータ タイプは Nvidia Tesla L4 です。
NVIDIA_A100_80GB アクセラレータ タイプは Nvidia Tesla A100 80 GB です。
NVIDIA_TESLA_T4_VWS アクセラレータ タイプは NVIDIA Tesla T4 仮想ワークステーションです。
NVIDIA_TESLA_P100_VWS アクセラレータ タイプは NVIDIA Tesla P100 仮想ワークステーションです。
NVIDIA_TESLA_P4_VWS アクセラレータ タイプは NVIDIA Tesla P4 仮想ワークステーションです。
NVIDIA_H100_80GB アクセラレータ タイプは NVIDIA H100 80 GB です。
NVIDIA_H100_MEGA_80GB アクセラレータ タイプは NVIDIA H100 Mega 80 GB です。
TPU_V2 （近日公開）アクセラレータ タイプが TPU V2 である。
TPU_V3 （近日公開）アクセラレータ タイプが TPU V3 である。

ディスク

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

フィールド
auto_delete

bool

インスタンスが削除されるときにディスクが自動削除されるかどうかを示します（ディスクがインスタンスから切り離されるときではなく）。
boot

bool

ブートディスクであることを示します。仮想マシンでは、ルート ファイルシステムとしてディスクの最初のパーティションが使用されます。
device_name

string

インスタンスで実行されている Linux オペレーティング システムの /dev/disk/by-id/google-* ツリーに反映される一意のデバイス名を示します。この名前を使用して、インスタンスからマウントやサイズ変更などのためにデバイスを参照できます。

デバイス名が指定されないと、サーバーがこのディスクに適用するデフォルトのデバイス名は persistent-disk-x の形式になります。x は Google Compute Engine によって割り当てられた番号を示します。このフィールドは永続ディスクにのみ適用されます。
disk_size_gb

int64

ディスクのサイズを 2 進数の GB 単位で示します。
guest_os_features[]

GuestOsFeature

ゲスト オペレーティング システムで有効にする機能のリストを示します。ブート可能なイメージにのみ適用されます。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。
index

int64

このディスクの 0 から始まるインデックス。0 はブートディスク用に予約されています。インスタンスに複数のディスクがアタッチされている場合、各ディスクには一意のインデックス番号が割り当てられます。
interface

string

このディスクの接続に使用するディスク インターフェース（SCSI または NVME）を示します。デフォルトは SCSI です。永続ディスクは常に SCSI を使用する必要があります。SCSI 以外の形式で永続ディスクをアタッチしようとすると、リクエストは失敗します。ローカル SSD は NVME または SCSI のいずれかを使用できます。NVMe 経由の SCSI のパフォーマンス特性については、ローカル SSD のパフォーマンスをご覧ください。有効な値:

  • NVME
  • SCSI
kind

string

リソースのタイプ。アタッチされたディスクの compute#attachedDisk を常に計算します。
licenses[]

string

一般公開されているライセンスのリスト。Google で使用するために予約されています。ライセンスは、パブリック イメージと Marketplace イメージの課金データと使用状況の集計データを表します。
mode

string

このディスクをアタッチするモード（READ_WRITE または READ_ONLY）。指定しない場合、デフォルトではディスクは READ_WRITE モードでアタッチされます。有効な値:

  • READ_ONLY
  • READ_WRITE
source

string

既存の Persistent Disk リソースへの有効な部分 URL または完全 URL を示します。
type

string

ディスクのタイプ（SCRATCH または PERSISTENT）を示します。有効な値:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

ブートディスクのゲスト OS の機能。

フィールド
type

string

サポートされている機能の ID。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。有効な値:

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

DiskEncryption

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

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

DiskType

ノートブック インスタンスで使用できるディスクタイプ。

列挙型
DISK_TYPE_UNSPECIFIED ディスクタイプが設定されていません。
PD_STANDARD 標準永続ディスクタイプ。
PD_SSD SSD 永続ディスクのタイプ。
PD_BALANCED バランス永続ディスクタイプ。
PD_EXTREME エクストリーム永続ディスクタイプ。

NicType

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

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

ShieldedInstanceConfig

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

フィールド
enable_secure_boot

bool

インスタンスでセキュアブートを有効にするかどうかを定義します。

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

bool

インスタンスで vTPM が有効になっているかどうかを定義します。デフォルトで有効になっています。
enable_integrity_monitoring

bool

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

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

状態

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

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

UpgradeHistoryEntry

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

フィールド
snapshot

string

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

string

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

string

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

string

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

string

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

State

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

Timestamp

このインスタンス アップグレード履歴エントリが作成された時刻。
target_image
(deprecated)

string

ターゲット VM イメージ。形式: ainotebooks-vm/project/image-name/name。
action

Action

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

string

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

アクション

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

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

状態

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

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

InstanceConfig

更新可能なノートブック インスタンス構成。

フィールド
notebook_upgrade_schedule

string

インスタンスの自動アップグレードのスケジュール設定に使用される UTC タイムゾーンの Cron 式。cron 形式に従ってください。
enable_health_monitoring

bool

コア内部サービスが実行されていることを確認します。

InstanceMigrationEligibility

InstanceMigrationEligibility は、UmN から WbI への移行の実現可能性に関する情報を表します。

フィールド
warnings[]

Warning

出力専用。移行中に、特定の構成がデフォルトに設定されます。
errors[]

Error

出力専用。特定の構成では、UmN は自動移行の対象外になります。手動での移行が必要です。

エラー

移行エラー メッセージは、特定の構成により UmN が自動移行の対象外になっていることを意味します。手動での移行が必要です。

列挙型
ERROR_UNSPECIFIED デフォルトのタイプ。
DATAPROC_HUB UmN は Dataproc Hub を使用するため、移行できません。

警告

移行の警告メッセージは、移行中に特定の構成がデフォルト設定になることを意味します。

列挙型
WARNING_UNSPECIFIED デフォルトのタイプ。
UNSUPPORTED_MACHINE_TYPE UmN で、WbI でサポートされていないマシンタイプが使用されています。デフォルトのマシンタイプ e2-standard-4 で移行されます。移行後にマシンタイプを変更できます。
UNSUPPORTED_ACCELERATOR_TYPE UmN で、WbI でサポートされていないアクセラレータ タイプが使用されています。アクセラレータなしで移行されます。アクセラレータは移行後に接続できます。
UNSUPPORTED_OS UmN が WbI でサポートされていないオペレーティング システム（Debian 10、Ubuntu など）を使用している。WbI では Debian 11 に置き換えられます。
NO_REMOVE_DATA_DISK この UmN は no_remove_data_disk で構成されていますが、これは WbI では使用できなくなりました。
GCS_BACKUP この UmN は、WbI で使用できなくなった Cloud Storage のバックアップ機能で構成されています。
POST_STARTUP_SCRIPT この UmN は、起動スクリプトで構成されています。必要に応じて、移行の post_startup_script_option を指定してください。

IsInstanceUpgradeableRequest

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

フィールド
notebook_instance

string

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

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

  • notebooks.instances.checkUpgradability
type

UpgradeType

省略可。省略可能な UpgradeType。このフィールドを設定すると、このインスタンスをアップグレードするための追加のコンピューティング イメージが検索されます。

IsInstanceUpgradeableResponse

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

フィールド
upgradeable

bool

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

string

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

string

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

string

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

ListEnvironmentsRequest

環境の一覧表示のリクエスト。

フィールド
parent

string

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

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

  • notebooks.environments.list
page_size

int32

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

string

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

ListEnvironmentsResponse

環境の一覧表示のレスポンス。

フィールド
environments[]

Environment

返された環境のリスト。
next_page_token

string

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

string

到達できなかったロケーション。

ListExecutionsRequest

スケジュール設定されたノートブック実行のリストを取得するリクエスト。

フィールド
parent

string

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

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

  • notebooks.executions.list
page_size

int32

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

string

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

string

結果の実行に適用されるフィルタ。現在、指定された schedule_id による実行のフィルタリングのみがサポートされています。形式: schedule_id=<Schedule_ID>
order_by

string

フィールドで並べ替えます。

ListExecutionsResponse

スケジュール設定されたノートブックの実行を一覧表示するためのレスポンス

フィールド
executions[]

Execution

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

string

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

string

到達できなかった実行 ID。次に例を示します。

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

ListInstancesRequest

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

フィールド
parent

string

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

認可には、指定されたリソース 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

到達できなかったロケーション。（例: ['us-west1-a', 'us-central1-b']）。ListInstancesResponse には、インスタンスまたは到達不能のいずれかのみが含まれます。

ListRuntimesRequest

マネージド ノートブック ランタイムのリストを取得するリクエスト。

フィールド
parent

string

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

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

  • notebooks.runtimes.list
page_size

int32

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

string

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

string

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

string

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

ListRuntimesResponse

マネージド ノートブック ランタイムの一覧表示に対するレスポンス。

フィールド
runtimes[]

Runtime

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

string

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

string

到達できなかったロケーション。（例: ['us-west1', 'us-central1']）。ListRuntimesResponse には、ランタイムまたは到達不能のいずれかのみが含まれます。

ListSchedulesRequest

スケジュール設定されたノートブック ジョブを一覧表示するリクエスト。

フィールド
parent

string

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

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

  • notebooks.schedules.list
page_size

int32

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

string

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

string

結果のスケジュールに適用されるフィルタ。
order_by

string

結果の並べ替えに使用するフィールド。

ListSchedulesResponse

スケジュールされたノートブック ジョブを一覧表示するためのレスポンス。

フィールド
schedules[]

Schedule

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

string

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

string

到達できなかったスケジュール。次に例を示します。

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

LocalDisk

ローカル接続されたディスク リソース。

フィールド
auto_delete

bool

省略可。出力専用。インスタンスが削除されるときにディスクが自動削除されるかどうかを示します（ディスクがインスタンスから切り離されるときではなく）。
boot

bool

省略可。出力専用。ブートディスクであることを示します。仮想マシンでは、ルート ファイルシステムとしてディスクの最初のパーティションが使用されます。
device_name

string

省略可。出力専用。インスタンスで実行されている Linux オペレーティング システムの /dev/disk/by-id/google-* ツリーに反映される一意のデバイス名を示します。この名前を使用して、インスタンスからマウントやサイズ変更などのためにデバイスを参照できます。

デバイス名が指定されないと、サーバーがこのディスクに適用するデフォルトのデバイス名は persistent-disk-x の形式になります。x は Google Compute Engine によって割り当てられた番号を示します。このフィールドは永続ディスクでのみ使用されます。
guest_os_features[]

RuntimeGuestOsFeature

出力専用。ゲスト オペレーティング システムで有効にする機能のリストを示します。ブート可能なイメージにのみ適用されます。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。
index

int32

出力専用。このディスクの 0 から始まるインデックス。0 はブートディスク用に予約されています。インスタンスに複数のディスクがアタッチされている場合、各ディスクには一意のインデックス番号が割り当てられます。
initialize_params

LocalDiskInitializeParams

入力専用。新しいインスタンスとともに作成される新しいディスクのパラメータを指定します。初期化パラメータを使用して、新しいインスタンスにアタッチされたブートディスクまたはローカル SSD を作成します。

このプロパティは参照元プロパティと相互に排他的です。どちらか一方のみを定義できます。両方を定義することはできません。
interface

string

このディスクの接続に使用するディスク インターフェース（SCSI または NVME）を指定します。デフォルトは SCSI です。永続ディスクは常に SCSI を使用する必要があります。SCSI 以外の形式で永続ディスクをアタッチしようとすると、リクエストは失敗します。ローカル SSD は NVME または SCSI のいずれかを使用できます。NVMe 経由の SCSI のパフォーマンス特性については、ローカル SSD のパフォーマンスをご覧ください。有効な値:

  • NVME
  • SCSI
kind

string

出力専用。リソースのタイプ。アタッチされたディスクの compute#attachedDisk を常に計算します。
licenses[]

string

出力専用。有効な公開ライセンス。
mode

string

このディスクをアタッチするモード（READ_WRITE または READ_ONLY）。指定しない場合、デフォルトではディスクは READ_WRITE モードでアタッチされます。有効な値:

  • READ_ONLY
  • READ_WRITE
source

string

既存の Persistent Disk リソースへの有効な部分 URL または完全 URL を指定します。
type

string

ディスクのタイプ（SCRATCH または PERSISTENT）を指定します。指定しない場合、デフォルトは PERSISTENT です。有効な値:

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

省略可。ゲスト オペレーティング システムで有効にする機能のリスト。ブート可能なイメージにのみ適用されます。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。ブートディスクのゲスト OS の機能。

フィールド
type

string

サポートされている機能の ID。使用可能なオプションの一覧については、ゲスト オペレーティング システムの機能を有効にするをご覧ください。

有効な値:

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

LocalDiskInitializeParams

入力専用。新しいインスタンスとともに作成される新しいディスクのパラメータを指定します。初期化パラメータを使用して、新しいランタイムにアタッチされたブートディスクまたはローカル SSD を作成します。このプロパティは参照元プロパティと相互に排他的です。どちらか一方のみを定義できます。両方を定義することはできません。

フィールド
description

string

省略可。ディスクの作成時に、このプロパティを指定します。
disk_name

string

省略可。ディスク名を指定します。指定しない場合、デフォルトではインスタンスの名前が使用されます。インスタンス名を持つディスクが指定されたゾーン/リージョンにすでに存在する場合、新しい名前が自動的に生成されます。
disk_size_gb

int64

省略可。ディスクのサイズを 2 進数の GB で指定します。指定しない場合、ディスクはイメージと同じサイズ（通常は 10 GB）になります。指定する場合、サイズは 10 GB 以上にする必要があります。デフォルトは 100 GB です。
disk_type

DiskType

入力専用。このインスタンスにアタッチされているブートディスクのタイプ。デフォルトは標準永続ディスク（PD_STANDARD）です。
labels

map<string, string>

省略可。このディスクに適用するラベル。これらは、後で disks.setLabels メソッドで変更できます。このフィールドは永続ディスクでのみ使用されます。

DiskType

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

列挙型
DISK_TYPE_UNSPECIFIED ディスクタイプが設定されていません。
PD_STANDARD 標準永続ディスクタイプ。
PD_SSD SSD 永続ディスクのタイプ。
PD_BALANCED バランス永続ディスクタイプ。
PD_EXTREME エクストリーム永続ディスクタイプ。

MigrateInstanceRequest

ユーザー管理ノートブックを Workbench インスタンスに移行するリクエスト。

フィールド
name

string

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

承認には、指定されたリソース name に対する次の IAM 権限のうち 1 つ以上が必要です。

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

PostStartupScriptOption

省略可。移行中の起動スクリプトの動作を指定します。

PostStartupScriptOption

移行中の起動スクリプトの動作を指定します。

列挙型
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 起動スクリプト後のオプションが指定されていません。デフォルトは POST_STARTUP_SCRIPT_OPTION_SKIP です。
POST_STARTUP_SCRIPT_OPTION_SKIP 起動スクリプトを新しい Workbench インスタンスに移行しない。
POST_STARTUP_SCRIPT_OPTION_RERUN ユーザー管理ノートブックと同じ起動スクリプトを再ダウンロードして再実行します。

MigrateInstanceResponse

この型にはフィールドがありません。

MigrateInstance の空白のメッセージ レスポンス タイプ。

MigrateRuntimeRequest

Runtime を Workbench インスタンスに移行するリクエスト。

フィールド
name

string

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

承認には、指定されたリソース name に対する次の IAM 権限のうち 1 つ以上が必要です。

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

string

省略可。新しいインスタンスが配置されている VPC の名前。これは、ランタイムが Google マネージド ネットワークを使用する場合に必要です。Runtime がお客様所有のネットワークを使用している場合は、同じ VPC が再利用されるため、このフィールドは空にする必要があります。形式: projects/{project_id}/global/networks/{network_id}
subnet

string

省略可。新しいインスタンスが配置されるサブネットの名前。これは、ランタイムが Google マネージド ネットワークを使用する場合に必要です。ランタイムがお客様所有のネットワークを使用している場合は、同じサブネットが再利用されるため、このフィールドは空にする必要があります。形式: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account

string

省略可。ランタイムが権限に「シングル ユーザーのみ」モードを使用する場合に、新しい Workbench インスタンスの Compute Engine インスタンスに含まれるサービス アカウント。指定しない場合は、Compute Engine のデフォルトのサービス アカウントが使用されます。Runtime が権限にサービス アカウント モードを使用する場合、同じサービス アカウントが再利用されるため、このフィールドは空にする必要があります。
request_id

string

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

PostStartupScriptOption

省略可。移行中の起動スクリプトの動作を指定します。

PostStartupScriptOption

移行中の起動スクリプトの動作を指定します。

列挙型
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 起動スクリプト後のオプションが指定されていません。デフォルトは POST_STARTUP_SCRIPT_OPTION_SKIP です。
POST_STARTUP_SCRIPT_OPTION_SKIP 起動スクリプトを新しい Workbench インスタンスに移行しない。
POST_STARTUP_SCRIPT_OPTION_RERUN Google マネージド ノートブックと同じ起動スクリプトを再度ダウンロードして実行します。

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 エンドポイント名。

RegisterInstanceRequest

ノートブック インスタンスの登録リクエスト。

フィールド
parent

string

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

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

  • notebooks.instances.create
instance_id

string

必須。ユーザーが定義したこのインスタンスの固有 ID。instance_id は 1 ～ 63 文字で、英小文字、数字、ダッシュのみを使用する必要があります。先頭文字は小文字でなければならず、最後の文字にはダッシュは使用できません。

ReportInstanceInfoRequest

Notebooks API に情報を報告するノートブック インスタンスのリクエスト。

フィールド
name

string

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

string

必須。VM を認証するための VM ハードウェア トークン。https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata

map<string, string>

Notebooks API に報告されるメタデータ。これはインスタンス メタデータ ストアに統合されます。

ReportRuntimeEventRequest

マネージド ノートブック イベントのレポートのリクエスト。

フィールド
name

string

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

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

  • iam.permissions.none
vm_id

string

必須。VM を認証するための VM ハードウェア トークン。https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event

Event

必須。報告するイベント。

ReservationAffinity

ゾーン予約を使用するための予約アフィニティ。

フィールド
consume_reservation_type

Type

省略可。使用する予約のタイプ
key

string

省略可。予約リソースのラベルキーに対応します。
values[]

string

省略可。予約リソースのラベル値に対応します。

タイプ

予約から容量を使用するかどうかを示します。

列挙型
TYPE_UNSPECIFIED デフォルトのタイプ。
NO_RESERVATION 割り当てられた容量を使用しない。
ANY_RESERVATION 利用可能な予約を使用します。
SPECIFIC_RESERVATION 特定の予約から使用する必要があります。予約を指定するためのキー値フィールドを指定する必要があります。

ResetInstanceRequest

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

フィールド
name

string

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

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

  • notebooks.instances.reset

ResetRuntimeRequest

マネージド ノートブック ランタイムのリセットのリクエスト。

フィールド
name

string

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

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

  • notebooks.runtimes.reset
request_id

string

べき等リクエストの UUID。

RollbackInstanceRequest

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

フィールド
name

string

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

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

  • iam.permissions.none
target_snapshot

string

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

ランタイム

マネージド ノートブック インスタンスの Runtime の定義。

フィールド
name

string

出力専用。ランタイムのリソース名。形式: projects/{project}/locations/{location}/runtimes/{runtimeId}
state

State

出力専用。ランタイムの状態。
health_state

HealthState

出力専用。ランタイムの health_state。
access_config

RuntimeAccessConfig

ランタイムにアクセスするための構成設定。
software_config

RuntimeSoftwareConfig

ランタイム内のソフトウェアの構成設定。
metrics

RuntimeMetrics

出力専用。サービス ステータスや JupyterLab の統計情報などのランタイム デーモン指標が含まれます。
create_time

Timestamp

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

Timestamp

出力専用。ランタイムの更新時刻。
labels

map<string, string>

省略可。このマネージド ノートブックまたはランタイムに関連付けるラベル。ラベルのキーは 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。ラベルの値は空にできますが、指定する場合は 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。クラスタに関連付けることができるラベルは 32 個までです。
runtime_migration_eligibility

RuntimeMigrationEligibility

出力専用。GmN から WbI への移行の実現可能性を確認します。
共用体フィールド runtime_type。ランタイムのタイプ。現在、Compute Engine VM のみがサポートされています。runtime_type は次のいずれかになります。
virtual_machine

VirtualMachine

Compute Engine VM イメージを使用して、マネージド ノートブック インスタンスを起動します。
migrated

bool

出力専用。このノートブックが Workbench インスタンスに移行されたかどうかを示すブール値

HealthState

ランタイムのサブステート。

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

状態

このランタイムの状態の定義。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
STARTING コンピューティング レイヤがランタイムを開始しています。使用できる状態になっていません。
PROVISIONING コンピューティング レイヤは、必要なフレームワークをインストールし、ノートブック プロキシにランタイムを登録しています。使用できません。
ACTIVE ランタイムは現在実行中です。使用できる状態になっています。
STOPPING 制御ロジックがランタイムを停止しています。使用できません。
STOPPED ランタイムが停止しています。使用できません。
DELETING ランタイムを削除しています。使用できません。
UPGRADING ランタイムのアップグレード中です。使用できません。
INITIALIZING ランタイムの作成と設定が行われています。使用できる状態になっていません。

RuntimeAcceleratorConfig

使用できるハードウェア アクセラレータのタイプの定義。Compute Engine AcceleratorTypes をご覧ください。例:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
フィールド
type

AcceleratorType

アクセラレータ モデル。
core_count

int64

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

AcceleratorType

このアクセラレータのタイプ。

列挙型
ACCELERATOR_TYPE_UNSPECIFIED アクセラレータ タイプが指定されていません。
NVIDIA_TESLA_K80

アクセラレータ タイプは Nvidia Tesla K80 です。
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_L4 アクセラレータ タイプは Nvidia L4 です。
TPU_V2 （近日公開）アクセラレータ タイプが TPU V2 である。
TPU_V3 （近日公開）アクセラレータ タイプが TPU V3 である。
NVIDIA_TESLA_T4_VWS アクセラレータ タイプは NVIDIA Tesla T4 仮想ワークステーションです。
NVIDIA_TESLA_P100_VWS アクセラレータ タイプは NVIDIA Tesla P100 仮想ワークステーションです。
NVIDIA_TESLA_P4_VWS アクセラレータ タイプは NVIDIA Tesla P4 仮想ワークステーションです。

RuntimeAccessConfig

Runtime のログイン構成を指定します

フィールド
access_type

RuntimeAccessType

このインスタンスのアクセスモードのタイプ。
runtime_owner

string

作成後のこのランタイムのオーナー。形式: alias@example.com 現在、サポートされているオーナーは 1 人のみです。
proxy_uri

string

出力専用。ランタイムへのアクセスに使用されるプロキシ エンドポイント。

RuntimeAccessType

ランタイムにアクセスする方法は次のとおりです。認証モード。現在サポートされているのは、シングル ユーザーのみです。

列挙型
RUNTIME_ACCESS_TYPE_UNSPECIFIED アクセスが指定されていません。
SINGLE_USER シングル ユーザー ログイン。
SERVICE_ACCOUNT サービス アカウント モード。サービス アカウント モードでは、ランタイム作成者はコンシューマー プロジェクトに存在する SA を指定します。[ランタイム サービス アカウント] フィールドを使用します。ランタイムにアクセスするユーザーには、ActAs（サービス アカウント ユーザー）権限が必要です。

RuntimeMetrics

OS、カーネル、セッションの統計情報など、ランタイム デーモンの指標が含まれます。

フィールド
system_metrics

map<string, string>

出力専用。システム指標。

RuntimeMigrationEligibility

RuntimeMigrationEligibility は、GmN から WbI への移行の実現可能性に関する情報を表します。

フィールド
warnings[]

Warning

出力専用。移行中に、特定の構成がデフォルトに設定されます。
errors[]

Error

出力専用。特定の構成では、GmN は自動移行の対象外になります。手動での移行が必要です。

エラー

移行エラー メッセージは、特定の構成により GmN が自動移行の対象外になっていることを意味します。手動での移行が必要です。

列挙型
ERROR_UNSPECIFIED デフォルトのタイプ。
CUSTOM_CONTAINER GmN はカスタム コンテナで構成されているため、移行できません。

警告

移行の警告メッセージは、移行中に特定の構成がデフォルト設定になることを意味します。

列挙型
WARNING_UNSPECIFIED デフォルトのタイプ。
UNSUPPORTED_ACCELERATOR_TYPE GmN で、WbI でサポートされていないアクセラレータ タイプが使用されています。アクセラレータなしで移行されます。アクセラレータは移行後に接続できます。
UNSUPPORTED_OS GmN が WbI でサポートされていないオペレーティング システム（Debian 10 など）を使用している。WbI では Debian 11 に置き換えられます。
RESERVED_IP_RANGE この GmN は予約済みの IP 範囲で構成されていますが、これは WbI では適用されなくなりました。
GOOGLE_MANAGED_NETWORK この GmN は Google 管理のネットワークで構成されています。移行の network オプションと subnet オプションを指定してください。
POST_STARTUP_SCRIPT この GmN は、起動スクリプトで構成されています。必要に応じて、移行の post_startup_script_option を指定してください。
SINGLE_USER この GmN はシングル ユーザー モードで構成されています。必要に応じて、移行の service_account オプションを指定してください。

RuntimeShieldedInstanceConfig

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

フィールド
enable_secure_boot

bool

インスタンスでセキュアブートを有効にするかどうかを定義します。

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

bool

インスタンスで vTPM が有効になっているかどうかを定義します。デフォルトで有効になっています。
enable_integrity_monitoring

bool

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

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

RuntimeSoftwareConfig

ランタイム内のソフトウェアの選択と構成を指定します。ランタイムに設定するプロパティ。プロパティキーは key:value 形式で指定します。例:

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • enable_health_monitoring: true
フィールド
notebook_upgrade_schedule

string

インスタンスの自動アップグレードのスケジュール設定に使用される UTC タイムゾーンの Cron 式。cron 形式に従ってください。
idle_shutdown_timeout

int32

ランタイムをシャットダウンするまでの待機時間（分単位）。デフォルト: 180 分
install_gpu_driver

bool

Nvidia ドライバを自動的にインストールします。デフォルト: True
custom_gpu_driver_path

string

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

string

ノートブック インスタンスの起動が完了した後に自動的に実行される Bash スクリプトのパス。パスは、URL または Cloud Storage パス（gs://path-to-file/file-name）にする必要があります。
kernels[]

ContainerImage

省略可。ノートブック インスタンスでカーネルとして使用するコンテナ イメージのリストを使用します。
post_startup_script_behavior

PostStartupScriptBehavior

起動スクリプトの動作。
enable_health_monitoring

bool

コア内部サービスが実行されていることを確認します。デフォルト: True
idle_shutdown

bool

ランタイムは idle_shutdown_time の後に自動的にシャットダウンします。デフォルト: True
upgradeable

bool

出力専用。イメージ ファミリーで新しいイメージが利用可能かどうかを示すブール値。
disable_terminal

bool

JupyterLab ターミナルが使用可能かどうかを示すブール値。デフォルト: false
version

string

出力専用。イメージのリリースラベルから取得したブートイメージのバージョン（M100 など）。
mixer_disabled

bool

ミキサー クライアントを無効にするかどうかを示すブール値。デフォルト: false

PostStartupScriptBehavior

起動スクリプトの動作。

列挙型
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED 起動スクリプトの動作が指定されていません。作成時に 1 回だけ実行されます。
RUN_EVERY_START 作成時に指定された起動スクリプトを起動ごとに実行します。
DOWNLOAD_AND_RUN_EVERY_START 起動のたびに、指定された起動スクリプトをダウンロードして実行します。

スケジュール

スケジュールの定義。

フィールド
name

string

出力専用。このスケジュールの名前。形式: projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name

string

出力専用。UI で使用される表示名。名前には英数字、ハイフン -、アンダースコア _ のみを使用できます。
description

string

この環境の簡単な説明。
state

State
cron_schedule

string

ジョブが実行される cron-tab 形式のスケジュール。形式: 分、時、日、月、曜日（例: 0 0 * * WED = 毎週水曜日）。その他の例: https://crontab.guru/examples.html
time_zone

string

cron_schedule のタイムゾーン。このフィールドの値は、tz database から取得したタイムゾーン名にする必要があります。TZ データベース: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

一部のタイムゾーンには、夏時間の規定が含まれています。夏時間のルールは、選択した tz によって決まります。UTC の場合は、文字列「utc」を使用します。タイムゾーンが指定されていない場合、デフォルトは UTC（GMT ともいう）になります。
create_time

Timestamp

出力専用。スケジュールが作成された時刻。
update_time

Timestamp

出力専用。スケジュールが最後に更新された時刻。
execution_template

ExecutionTemplate

このスケジュールに対応するノートブック実行テンプレート。
recent_executions[]

Execution

出力専用。このスケジュールからトリガーされた最新の実行名と、対応する状態。

状態

ジョブの状態。

列挙型
STATE_UNSPECIFIED 未指定の状態
ENABLED ジョブは正常に実行されています。
PAUSED ジョブはユーザーによって一時停止されています。実行されません。ユーザーは、Cloud Scheduler を使用してジョブを意図的に一時停止できます。
DISABLED エラーのため、ジョブはシステムによって無効になっています。ユーザーがジョブを無効に設定することはできません。
UPDATE_FAILED CloudScheduler.UpdateJob オペレーションが失敗した結果のジョブの状態。この状態からジョブを復元するには、正常なレスポンスを受信するまで CloudScheduler.UpdateJob を再試行します。
INITIALIZING スケジュール リソースの作成中です。
DELETING スケジュール リソースを削除中です。

SetInstanceAcceleratorRequest

インスタンス アクセラレータの設定のリクエスト。

フィールド
name

string

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

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

  • notebooks.instances.setAccelerator
type

AcceleratorType

必須。このアクセラレータのタイプ。
core_count

int64

必須。このアクセラレータのコア数。type と core_count のすべての組み合わせが有効であるとは限りません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。TPU はサポートされていません。

SetInstanceLabelsRequest

インスタンス ラベルの設定リクエスト。

フィールド
name

string

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

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

  • notebooks.instances.setLabels
labels

map<string, string>

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

SetInstanceMachineTypeRequest

インスタンスのマシンタイプの設定リクエスト。

フィールド
name

string

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

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

  • notebooks.instances.setMachineType
machine_type

string

必須。Compute Engine のマシンタイプ。

StartInstanceRequest

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

フィールド
name

string

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

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

  • notebooks.instances.start

StartRuntimeRequest

マネージド ノートブック ランタイムの開始リクエスト。

フィールド
name

string

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

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

  • notebooks.runtimes.start
request_id

string

べき等リクエストの UUID。

StopInstanceRequest

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

フィールド
name

string

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

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

  • notebooks.instances.stop

StopRuntimeRequest

マネージド ノートブック ランタイムの停止リクエスト。

フィールド
name

string

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

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

  • notebooks.runtimes.stop
request_id

string

べき等リクエストの UUID。

SwitchRuntimeRequest

マネージド ノートブック ランタイムの切り替えリクエスト。

フィールド
name

string

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

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

  • notebooks.runtimes.switch
machine_type

string

マシンタイプ。
accelerator_config

RuntimeAcceleratorConfig

アクセラレータ構成。
request_id

string

べき等リクエストの UUID。

UpdateInstanceConfigRequest

インスタンス構成の更新リクエスト。

フィールド
name

string

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

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

  • notebooks.instances.updateConfig
config

InstanceConfig

更新するインスタンス構成。

UpdateInstanceMetadataItemsRequest

インスタンスのメタデータ項目の追加/変更のリクエスト。

フィールド
name

string

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

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

  • notebooks.instances.updateConfig
items

map<string, string>

インスタンスに追加または更新するメタデータ項目。

UpdateInstanceMetadataItemsResponse

インスタンスのメタデータ項目の追加/変更のレスポンス。

フィールド
items

map<string, string>

メタデータに追加または更新されたアイテムのマップ。

UpdateRuntimeRequest

マネージド ノートブック構成の更新リクエスト。

フィールド
runtime

Runtime

必須。更新する Runtime。

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

  • notebooks.runtimes.update
update_mask

FieldMask

必須。更新するフィールドの Runtime に対する相対パスを指定します。たとえば、ソフトウェア構成のカーネルを変更するには、次のように、update_mask パラメータを software_config.kernels として指定し、PATCH リクエストの本文に新しい値を指定します。

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

現在、更新できるフィールドは次のとおりです。

  • 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。

UpdateShieldedInstanceConfigRequest

ノートブック インスタンスのシールドされたインスタンス構成を更新するリクエスト。このメソッドは、停止したインスタンスでのみ使用できます。

フィールド
name

string

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

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

  • notebooks.instances.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

更新する ShieldedInstance 構成。

UpgradeInstanceRequest

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

フィールド
name

string

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

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

  • notebooks.instances.upgrade
type

UpgradeType

省略可。省略可能な UpgradeType。このフィールドを設定すると、このインスタンスをアップグレードするための追加のコンピューティング イメージが検索されます。

UpgradeType

このインスタンスで使用できるアップグレードのタイプの定義。

列挙型
UPGRADE_TYPE_UNSPECIFIED アップグレード タイプが指定されていません。
UPGRADE_FRAMEWORK ML フレームワークをアップグレードします。
UPGRADE_OS オペレーティング システムをアップグレードします。
UPGRADE_CUDA CUDA をアップグレードします。
UPGRADE_ALL すべてをアップグレード（OS、フレームワーク、CUDA）。

VirtualMachine

コンピューティングに仮想マシンを使用するランタイム。

フィールド
instance_name

string

出力専用。マネージド Compute Engine インスタンスのわかりやすい名前。
instance_id

string

出力専用。マネージド Compute Engine インスタンスの一意の識別子。
virtual_machine_config

VirtualMachineConfig

仮想マシンの構成設定。

VirtualMachineConfig

仮想マシンの構成設定。

フィールド
zone

string

出力専用。仮想マシンが配置されているゾーン。リージョン リクエストを使用している場合、Notebooks サービスは対応するランタイム リージョン内のロケーションを選択します。GET リクエストでは、常にゾーンが存在します。例: * us-central1-b
machine_type

string

必須。ランタイムに使用する Compute Engine のマシンタイプ。略称は有効です。例: * n1-standard-2 * e2-standard-8
container_images[]

ContainerImage

省略可。ノートブック インスタンスでカーネルとして使用するコンテナ イメージのリストを使用します。
data_disk

LocalDisk

必須。データディスク オプションの構成設定。
encryption_config

EncryptionConfig

省略可。仮想マシン データディスクの暗号化設定。
shielded_instance_config

RuntimeShieldedInstanceConfig

省略可。Shielded VM インスタンスの構成設定。
accelerator_config

RuntimeAcceleratorConfig

省略可。このランタイムの Compute Engine アクセラレータ構成。
network

string

省略可。マシンの通信に使用する Compute Engine ネットワーク。サブネットワークと一緒に指定することはできません。network も subnet も指定されていない場合、プロジェクトの「デフォルト」ネットワークが存在すれば、それが使用されます。

完全な URL または部分的な URI。例:

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

ランタイムは、Google インフラストラクチャ内のマネージド リソースです。ランタイムは、次のネットワーク構成をサポートしています。

  • Google Managed Network（ネットワークとサブネットが空）
  • コンシューマー プロジェクトの VPC（ネットワークとサブネットは必須）。プライベート サービス アクセスの構成が必要です。
  • 共有 VPC（ネットワークとサブネットが必要です）。プライベート サービス アクセスの構成が必要です。
subnet

string

省略可。マシンの通信に使用する Compute Engine サブネットワーク。ネットワークと一緒に指定することはできません。

完全な URL または部分的な URI が有効です。例:

  • 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

省略可。true の場合、ランタイムには内部 IP アドレスのみが割り当てられます。デフォルトでは、ランタイムは内部 IP アドレスに制限されず、各 VM にエフェメラル外部 IP アドレスが割り当てられます。この internal_ip_only 制限は、サブネットワークが有効になっているネットワークでのみ有効にできます。また、すべての依存関係が外部 IP アドレスなしでアクセスできるように構成されている必要があります。
tags[]

string

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

map<string, string>

出力専用。Compute Engine ゲスト属性。（プロジェクトとインスタンスのゲスト属性をご覧ください）。
metadata

map<string, string>

省略可。仮想マシンに追加する Compute Engine メタデータ エントリ。（プロジェクトとインスタンスのメタデータをご覧ください）。
labels

map<string, string>

省略可。このランタイムに関連付けるラベル。ラベルのキーは 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。ラベルの値は空にできますが、指定する場合は 1 ～ 63 文字で、RFC 1035 に準拠している必要があります。クラスタに関連付けることができるラベルは 32 個までです。
nic_type

NicType

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

string

省略可。予約済みの IP 範囲名は、VPC ピアリングに使用されます。割り当てられている場合は、サブネットワークの割り当てで範囲 name が使用されます。

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

フィールド値は managed-notebooks-range-c になります
boot_image

BootImage

省略可。ランタイムのアップグレード可能性に使用されるブートイメージのメタデータ。

BootImage

この型にはフィールドがありません。

ランタイムで使用されるブートイメージの定義。ランタイムのアップグレードを容易にするために使用されます。

NicType

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

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

VmImage

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

フィールド
project

string

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

string

VM イメージ名を使用してイメージを見つけます。
image_family

string

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