Represents a NotebookExecutionJob.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1beta1.INotebookExecutionJob);Constructs a new NotebookExecutionJob.
| Parameter | |
|---|---|
| Name | Description |
properties |
INotebookExecutionJob
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);NotebookExecutionJob createTime.
customEnvironmentSpec
public customEnvironmentSpec?: (google.cloud.aiplatform.v1beta1.NotebookExecutionJob.ICustomEnvironmentSpec|null);NotebookExecutionJob customEnvironmentSpec.
dataformRepositorySource
public dataformRepositorySource?: (google.cloud.aiplatform.v1beta1.NotebookExecutionJob.IDataformRepositorySource|null);NotebookExecutionJob dataformRepositorySource.
directNotebookSource
public directNotebookSource?: (google.cloud.aiplatform.v1beta1.NotebookExecutionJob.IDirectNotebookSource|null);NotebookExecutionJob directNotebookSource.
displayName
public displayName: string;NotebookExecutionJob displayName.
encryptionSpec
public encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null);NotebookExecutionJob encryptionSpec.
environmentSpec
public environmentSpec?: ("notebookRuntimeTemplateResourceName"|"customEnvironmentSpec");NotebookExecutionJob environmentSpec.
executionIdentity
public executionIdentity?: ("executionUser"|"serviceAccount");NotebookExecutionJob executionIdentity.
executionSink
public executionSink?: "gcsOutputUri";NotebookExecutionJob executionSink.
executionTimeout
public executionTimeout?: (google.protobuf.IDuration|null);NotebookExecutionJob executionTimeout.
executionUser
public executionUser?: (string|null);NotebookExecutionJob executionUser.
gcsNotebookSource
public gcsNotebookSource?: (google.cloud.aiplatform.v1beta1.NotebookExecutionJob.IGcsNotebookSource|null);NotebookExecutionJob gcsNotebookSource.
gcsOutputUri
public gcsOutputUri?: (string|null);NotebookExecutionJob gcsOutputUri.
jobState
public jobState: (google.cloud.aiplatform.v1beta1.JobState|keyof typeof google.cloud.aiplatform.v1beta1.JobState);NotebookExecutionJob jobState.
kernelName
public kernelName: string;NotebookExecutionJob kernelName.
labels
public labels: { [k: string]: string };NotebookExecutionJob labels.
name
public name: string;NotebookExecutionJob name.
notebookRuntimeTemplateResourceName
public notebookRuntimeTemplateResourceName?: (string|null);NotebookExecutionJob notebookRuntimeTemplateResourceName.
notebookSource
public notebookSource?: ("dataformRepositorySource"|"gcsNotebookSource"|"directNotebookSource");NotebookExecutionJob notebookSource.
runtimeEnvironment
public runtimeEnvironment?: "workbenchRuntime";NotebookExecutionJob runtimeEnvironment.
scheduleResourceName
public scheduleResourceName: string;NotebookExecutionJob scheduleResourceName.
serviceAccount
public serviceAccount?: (string|null);NotebookExecutionJob serviceAccount.
status
public status?: (google.rpc.IStatus|null);NotebookExecutionJob status.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);NotebookExecutionJob updateTime.
workbenchRuntime
public workbenchRuntime?: (google.cloud.aiplatform.v1beta1.NotebookExecutionJob.IWorkbenchRuntime|null);NotebookExecutionJob workbenchRuntime.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1beta1.INotebookExecutionJob): google.cloud.aiplatform.v1beta1.NotebookExecutionJob;Creates a new NotebookExecutionJob instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
INotebookExecutionJob
Properties to set |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
NotebookExecutionJob instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.NotebookExecutionJob;Decodes a NotebookExecutionJob message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
NotebookExecutionJob |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.NotebookExecutionJob;Decodes a NotebookExecutionJob message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
NotebookExecutionJob |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1beta1.INotebookExecutionJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified NotebookExecutionJob message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
INotebookExecutionJob
NotebookExecutionJob message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.INotebookExecutionJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified NotebookExecutionJob message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
INotebookExecutionJob
NotebookExecutionJob message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.NotebookExecutionJob;Creates a NotebookExecutionJob message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
NotebookExecutionJob |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for NotebookExecutionJob
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this NotebookExecutionJob to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1beta1.NotebookExecutionJob, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a NotebookExecutionJob message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
NotebookExecutionJob
NotebookExecutionJob |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a NotebookExecutionJob message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|