Class protos.google.cloud.aiplatform.v1.Execution (1.11.0)

Represents an Execution.

Package

Constructors

(constructor)(properties)

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

Constructs a new Execution.

Parameter

Name	Description
properties	`IExecution` Properties to set

Properties

createTime

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

Execution createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

description

public description: string;

Execution description.

Property Value

Type	Description
string

displayName

public displayName: string;

Execution displayName.

Property Value

Type	Description
string

etag

public etag: string;

Execution etag.

Property Value

Type	Description
string

labels

public labels: { [k: string]: string };

Execution labels.

Property Value

Type	Description
{ [k: string]: string }

metadata

public metadata?: (google.protobuf.IStruct|null);

Execution metadata.

Property Value

Type	Description
(google.protobuf.IStruct\|null)

name

public name: string;

Execution name.

Property Value

Type	Description
string

schemaTitle

public schemaTitle: string;

Execution schemaTitle.

Property Value

Type	Description
string

schemaVersion

public schemaVersion: string;

Execution schemaVersion.

Property Value

Type	Description
string

state

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

Execution state.

Property Value

Type	Description
(google.cloud.aiplatform.v1.Execution.State\|keyof typeof google.cloud.aiplatform.v1.Execution.State)

updateTime

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

Execution updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

Methods

create(properties)

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

Creates a new Execution instance using the specified properties.

Parameter

Name	Description
properties	`IExecution` Properties to set

Returns

Type	Description
google.cloud.aiplatform.v1.Execution	Execution instance

decode(reader, length)

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

Decodes an Execution message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.aiplatform.v1.Execution	Execution

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.aiplatform.v1.Execution	Execution

encode(message, writer)

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

Encodes the specified Execution message. Does not implicitly messages.

Parameters

Name	Description
message	`IExecution` Execution 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.v1.IExecution, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IExecution` Execution 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.v1.Execution;

Creates an Execution 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
google.cloud.aiplatform.v1.Execution	Execution

toJSON()

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

Converts this Execution to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.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

Name	Description
message	`google.cloud.aiplatform.v1.Execution` Execution
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 an Execution message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not