Update Notebook Runtime configuration.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: notebooks1 --scope <scope> projects locations-runtimes-patch ...

Required Scalar Argument

• <name> (string)
  • Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Runtime:
  access-config:
    access-type: string
    proxy-uri: string
    runtime-owner: string
  create-time: string
  health-state: string
  labels: { string: string }
  metrics:
    system-metrics: { string: string }
  migrated: boolean
  name: string
  runtime-migration-eligibility:
    errors: [string]
    warnings: [string]
  software-config:
    custom-gpu-driver-path: string
    disable-terminal: boolean
    enable-health-monitoring: boolean
    idle-shutdown: boolean
    idle-shutdown-timeout: integer
    install-gpu-driver: boolean
    mixer-disabled: boolean
    notebook-upgrade-schedule: string
    post-startup-script: string
    post-startup-script-behavior: string
    upgradeable: boolean
    version: string
  state: string
  update-time: string
  virtual-machine:
    instance-id: string
    instance-name: string
    virtual-machine-config:
      accelerator-config:
        core-count: int64
        type: string
      data-disk:
        auto-delete: boolean
        boot: boolean
        device-name: string
        index: integer
        initialize-params:
          description: string
          disk-name: string
          disk-size-gb: string
          disk-type: string
          labels: { string: string }
        interface: string
        kind: string
        licenses: [string]
        mode: string
        source: string
        type: string
      encryption-config:
        kms-key: string
      guest-attributes: { string: string }
      internal-ip-only: boolean
      labels: { string: string }
      machine-type: string
      metadata: { string: string }
      network: string
      nic-type: string
      reserved-ip-range: string
      shielded-instance-config:
        enable-integrity-monitoring: boolean
        enable-secure-boot: boolean
        enable-vtpm: boolean
      subnet: string
      tags: [string]
      zone: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .access-config access-type=duo
  • The type of access mode this instance.
• proxy-uri=sit
  • Output only. The proxy endpoint that is used to access the runtime.

• runtime-owner=magna

  • The owner of this runtime after creation. Format: alias@example.com Currently supports one owner only.

• .. create-time=et

  • Output only. Runtime creation time.
• health-state=rebum.
  • Output only. Runtime health_state.
• labels=key=dolor
  • Optional. The labels to associate with this Managed Notebook or Runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
  • the value will be associated with the given key

• metrics system-metrics=key=lorem

  • Output only. The system metrics.
  • the value will be associated with the given key

• .. migrated=false

  • Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
• name=amet.
  • Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}
• runtime-migration-eligibility errors=no
  • Output only. Certain configurations make the GmN ineligible for an automatic migration. A manual migration is required.
  • Each invocation of this argument appends the given value to the array.

• warnings=nonumy

  • Output only. Certain configurations will be defaulted during the migration.
  • Each invocation of this argument appends the given value to the array.

• ..software-config custom-gpu-driver-path=sed

  • Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
• disable-terminal=false
  • Bool indicating whether JupyterLab terminal will be available or not. Default: False
• enable-health-monitoring=true
  • Verifies core internal services are running. Default: True
• idle-shutdown=false
  • Runtime will automatically shutdown after idle_shutdown_time. Default: True
• idle-shutdown-timeout=35
  • Time in minutes to wait before shutting down runtime. Default: 180 minutes
• install-gpu-driver=true
  • Install Nvidia Driver automatically. Default: True
• mixer-disabled=true
  • Bool indicating whether mixer client should be disabled. Default: False
• notebook-upgrade-schedule=dolore
  • Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the cron format.
• post-startup-script=amet
  • Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
• post-startup-script-behavior=ut
  • Behavior for the post startup script.
• upgradeable=true
  • Output only. Bool indicating whether an newer image is available in an image family.

• version=vero

  • Output only. version of boot image such as M100, from release label of the image.

• .. state=duo

  • Output only. Runtime state.
• update-time=sadipscing
  • Output only. Runtime update time.
• virtual-machine instance-id=ut
  • Output only. The unique identifier of the Managed Compute Engine instance.
• instance-name=rebum.
  • Output only. The user-friendly name of the Managed Compute Engine instance.
• virtual-machine-config.accelerator-config core-count=-70
  • Count of cores of this accelerator.

• type=kasd

  • Accelerator model.

• ..data-disk auto-delete=false

  • Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
• boot=true
  • Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
• device-name=sea
  • Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
• index=27
  • Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
• initialize-params description=lorem
  • Optional. Provide this property when creating the disk.
• disk-name=magna
  • Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
• disk-size-gb=takimata
  • Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
• disk-type=rebum.
  • Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

• labels=key=at

  • Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
  • the value will be associated with the given key

• .. interface=invidunt

  • Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: * NVME * SCSI
• kind=clita
  • Output only. Type of the resource. Always compute#attachedDisk for attached disks.
• licenses=stet
  • Output only. Any valid publicly visible licenses.
  • Each invocation of this argument appends the given value to the array.
• mode=aliquyam
  • The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: * READ_ONLY * READ_WRITE
• source=ut
  • Specifies a valid partial or full URL to an existing Persistent Disk resource.

• type=sit

  • Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values: * PERSISTENT * SCRATCH

• ..encryption-config kms-key=vero

  • The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a disks. It has the following format: projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}

• .. guest-attributes=key=rebum.

  • Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).
  • the value will be associated with the given key
• internal-ip-only=false
  • Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
• labels=key=dolores
  • Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
  • the value will be associated with the given key
• machine-type=sed
  • Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * n1-standard-2 * e2-standard-8
• metadata=key=invidunt
  • Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).
  • the value will be associated with the given key
• network=clita
  • Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default * projects/[project_id]/global/networks/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.
• nic-type=dolor
  • Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
• reserved-ip-range=aliquyam
  • Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned. Example: 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 Field value will be: managed-notebooks-range-c
• shielded-instance-config enable-integrity-monitoring=false
  • Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.
• enable-secure-boot=true
  • Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

• enable-vtpm=false

  • Defines whether the instance has the vTPM enabled. Enabled by default.

• .. subnet=et

  • Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 * projects/[project_id]/regions/us-east1/subnetworks/sub0
• tags=sanctus
  • Optional. The Compute Engine tags to add to runtime (see Tagging instances).
  • Each invocation of this argument appends the given value to the array.
• zone=accusam
  • Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example: * us-central1-b

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p request-id=string

  • Idempotent request UUID.

• -p update-mask=string

  • Required. Specifies the path, relative to Runtime, of the field to update. For example, to change the software configuration kernels, the update_mask parameter would be specified as software_config.kernels, and the PATCH request body would specify the new value, as follows: { "software_config":{ "kernels": [{ 'repository': 'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag': 'latest' }], } } Currently, only the following fields can be updated: - 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

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").