H2h2o
NotebookEngineService

Updates a NotebookEngine.

patch/v1/{notebookEngine.name}

Request

Path parameters

notebookEngine.namestring required

Output only. The resource name of the NotebookEngine. Format: workspaces/*/notebookEngines/*.

Query parameters

updateMaskstring required

The list of paths referencing which fields to update. Update mask must be non-empty.

Allowed field paths are: {"profile", "notebook_image", "cpu", "gpu", "memory_bytes", "display_name", "max_idle_duration", "max_running_duration"}. Paths are case sensitive (must match exactly).

To update all allowed fields, specify exactly one path with value "*".

Request body

displayNamestring

Optional. Human-readable name.

profilestring required

Required. The resource name of the NotebookEngineProfile that is assigned to this NotebookEngine. Format is workspaces/*/notebookEngineProfiles/*.

notebookImagestring required

Required. Immutable. The resource name of the NotebookEngineImage that is assigned to this NotebookEngine. Format is workspaces/*/notebookEngineImages/*.

cpuinteger nullable

Non-empty default. The amount of CPU units requested by this NotebookEngine.

gpuinteger nullable

Non-empty default. The amount of GPU units requested by this NotebookEngine.

memoryBytesstring int64 nullable

Non-empty default. The amount of memory in bytes requested by this NotebookEngine.

storageBytesstring int64 nullable

Non-empty default. The amount of storage requested by this NotebookEngine.

maxIdleDurationstring nullable

Non-empty default. Maximum time the NotebookEngine can be idle. When exceeded, the NotebookEngine will pause.

maxRunningDurationstring nullable

Non-empty default. Maximum time the NotebookEngine can be running. When exceeded, the NotebookEngine will pause.

state'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_PAUSING' | 'STATE_PAUSED' | 'STATE_FAILED' | 'STATE_DELETING' | 'STATE_TERMINATED'

The state of the NotebookEngine.

  • STATE_UNSPECIFIED: NotebookEngine state is unspecified or unknown.
  • STATE_STARTING: NotebookEngine is starting.
  • STATE_RUNNING: NotebookEngine is running and can be used.
  • STATE_PAUSING: NotebookEngine is pausing.
  • STATE_PAUSED: NotebookEngine is paused and can be resumed again.
  • STATE_FAILED: NotebookEngine has failed and can be resumed again.
  • STATE_DELETING: NotebookEngine is being deleted.
  • STATE_TERMINATED: NotebookEngine is terminated and cannot be resumed.
reconcilingboolean

Output only. Indicates whether changes to the resource are in progress.

uidstring

Output only. Globally unique identifier of the resource.

creatorstring

Output only. Name of entity that created the NotebookEngine.

updaterstring

Output only. Name of entity that last updated the NotebookEngine.

creatorDisplayNamestring

Output only. Human-readable name of entity that created the NotebookEngine.

updaterDisplayNamestring

Output only. Human-readable name of entity that last updated the NotebookEngine.

createTimestring date-time

Output only. Time when the NotebookEngine was created.

updateTimestring date-time nullable

Output only. Time when the NotebookEngine was last updated.

resumeTimestring date-time nullable

Output only. Time when the NotebookEngine was last resumed.

deleteTimestring date-time nullable

Output only. Optional. Time when the NotebookEngine was deleted.

currentIdleDurationstring nullable

Output only. Optional. Current time the NotebookEngine is idle.

currentRunningDurationstring nullable

Output only. Optional. Current time the NotebookEngine is running.

storageClassNamestring

Output only. Immutable. Name of the storage class used by NotebookEngine.

sharedboolean

Optional. Allows the engine to be shared with all users in the workspace.

failureReason'FAILURE_REASON_UNSPECIFIED' | 'FAILURE_REASON_UNKNOWN' | 'FAILURE_REASON_OOM_KILLED' | 'FAILURE_REASON_PROCESS_FAILED' | 'FAILURE_REASON_PVC_ACCESS_FAILURE'

The reason of the failed state for the NotebookEngine.

  • FAILURE_REASON_UNSPECIFIED: NotebookEngine failure reason is not set.
  • FAILURE_REASON_UNKNOWN: NotebookEngine failure reason exists, but is unknown.
  • FAILURE_REASON_OOM_KILLED: NotebookEngine exceeded its memory limit and was killed.
  • FAILURE_REASON_PROCESS_FAILED: NotebookEngine application crashed.
  • FAILURE_REASON_PVC_ACCESS_FAILURE: NotebookEngine cannot access the assigned PVC.
storageResizingboolean

Output only. Indicates whether the NotebookEngine disk is currently resizing. It make take hours to complete the resizing process, especially if the disk has been resized recently.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.