Class protos.google.api.Distribution.Exemplar (0.2.0)

Represents an Exemplar.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.api.Distribution.IExemplar);

Constructs a new Exemplar.

Parameter
Name	Description
`properties`	`IExemplar` Properties to set

Properties

attachments

public attachments: google.protobuf.IAny[];

Exemplar attachments.

timestamp

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

Exemplar timestamp.

value

public value: number;

Exemplar value.

Methods

create(properties)

public static create(properties?: google.api.Distribution.IExemplar): google.api.Distribution.Exemplar;

Creates a new Exemplar instance using the specified properties.

Parameter
Name	Description
`properties`	`IExemplar` Properties to set

Returns
Type	Description
`google.api.Distribution.Exemplar`	Exemplar instance

decode(reader, length)

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

Decodes an Exemplar 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.Distribution.Exemplar`	Exemplar

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.Distribution.Exemplar;

Decodes an Exemplar 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.Distribution.Exemplar`	Exemplar

encode(message, writer)

public static encode(message: google.api.Distribution.IExemplar, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Exemplar message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IExemplar` Exemplar 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.Distribution.IExemplar, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IExemplar` Exemplar 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.Distribution.Exemplar;

Creates an Exemplar 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.Distribution.Exemplar`	Exemplar

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Exemplar

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.api.Distribution.Exemplar` Exemplar
`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 Exemplar 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