GOgoogle
projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}

Updates a NotebookRuntimeTemplate.

Request

Path parameters

projectsIdstring required
locationsIdstring required
notebookRuntimeTemplatesIdstring required

Query parameters

updateMaskstring google-fieldmask

Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Input format: {paths: "${updated_field}"} Updatable fields: * encryption_spec.kms_key_name * display_name * software_config.post_startup_script_config.post_startup_script * software_config.post_startup_script_config.post_startup_script_url * software_config.post_startup_script_config.post_startup_script_behavior * software_config.env * software_config.colab_image.release_name * software_config.custom_container_config.image_uri

Request body

createTimestring google-datetime

Output only. Timestamp when this NotebookRuntimeTemplate was created.

descriptionstring

The description of the NotebookRuntimeTemplate.

displayNamestring

Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.

etagstring

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

isDefaultboolean

Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.

labelsobject

The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

namestring

The resource name of the NotebookRuntimeTemplate.

networkTagsstring[]

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

notebookRuntimeType'NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED' | 'USER_DEFINED' | 'ONE_CLICK'

Optional. Immutable. The type of the notebook runtime template.

serviceAccountstring

Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

updateTimestring google-datetime

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Response

Successful response

createTimestring google-datetime

Output only. Timestamp when this NotebookRuntimeTemplate was created.

descriptionstring

The description of the NotebookRuntimeTemplate.

displayNamestring

Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.

etagstring

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

isDefaultboolean

Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.

labelsobject

The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

namestring

The resource name of the NotebookRuntimeTemplate.

networkTagsstring[]

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

notebookRuntimeType'NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED' | 'USER_DEFINED' | 'ONE_CLICK'

Optional. Immutable. The type of the notebook runtime template.

serviceAccountstring

Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

updateTimestring google-datetime

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Changes

No recorded changes to this operation across all 8 revisions of this API.