public sealed class ExecutionTemplate : IMessage<ExecutionTemplate>, IEquatable<ExecutionTemplate>, IDeepCloneable<ExecutionTemplate>, IBufferMessage, IMessage
Reference documentation and code samples for the AI Platform Notebooks v1 API class ExecutionTemplate.
Path to the notebook file to execute.
Must be in a Google Cloud Storage bucket.
Format: gs://{bucket_name}/{folder}/{notebook_file_name}
Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
Name of the kernel spec to use. This must be specified if the
kernel spec name on the execution target does not match the name in the
input notebook file.
Labels for execution.
If execution is scheduled, a field included will be 'nbs-scheduled'.
Otherwise, it is an immediate execution, and an included field will be
'nbs-immediate'. Use fields to efficiently index between various types of
executions.
Path to the notebook folder to write to.
Must be in a Google Cloud Storage bucket path.
Format: gs://{bucket_name}/{folder}
Ex: gs://notebook_user/scheduled_notebooks
Parameters to be overridden in the notebook during execution.
Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
how to specifying parameters in the input notebook and pass them here
in an YAML file.
Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
The email address of a service account to use when running the execution.
You must have the iam.serviceAccounts.actAs permission for the specified
service account.
The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eExecutionTemplate\u003c/code\u003e class defines the configuration for executing notebook workloads within the AI Platform Notebooks v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThis class includes properties for setting up hardware configurations, such as \u003ccode\u003eAcceleratorConfig\u003c/code\u003e, \u003ccode\u003eScaleTier\u003c/code\u003e, and \u003ccode\u003eMasterType\u003c/code\u003e, to customize the execution environment.\u003c/p\u003e\n"],["\u003cp\u003eIt supports various job types, defined by \u003ccode\u003eJobType\u003c/code\u003e, including the use of Dataproc (\u003ccode\u003eDataprocParameters\u003c/code\u003e) and Vertex AI (\u003ccode\u003eVertexAiParameters\u003c/code\u003e) for specific execution scenarios.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eExecutionTemplate\u003c/code\u003e class allows for specifying input and output locations for notebook files, as well as parameters for notebook execution, such as \u003ccode\u003eInputNotebookFile\u003c/code\u003e, \u003ccode\u003eOutputNotebookFolder\u003c/code\u003e, \u003ccode\u003eParameters\u003c/code\u003e, and \u003ccode\u003eParamsYamlFile\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt is the latest version being 2.5.0, with backwards compatibility for versions going all the way back to 1.0.0-beta04.\u003c/p\u003e\n"]]],[],null,["# AI Platform Notebooks v1 API - Class ExecutionTemplate (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1.ExecutionTemplate)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/2.4.0/Google.Cloud.Notebooks.V1.ExecutionTemplate)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/2.3.0/Google.Cloud.Notebooks.V1.ExecutionTemplate)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/2.2.0/Google.Cloud.Notebooks.V1.ExecutionTemplate)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/2.1.0/Google.Cloud.Notebooks.V1.ExecutionTemplate)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/2.0.0/Google.Cloud.Notebooks.V1.ExecutionTemplate)\n- [1.0.0-beta04](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/1.0.0-beta04/Google.Cloud.Notebooks.V1.ExecutionTemplate) \n\n public sealed class ExecutionTemplate : IMessage\u003cExecutionTemplate\u003e, IEquatable\u003cExecutionTemplate\u003e, IDeepCloneable\u003cExecutionTemplate\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the AI Platform Notebooks v1 API class ExecutionTemplate.\n\nThe description a notebook execution workload. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ExecutionTemplate \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ExecutionTemplate](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1.ExecutionTemplate), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ExecutionTemplate](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1.ExecutionTemplate), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ExecutionTemplate](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1.ExecutionTemplate), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Notebooks.V1](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Notebooks.V1.dll\n\nConstructors\n------------\n\n### ExecutionTemplate()\n\n public ExecutionTemplate()\n\n### ExecutionTemplate(ExecutionTemplate)\n\n public ExecutionTemplate(ExecutionTemplate other)\n\nProperties\n----------\n\n### AcceleratorConfig\n\n public ExecutionTemplate.Types.SchedulerAcceleratorConfig AcceleratorConfig { get; set; }\n\nConfiguration (count and accelerator type) for hardware running notebook\nexecution.\n\n### ContainerImageUri\n\n public string ContainerImageUri { get; set; }\n\nContainer Image URI to a DLVM\nExample: 'gcr.io/deeplearning-platform-release/base-cu100'\nMore examples can be found at:\n\u003chttps://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container\u003e\n\n### DataprocParameters\n\n public ExecutionTemplate.Types.DataprocParameters DataprocParameters { get; set; }\n\nParameters used in Dataproc JobType executions.\n\n### InputNotebookFile\n\n public string InputNotebookFile { get; set; }\n\nPath to the notebook file to execute.\nMust be in a Google Cloud Storage bucket.\nFormat: `gs://{bucket_name}/{folder}/{notebook_file_name}`\nEx: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`\n\n### JobParametersCase\n\n public ExecutionTemplate.JobParametersOneofCase JobParametersCase { get; }\n\n### JobType\n\n public ExecutionTemplate.Types.JobType JobType { get; set; }\n\nThe type of Job to be used on this execution.\n\n### KernelSpec\n\n public string KernelSpec { get; set; }\n\nName of the kernel spec to use. This must be specified if the\nkernel spec name on the execution target does not match the name in the\ninput notebook file.\n\n### Labels\n\n public MapField\u003cstring, string\u003e Labels { get; }\n\nLabels for execution.\nIf execution is scheduled, a field included will be 'nbs-scheduled'.\nOtherwise, it is an immediate execution, and an included field will be\n'nbs-immediate'. Use fields to efficiently index between various types of\nexecutions.\n\n### MasterType\n\n public string MasterType { get; set; }\n\nSpecifies the type of virtual machine to use for your training\njob's master worker. You must specify this field when `scaleTier` is set to\n`CUSTOM`.\n\nYou can use certain Compute Engine machine types directly in this field.\nThe following types are supported:\n\n- `n1-standard-4`\n- `n1-standard-8`\n- `n1-standard-16`\n- `n1-standard-32`\n- `n1-standard-64`\n- `n1-standard-96`\n- `n1-highmem-2`\n- `n1-highmem-4`\n- `n1-highmem-8`\n- `n1-highmem-16`\n- `n1-highmem-32`\n- `n1-highmem-64`\n- `n1-highmem-96`\n- `n1-highcpu-16`\n- `n1-highcpu-32`\n- `n1-highcpu-64`\n- `n1-highcpu-96`\n\nAlternatively, you can use the following legacy machine types:\n\n- `standard`\n- `large_model`\n- `complex_model_s`\n- `complex_model_m`\n- `complex_model_l`\n- `standard_gpu`\n- `complex_model_m_gpu`\n- `complex_model_l_gpu`\n- `standard_p100`\n- `complex_model_m_p100`\n- `standard_v100`\n- `large_model_v100`\n- `complex_model_m_v100`\n- `complex_model_l_v100`\n\nFinally, if you want to use a TPU for training, specify `cloud_tpu` in this\nfield. Learn more about the [special configuration options for training\nwith\nTPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).\n\n### OutputNotebookFolder\n\n public string OutputNotebookFolder { get; set; }\n\nPath to the notebook folder to write to.\nMust be in a Google Cloud Storage bucket path.\nFormat: `gs://{bucket_name}/{folder}`\nEx: `gs://notebook_user/scheduled_notebooks`\n\n### Parameters\n\n public string Parameters { get; set; }\n\nParameters used within the 'input_notebook_file' notebook.\n\n### ParamsYamlFile\n\n public string ParamsYamlFile { get; set; }\n\nParameters to be overridden in the notebook during execution.\nRef \u003chttps://papermill.readthedocs.io/en/latest/usage-parameterize.html\u003e on\nhow to specifying parameters in the input notebook and pass them here\nin an YAML file.\nEx: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`\n\n### ScaleTier\n\n [Obsolete]\n public ExecutionTemplate.Types.ScaleTier ScaleTier { get; set; }\n\nRequired. Scale tier of the hardware used for notebook execution.\nDEPRECATED Will be discontinued. As right now only CUSTOM is supported.\n\n### ServiceAccount\n\n public string ServiceAccount { get; set; }\n\nThe email address of a service account to use when running the execution.\nYou must have the `iam.serviceAccounts.actAs` permission for the specified\nservice account.\n\n### Tensorboard\n\n public string Tensorboard { get; set; }\n\nThe name of a Vertex AI \\[Tensorboard\\] resource to which this execution\nwill upload Tensorboard logs.\nFormat:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}`\n\n### TensorboardAsTensorboardName\n\n public TensorboardName TensorboardAsTensorboardName { get; set; }\n\n[TensorboardName](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1.TensorboardName)-typed view over the [Tensorboard](/dotnet/docs/reference/Google.Cloud.Notebooks.V1/latest/Google.Cloud.Notebooks.V1.ExecutionTemplate#Google_Cloud_Notebooks_V1_ExecutionTemplate_Tensorboard) resource name property.\n\n### VertexAiParameters\n\n public ExecutionTemplate.Types.VertexAIParameters VertexAiParameters { get; set; }\n\nParameters used in Vertex AI JobType executions."]]
