Cloud AI Platform v1 API - Class NotebookExecutionJob (3.5.0)

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

Implements

IMessage NotebookExecutionJob, IEquatable NotebookExecutionJob, IDeepCloneable NotebookExecutionJob, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

NotebookExecutionJob()

public NotebookExecutionJob()

NotebookExecutionJob(NotebookExecutionJob)

public NotebookExecutionJob(NotebookExecutionJob other)

Parameter
Name	Description
`other`	`NotebookExecutionJob`

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this NotebookExecutionJob was created.

Property Value
Type	Description
`Timestamp`

DataformRepositorySource

public NotebookExecutionJob.Types.DataformRepositorySource DataformRepositorySource { get; set; }

The Dataform Repository pointing to a single file notebook repository.

Property Value
Type	Description
`NotebookExecutionJobTypesDataformRepositorySource`

DirectNotebookSource

public NotebookExecutionJob.Types.DirectNotebookSource DirectNotebookSource { get; set; }

The contents of an input notebook file.

Property Value
Type	Description
`NotebookExecutionJobTypesDirectNotebookSource`

DisplayName

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`

EnvironmentSpecCase

public NotebookExecutionJob.EnvironmentSpecOneofCase EnvironmentSpecCase { get; }

Property Value
Type	Description
`NotebookExecutionJobEnvironmentSpecOneofCase`

ExecutionIdentityCase

public NotebookExecutionJob.ExecutionIdentityOneofCase ExecutionIdentityCase { get; }

Property Value
Type	Description
`NotebookExecutionJobExecutionIdentityOneofCase`

ExecutionSinkCase

public NotebookExecutionJob.ExecutionSinkOneofCase ExecutionSinkCase { get; }

Property Value
Type	Description
`NotebookExecutionJobExecutionSinkOneofCase`

ExecutionTimeout

public Duration ExecutionTimeout { get; set; }

Max running time of the execution job in seconds (default 86400s / 24 hrs).

Property Value
Type	Description
`Duration`

ExecutionUser

public string ExecutionUser { get; set; }

The user email to run the execution as. Only supported by Colab runtimes.

Property Value
Type	Description
`string`

GcsNotebookSource

public NotebookExecutionJob.Types.GcsNotebookSource GcsNotebookSource { get; set; }

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

Property Value
Type	Description
`NotebookExecutionJobTypesGcsNotebookSource`

GcsOutputUri

public string GcsOutputUri { get; set; }

The Cloud Storage location to upload the result to. Format: gs://bucket-name

Property Value
Type	Description
`string`

HasExecutionUser

public bool HasExecutionUser { get; }

Gets whether the "execution_user" field is set

Property Value
Type	Description
`bool`

HasGcsOutputUri

public bool HasGcsOutputUri { get; }

Gets whether the "gcs_output_uri" field is set

Property Value
Type	Description
`bool`

HasNotebookRuntimeTemplateResourceName

public bool HasNotebookRuntimeTemplateResourceName { get; }

Gets whether the "notebook_runtime_template_resource_name" field is set

Property Value
Type	Description
`bool`

HasServiceAccount

public bool HasServiceAccount { get; }

Gets whether the "service_account" field is set

Property Value
Type	Description
`bool`

JobState

public JobState JobState { get; set; }

Output only. The state of the NotebookExecutionJob.

Property Value
Type	Description
`JobState`

Labels

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.

Property Value
Type	Description
`MapFieldstringstring`

Name

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`

NotebookExecutionJobName

public NotebookExecutionJobName NotebookExecutionJobName { get; set; }

NotebookExecutionJobName-typed view over the Name resource name property.

Property Value
Type	Description
`NotebookExecutionJobName`

NotebookRuntimeTemplateResourceName

public string NotebookRuntimeTemplateResourceName { get; set; }

The NotebookRuntimeTemplate to source compute configuration from.

Property Value
Type	Description
`string`

NotebookRuntimeTemplateResourceNameAsNotebookRuntimeTemplateName

public NotebookRuntimeTemplateName NotebookRuntimeTemplateResourceNameAsNotebookRuntimeTemplateName { get; set; }

NotebookRuntimeTemplateName-typed view over the NotebookRuntimeTemplateResourceName resource name property.

Property Value
Type	Description
`NotebookRuntimeTemplateName`

NotebookSourceCase

public NotebookExecutionJob.NotebookSourceOneofCase NotebookSourceCase { get; }

Property Value
Type	Description
`NotebookExecutionJobNotebookSourceOneofCase`

ScheduleResourceName

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`

ScheduleResourceNameAsScheduleName

public ScheduleName ScheduleResourceNameAsScheduleName { get; set; }

ScheduleName-typed view over the ScheduleResourceName resource name property.

Property Value
Type	Description
`ScheduleName`

ServiceAccount

public string ServiceAccount { get; set; }

The service account to run the execution as.

Property Value
Type	Description
`string`

Status

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`

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type	Description
`Timestamp`