Class protos.google.cloud.notebooks.v1.Execution

Represents an Execution.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.notebooks.v1.IExecution);

Constructs a new Execution.

Parameter
NameDescription
properties IExecution

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Execution createTime.

description

public description: string;

Execution description.

displayName

public displayName: string;

Execution displayName.

executionTemplate

public executionTemplate?: (google.cloud.notebooks.v1.IExecutionTemplate|null);

Execution executionTemplate.

jobUri

public jobUri: string;

Execution jobUri.

name

public name: string;

Execution name.

outputNotebookFile

public outputNotebookFile: string;

Execution outputNotebookFile.

state

public state: (google.cloud.notebooks.v1.Execution.State|keyof typeof google.cloud.notebooks.v1.Execution.State);

Execution state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Execution updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1.IExecution): google.cloud.notebooks.v1.Execution;

Creates a new Execution instance using the specified properties.

Parameter
NameDescription
properties IExecution

Properties to set

Returns
TypeDescription
google.cloud.notebooks.v1.Execution

Execution instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.Execution;

Decodes an Execution message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.notebooks.v1.Execution

Execution

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.Execution;

Decodes an Execution message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.notebooks.v1.Execution

Execution

encode(message, writer)

public static encode(message: google.cloud.notebooks.v1.IExecution, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Execution message. Does not implicitly messages.

Parameters
NameDescription
message IExecution

Execution message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.notebooks.v1.IExecution, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Execution message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IExecution

Execution message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.Execution;

Creates an Execution message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.notebooks.v1.Execution

Execution

toJSON()

public toJSON(): { [k: string]: any };

Converts this Execution to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.notebooks.v1.Execution, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an Execution message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.notebooks.v1.Execution

Execution

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Execution message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not