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

Represents a ParameterSpec.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new ParameterSpec.

Parameter
NameDescription
properties IParameterSpec

Properties to set

Properties

categoricalValueSpec

public categoricalValueSpec?: (google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ICategoricalValueSpec|null);

ParameterSpec categoricalValueSpec.

conditionalParameterSpecs

public conditionalParameterSpecs: google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IConditionalParameterSpec[];

ParameterSpec conditionalParameterSpecs.

discreteValueSpec

public discreteValueSpec?: (google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IDiscreteValueSpec|null);

ParameterSpec discreteValueSpec.

doubleValueSpec

public doubleValueSpec?: (google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IDoubleValueSpec|null);

ParameterSpec doubleValueSpec.

integerValueSpec

public integerValueSpec?: (google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IIntegerValueSpec|null);

ParameterSpec integerValueSpec.

parameterId

public parameterId: string;

ParameterSpec parameterId.

parameterValueSpec

public parameterValueSpec?: ("doubleValueSpec"|"integerValueSpec"|"categoricalValueSpec"|"discreteValueSpec");

ParameterSpec parameterValueSpec.

scaleType

public scaleType: (google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType|keyof typeof google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType);

ParameterSpec scaleType.

Methods

create(properties)

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

Creates a new ParameterSpec instance using the specified properties.

Parameter
NameDescription
properties IParameterSpec

Properties to set

Returns
TypeDescription
google.cloud.aiplatform.v1.StudySpec.ParameterSpec

ParameterSpec instance

decode(reader, length)

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

Decodes a ParameterSpec message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.aiplatform.v1.StudySpec.ParameterSpec

ParameterSpec

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.aiplatform.v1.StudySpec.ParameterSpec

ParameterSpec

encode(message, writer)

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

Encodes the specified ParameterSpec message. Does not implicitly messages.

Parameters
NameDescription
message IParameterSpec

ParameterSpec 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.StudySpec.IParameterSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IParameterSpec

ParameterSpec 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.StudySpec.ParameterSpec;

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

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

Plain object

Returns
TypeDescription
google.cloud.aiplatform.v1.StudySpec.ParameterSpec

ParameterSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ParameterSpec

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.aiplatform.v1.StudySpec.ParameterSpec

ParameterSpec

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 ParameterSpec 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