Class protos.google.cloud.aiplatform.v1.TrialContext (3.6.0)

Represents a TrialContext.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new TrialContext.

Parameter
NameDescription
properties ITrialContext

Properties to set

Properties

description

public description: string;

TrialContext description.

parameters

public parameters: google.cloud.aiplatform.v1.Trial.IParameter[];

TrialContext parameters.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.ITrialContext): google.cloud.aiplatform.v1.TrialContext;

Creates a new TrialContext instance using the specified properties.

Parameter
NameDescription
properties ITrialContext

Properties to set

Returns
TypeDescription
TrialContext

TrialContext instance

decode(reader, length)

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

Decodes a TrialContext 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
TrialContext

TrialContext

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
TrialContext

TrialContext

encode(message, writer)

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

Encodes the specified TrialContext message. Does not implicitly messages.

Parameters
NameDescription
message ITrialContext

TrialContext 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.ITrialContext, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITrialContext

TrialContext 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.TrialContext;

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

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

Plain object

Returns
TypeDescription
TrialContext

TrialContext

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TrialContext

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message TrialContext

TrialContext

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