Send feedback
Cloud AI Platform v1 API - Class NotebookExecutionJob (3.13.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.13.0 keyboard_arrow_down
public sealed class NotebookExecutionJob : IMessage<NotebookExecutionJob>, IEquatable<NotebookExecutionJob>, IDeepCloneable<NotebookExecutionJob>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud AI Platform v1 API class NotebookExecutionJob.
NotebookExecutionJob represents an instance of a notebook execution.
Inheritance
object >
NotebookExecutionJob
Namespace
Google.Cloud.AIPlatform.V1
Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
public NotebookExecutionJob()
public NotebookExecutionJob(NotebookExecutionJob other)
Properties
public Timestamp CreateTime { get; set; }
Output only. Timestamp when this NotebookExecutionJob was created.
public NotebookExecutionJob.Types.CustomEnvironmentSpec CustomEnvironmentSpec { get; set; }
The custom compute configuration for an execution job.
public NotebookExecutionJob.Types.DataformRepositorySource DataformRepositorySource { get; set; }
The Dataform Repository pointing to a single file notebook repository.
public NotebookExecutionJob.Types.DirectNotebookSource DirectNotebookSource { get; set; }
The contents of an input notebook file.
public string DisplayName { get; set; }
The display name of the NotebookExecutionJob. The name can be up to 128
characters long and can consist of any UTF-8 characters.
Property Value
Type Description
string
public EncryptionSpec EncryptionSpec { get; set; }
Customer-managed encryption key spec for the notebook execution job.
This field is auto-populated if the
[NotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookRuntimeTemplate]
has an encryption spec.
public NotebookExecutionJob.EnvironmentSpecOneofCase EnvironmentSpecCase { get; }
public NotebookExecutionJob.ExecutionIdentityOneofCase ExecutionIdentityCase { get; }
public NotebookExecutionJob.ExecutionSinkOneofCase ExecutionSinkCase { get; }
public Duration ExecutionTimeout { get; set; }
Max running time of the execution job in seconds (default 86400s / 24 hrs).
Property Value
Type Description
Duration
public string ExecutionUser { get; set; }
The user email to run the execution as. Only supported by Colab runtimes.
Property Value
Type Description
string
public NotebookExecutionJob.Types.GcsNotebookSource GcsNotebookSource { get; set; }
The Cloud Storage url pointing to the ipynb file. Format:
gs://bucket/notebook_file.ipynb
public string GcsOutputUri { get; set; }
The Cloud Storage location to upload the result to. Format:
gs://bucket-name
Property Value
Type Description
string
public bool HasExecutionUser { get; }
Gets whether the "execution_user" field is set
Property Value
Type Description
bool
public bool HasGcsOutputUri { get; }
Gets whether the "gcs_output_uri" field is set
Property Value
Type Description
bool
public bool HasNotebookRuntimeTemplateResourceName { get; }
Gets whether the "notebook_runtime_template_resource_name" field is set
Property Value
Type Description
bool
public bool HasServiceAccount { get; }
Gets whether the "service_account" field is set
Property Value
Type Description
bool
public JobState JobState { get; set; }
Output only. The state of the NotebookExecutionJob.
Property Value
Type Description
JobState
public string KernelName { get; set; }
The name of the kernel to use during notebook execution. If unset, the
default kernel is used.
Property Value
Type Description
string
public MapField<string, string> Labels { get; }
The labels with user-defined metadata to organize NotebookExecutionJobs.
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.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
public string Name { get; set; }
Output only. The resource name of this NotebookExecutionJob. Format:
projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
Property Value
Type Description
string
public NotebookExecutionJobName NotebookExecutionJobName { get; set; }
public string NotebookRuntimeTemplateResourceName { get; set; }
The NotebookRuntimeTemplate to source compute configuration from.
Property Value
Type Description
string
public NotebookRuntimeTemplateName NotebookRuntimeTemplateResourceNameAsNotebookRuntimeTemplateName { get; set; }
public NotebookExecutionJob.NotebookSourceOneofCase NotebookSourceCase { get; }
public NotebookExecutionJob.RuntimeEnvironmentOneofCase RuntimeEnvironmentCase { get; }
public string ScheduleResourceName { get; set; }
Output only. The Schedule resource name if this job is triggered by one.
Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
Property Value
Type Description
string
public ScheduleName ScheduleResourceNameAsScheduleName { get; set; }
public string ServiceAccount { get; set; }
The service account to run the execution as.
Property Value
Type Description
string
public Status Status { get; set; }
Output only. Populated when the NotebookExecutionJob is completed. When
there is an error during notebook execution, the error details are
populated.
Property Value
Type Description
Status
public Timestamp UpdateTime { get; set; }
Output only. Timestamp when this NotebookExecutionJob was most recently
updated.
public NotebookExecutionJob.Types.WorkbenchRuntime WorkbenchRuntime { get; set; }
The Workbench runtime configuration to use for the notebook execution.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["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-01-28 UTC."],[],[]]
