Class protos.google.cloud.aiplatform.v1beta1.OnlineEvaluator (6.8.1)

Represents an OnlineEvaluator.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new OnlineEvaluator.

Parameter
Name Description
properties IOnlineEvaluator

Properties to set

Properties

agentResource

public agentResource: string;

OnlineEvaluator agentResource.

cloudObservability

public cloudObservability?: (google.cloud.aiplatform.v1beta1.OnlineEvaluator.ICloudObservability|null);

OnlineEvaluator cloudObservability.

config

public config?: (google.cloud.aiplatform.v1beta1.OnlineEvaluator.IConfig|null);

OnlineEvaluator config.

createTime

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

OnlineEvaluator createTime.

dataSource

public dataSource?: "cloudObservability";

OnlineEvaluator dataSource.

displayName

public displayName: string;

OnlineEvaluator displayName.

metricSources

public metricSources: google.cloud.aiplatform.v1beta1.IMetricSource[];

OnlineEvaluator metricSources.

name

public name: string;

OnlineEvaluator name.

state

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

OnlineEvaluator state.

stateDetails

public stateDetails: google.cloud.aiplatform.v1beta1.OnlineEvaluator.IStateDetails[];

OnlineEvaluator stateDetails.

updateTime

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

OnlineEvaluator updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.IOnlineEvaluator): google.cloud.aiplatform.v1beta1.OnlineEvaluator;

Creates a new OnlineEvaluator instance using the specified properties.

Parameter
Name Description
properties IOnlineEvaluator

Properties to set

Returns
Type Description
OnlineEvaluator

OnlineEvaluator instance

decode(reader, length)

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

Decodes an OnlineEvaluator 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
OnlineEvaluator

OnlineEvaluator

decodeDelimited(reader)

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

Decodes an OnlineEvaluator message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
OnlineEvaluator

OnlineEvaluator

encode(message, writer)

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

Encodes the specified OnlineEvaluator message. Does not implicitly messages.

Parameters
Name Description
message IOnlineEvaluator

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

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

Parameters
Name Description
message IOnlineEvaluator

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

Creates an OnlineEvaluator 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
OnlineEvaluator

OnlineEvaluator

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OnlineEvaluator

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message OnlineEvaluator

OnlineEvaluator

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 an OnlineEvaluator 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