Class protos.google.cloud.aiplatform.v1.StudySpec (2.5.0)

Represents a StudySpec.

Package

Constructors

(constructor)(properties)

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

Constructs a new StudySpec.

Parameter

Name	Description
`properties`	`IStudySpec` Properties to set

Properties

algorithm

public algorithm: (google.cloud.aiplatform.v1.StudySpec.Algorithm|keyof typeof google.cloud.aiplatform.v1.StudySpec.Algorithm);

StudySpec algorithm.

automatedStoppingSpec

public automatedStoppingSpec?: ("decayCurveStoppingSpec"|"medianAutomatedStoppingSpec"|"convexAutomatedStoppingSpec");

StudySpec automatedStoppingSpec.

convexAutomatedStoppingSpec

public convexAutomatedStoppingSpec?: (google.cloud.aiplatform.v1.StudySpec.IConvexAutomatedStoppingSpec|null);

StudySpec convexAutomatedStoppingSpec.

decayCurveStoppingSpec

public decayCurveStoppingSpec?: (google.cloud.aiplatform.v1.StudySpec.IDecayCurveAutomatedStoppingSpec|null);

StudySpec decayCurveStoppingSpec.

measurementSelectionType

public measurementSelectionType: (google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType|keyof typeof google.cloud.aiplatform.v1.StudySpec.MeasurementSelectionType);

StudySpec measurementSelectionType.

medianAutomatedStoppingSpec

public medianAutomatedStoppingSpec?: (google.cloud.aiplatform.v1.StudySpec.IMedianAutomatedStoppingSpec|null);

StudySpec medianAutomatedStoppingSpec.

metrics

public metrics: google.cloud.aiplatform.v1.StudySpec.IMetricSpec[];

StudySpec metrics.

observationNoise

public observationNoise: (google.cloud.aiplatform.v1.StudySpec.ObservationNoise|keyof typeof google.cloud.aiplatform.v1.StudySpec.ObservationNoise);

StudySpec observationNoise.

parameters

public parameters: google.cloud.aiplatform.v1.StudySpec.IParameterSpec[];

StudySpec parameters.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IStudySpec): google.cloud.aiplatform.v1.StudySpec;

Creates a new StudySpec instance using the specified properties.

Parameter

Name	Description
`properties`	`IStudySpec` Properties to set

Returns

Type	Description
`google.cloud.aiplatform.v1.StudySpec`	StudySpec instance

decode(reader, length)

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

Decodes a StudySpec 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.StudySpec`	StudySpec

decodeDelimited(reader)

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

Decodes a StudySpec 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.StudySpec`	StudySpec

encode(message, writer)

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

Encodes the specified StudySpec message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
`message`	`IStudySpec` StudySpec 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.StudySpec;

Creates a StudySpec 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.StudySpec`	StudySpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for StudySpec

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

Returns

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

toObject(message, options)

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

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

Parameters

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