Class protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob (3.4.0)

Represents a HyperparameterTuningJob.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob);

Constructs a new HyperparameterTuningJob.

Parameter
Name	Description
`properties`	`IHyperparameterTuningJob` Properties to set

Properties

createTime

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

HyperparameterTuningJob createTime.

displayName

public displayName: string;

HyperparameterTuningJob displayName.

encryptionSpec

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

HyperparameterTuningJob encryptionSpec.

endTime

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

HyperparameterTuningJob endTime.

error

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

HyperparameterTuningJob error.

labels

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

HyperparameterTuningJob labels.

maxFailedTrialCount

public maxFailedTrialCount: number;

HyperparameterTuningJob maxFailedTrialCount.

maxTrialCount

public maxTrialCount: number;

HyperparameterTuningJob maxTrialCount.

name

public name: string;

HyperparameterTuningJob name.

parallelTrialCount

public parallelTrialCount: number;

HyperparameterTuningJob parallelTrialCount.

startTime

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

HyperparameterTuningJob startTime.

state

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

HyperparameterTuningJob state.

studySpec

public studySpec?: (google.cloud.aiplatform.v1beta1.IStudySpec|null);

HyperparameterTuningJob studySpec.

trialJobSpec

public trialJobSpec?: (google.cloud.aiplatform.v1beta1.ICustomJobSpec|null);

HyperparameterTuningJob trialJobSpec.

trials

public trials: google.cloud.aiplatform.v1beta1.ITrial[];

HyperparameterTuningJob trials.

updateTime

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

HyperparameterTuningJob updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.IHyperparameterTuningJob): google.cloud.aiplatform.v1beta1.HyperparameterTuningJob;

Creates a new HyperparameterTuningJob instance using the specified properties.

Parameter
Name	Description
`properties`	`IHyperparameterTuningJob` Properties to set

Returns
Type	Description
`HyperparameterTuningJob`	HyperparameterTuningJob instance

decode(reader, length)

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

Decodes a HyperparameterTuningJob 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
`HyperparameterTuningJob`	HyperparameterTuningJob

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`HyperparameterTuningJob`	HyperparameterTuningJob

encode(message, writer)

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

Encodes the specified HyperparameterTuningJob message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`IHyperparameterTuningJob` HyperparameterTuningJob 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.HyperparameterTuningJob;

Creates a HyperparameterTuningJob 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
`HyperparameterTuningJob`	HyperparameterTuningJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HyperparameterTuningJob

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 HyperparameterTuningJob to JSON.

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`HyperparameterTuningJob` HyperparameterTuningJob
`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 HyperparameterTuningJob 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