Class protos.google.cloud.aiplatform.v1.NasJob (3.13.0)

Represents a NasJob.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new NasJob.

Parameter
NameDescription
properties INasJob

Properties to set

Properties

createTime

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

NasJob createTime.

displayName

public displayName: string;

NasJob displayName.

enableRestrictedImageTraining

public enableRestrictedImageTraining: boolean;

NasJob enableRestrictedImageTraining.

encryptionSpec

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

NasJob encryptionSpec.

endTime

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

NasJob endTime.

error

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

NasJob error.

labels

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

NasJob labels.

name

public name: string;

NasJob name.

nasJobOutput

public nasJobOutput?: (google.cloud.aiplatform.v1.INasJobOutput|null);

NasJob nasJobOutput.

nasJobSpec

public nasJobSpec?: (google.cloud.aiplatform.v1.INasJobSpec|null);

NasJob nasJobSpec.

startTime

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

NasJob startTime.

state

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

NasJob state.

updateTime

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

NasJob updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.INasJob): google.cloud.aiplatform.v1.NasJob;

Creates a new NasJob instance using the specified properties.

Parameter
NameDescription
properties INasJob

Properties to set

Returns
TypeDescription
NasJob

NasJob instance

decode(reader, length)

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

Decodes a NasJob message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
NasJob

NasJob

decodeDelimited(reader)

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

Decodes a NasJob message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
NasJob

NasJob

encode(message, writer)

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

Encodes the specified NasJob message. Does not implicitly messages.

Parameters
NameDescription
message INasJob

NasJob 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.aiplatform.v1.INasJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message INasJob

NasJob 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.aiplatform.v1.NasJob;

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

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

Plain object

Returns
TypeDescription
NasJob

NasJob

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for NasJob

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this NasJob to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message NasJob

NasJob

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a NasJob 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