Class protos.google.api.servicecontrol.v1.MetricValue (1.3.0)

Represents a MetricValue.

Package

@google-cloud/service-control

Constructors

(constructor)(properties)

constructor(properties?: google.api.servicecontrol.v1.IMetricValue);

Constructs a new MetricValue.

Parameter
Name Description
properties IMetricValue

Properties to set

Properties

boolValue

public boolValue?: (boolean|null);

MetricValue boolValue.

distributionValue

public distributionValue?: (google.api.servicecontrol.v1.IDistribution|null);

MetricValue distributionValue.

doubleValue

public doubleValue?: (number|null);

MetricValue doubleValue.

endTime

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

MetricValue endTime.

int64Value

public int64Value?: (number|Long|string|null);

MetricValue int64Value.

labels

public labels: { [k: string]: string };

MetricValue labels.

startTime

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

MetricValue startTime.

stringValue

public stringValue?: (string|null);

MetricValue stringValue.

value

public value?: ("boolValue"|"int64Value"|"doubleValue"|"stringValue"|"distributionValue");

MetricValue value.

Methods

create(properties)

public static create(properties?: google.api.servicecontrol.v1.IMetricValue): google.api.servicecontrol.v1.MetricValue;

Creates a new MetricValue instance using the specified properties.

Parameter
Name Description
properties IMetricValue

Properties to set
Returns
Type Description
google.api.servicecontrol.v1.MetricValue

MetricValue instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.servicecontrol.v1.MetricValue;

Decodes a MetricValue 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.api.servicecontrol.v1.MetricValue

MetricValue

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.servicecontrol.v1.MetricValue;

Decodes a MetricValue 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.api.servicecontrol.v1.MetricValue

MetricValue

encode(message, writer)

public static encode(message: google.api.servicecontrol.v1.IMetricValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MetricValue message. Does not implicitly messages.

Parameters
Name Description
message IMetricValue

MetricValue 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.api.servicecontrol.v1.IMetricValue, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IMetricValue

MetricValue 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.api.servicecontrol.v1.MetricValue;

Creates a MetricValue 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.api.servicecontrol.v1.MetricValue

MetricValue

toJSON()

public toJSON(): { [k: string]: any };

Converts this MetricValue to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.api.servicecontrol.v1.MetricValue

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