Class protos.google.monitoring.v3.TypedValue

Represents a TypedValue.

Package

@google-cloud/monitoring

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.v3.ITypedValue);

Constructs a new TypedValue.

Parameter
NameDescription
properties ITypedValue

Properties to set

Properties

boolValue

public boolValue?: (boolean|null);

TypedValue boolValue.

distributionValue

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

TypedValue distributionValue.

doubleValue

public doubleValue?: (number|null);

TypedValue doubleValue.

int64Value

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

TypedValue int64Value.

stringValue

public stringValue?: (string|null);

TypedValue stringValue.

value

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

TypedValue value.

Methods

create(properties)

public static create(properties?: google.monitoring.v3.ITypedValue): google.monitoring.v3.TypedValue;

Creates a new TypedValue instance using the specified properties.

Parameter
NameDescription
properties ITypedValue

Properties to set

Returns
TypeDescription
google.monitoring.v3.TypedValue

TypedValue instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.TypedValue;

Decodes a TypedValue 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.monitoring.v3.TypedValue

TypedValue

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.TypedValue;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.monitoring.v3.TypedValue

TypedValue

encode(message, writer)

public static encode(message: google.monitoring.v3.ITypedValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TypedValue message. Does not implicitly messages.

Parameters
NameDescription
message ITypedValue

TypedValue 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.monitoring.v3.ITypedValue, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITypedValue

TypedValue 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.monitoring.v3.TypedValue;

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

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

Plain object

Returns
TypeDescription
google.monitoring.v3.TypedValue

TypedValue

toJSON()

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

Converts this TypedValue to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.monitoring.v3.TypedValue, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.monitoring.v3.TypedValue

TypedValue

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