Class protos.google.cloud.aiplatform.v1.CustomJob (1.16.0)

Represents a CustomJob.

Package

Constructors

(constructor)(properties)

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

Constructs a new CustomJob.

Parameter

Name	Description
properties	`ICustomJob` Properties to set

Properties

createTime

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

CustomJob createTime.

displayName

public displayName: string;

CustomJob displayName.

encryptionSpec

public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);

CustomJob encryptionSpec.

endTime

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

CustomJob endTime.

error

public error?: (google.rpc.IStatus|null);

CustomJob error.

jobSpec

public jobSpec?: (google.cloud.aiplatform.v1.ICustomJobSpec|null);

CustomJob jobSpec.

labels

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

CustomJob labels.

name

public name: string;

CustomJob name.

startTime

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

CustomJob startTime.

state

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

CustomJob state.

updateTime

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

CustomJob updateTime.

webAccessUris

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

CustomJob webAccessUris.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.ICustomJob): google.cloud.aiplatform.v1.CustomJob;

Creates a new CustomJob instance using the specified properties.

Parameter

Name	Description
properties	`ICustomJob` Properties to set

Returns

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

decode(reader, length)

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

Decodes a CustomJob 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.CustomJob	CustomJob

decodeDelimited(reader)

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

Decodes a CustomJob 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.CustomJob	CustomJob

encode(message, writer)

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

Encodes the specified CustomJob message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`ICustomJob` CustomJob 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.CustomJob;

Creates a CustomJob 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.CustomJob	CustomJob

toJSON()

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

Converts this CustomJob to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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