Class GoogleCloudAiplatformV1NotebookExecutionJob

NotebookExecutionJob represents an instance of a notebook execution.

Inheritance

object

GoogleCloudAiplatformV1NotebookExecutionJob

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1NotebookExecutionJob : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when this NotebookExecutionJob was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

CustomEnvironmentSpec

The custom compute configuration for an execution job.

Declaration

[JsonProperty("customEnvironmentSpec")]
public virtual GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec CustomEnvironmentSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec

DataformRepositorySource

The Dataform Repository pointing to a single file notebook repository.

Declaration

[JsonProperty("dataformRepositorySource")]
public virtual GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource DataformRepositorySource { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource

DirectNotebookSource

The contents of an input notebook file.

Declaration

[JsonProperty("directNotebookSource")]
public virtual GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource DirectNotebookSource { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource

DisplayName

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

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EncryptionSpec

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

Declaration

[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1EncryptionSpec

ExecutionTimeout

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

Declaration

[JsonProperty("executionTimeout")]
public virtual object ExecutionTimeout { get; set; }

Property Value

Type	Description
object

ExecutionUser

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

Declaration

[JsonProperty("executionUser")]
public virtual string ExecutionUser { get; set; }

Property Value

Type	Description
string

GcsNotebookSource

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

Declaration

[JsonProperty("gcsNotebookSource")]
public virtual GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource GcsNotebookSource { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource

GcsOutputUri

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

Declaration

[JsonProperty("gcsOutputUri")]
public virtual string GcsOutputUri { get; set; }

Property Value

Type	Description
string

JobState

Output only. The state of the NotebookExecutionJob.

Declaration

[JsonProperty("jobState")]
public virtual string JobState { get; set; }

Property Value

Type	Description
string

KernelName

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

Declaration

[JsonProperty("kernelName")]
public virtual string KernelName { get; set; }

Property Value

Type	Description
string

Labels

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.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Name

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

NotebookRuntimeTemplateResourceName

The NotebookRuntimeTemplate to source compute configuration from.

Declaration

[JsonProperty("notebookRuntimeTemplateResourceName")]
public virtual string NotebookRuntimeTemplateResourceName { get; set; }

Property Value

Type	Description
string

ScheduleResourceName

The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

Declaration

[JsonProperty("scheduleResourceName")]
public virtual string ScheduleResourceName { get; set; }

Property Value

Type	Description
string

ServiceAccount

The service account to run the execution as.

Declaration

[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }

Property Value

Type	Description
string

Status

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

Declaration

[JsonProperty("status")]
public virtual GoogleRpcStatus Status { get; set; }

Property Value

Type	Description
GoogleRpcStatus

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

WorkbenchRuntime

The Workbench runtime configuration to use for the notebook execution.

Declaration

[JsonProperty("workbenchRuntime")]
public virtual GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime WorkbenchRuntime { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime

Implements

IDirectResponseSchema