Class protos.google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric (3.2.1)

Represents a Metric.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3beta1.Experiment.Result.IMetric);

Constructs a new Metric.

Parameter

Name	Description
`properties`	`IMetric` Properties to set

Properties

confidenceInterval

public confidenceInterval?: (google.cloud.dialogflow.cx.v3beta1.Experiment.Result.IConfidenceInterval|null);

Metric confidenceInterval.

count

public count?: (number|null);

Metric count.

countType

public countType: (google.cloud.dialogflow.cx.v3beta1.Experiment.Result.CountType|keyof typeof google.cloud.dialogflow.cx.v3beta1.Experiment.Result.CountType);

Metric countType.

ratio

public ratio?: (number|null);

Metric ratio.

type

public type: (google.cloud.dialogflow.cx.v3beta1.Experiment.Result.MetricType|keyof typeof google.cloud.dialogflow.cx.v3beta1.Experiment.Result.MetricType);

Metric type.

value

public value?: ("ratio"|"count");

Metric value.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.Experiment.Result.IMetric): google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric;

Creates a new Metric instance using the specified properties.

Parameter

Name	Description
`properties`	`IMetric` Properties to set

Returns

Type	Description
`google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric`	Metric instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric;

Decodes a Metric 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.dialogflow.cx.v3beta1.Experiment.Result.Metric`	Metric

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric;

Decodes a Metric 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.dialogflow.cx.v3beta1.Experiment.Result.Metric`	Metric

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3beta1.Experiment.Result.IMetric, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Metric message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IMetric` Metric 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.dialogflow.cx.v3beta1.Experiment.Result.IMetric, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IMetric` Metric 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.dialogflow.cx.v3beta1.Experiment.Result.Metric;

Creates a Metric 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.dialogflow.cx.v3beta1.Experiment.Result.Metric`	Metric

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Metric

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

Returns

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

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
`message`	`google.cloud.dialogflow.cx.v3beta1.Experiment.Result.Metric` Metric
`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 Metric 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