Class protos.google.api.servicecontrol.v1.Distribution (2.3.0)

Represents a Distribution.

Package

Constructors

(constructor)(properties)

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

Constructs a new Distribution.

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

Properties

bucketCounts

public bucketCounts: (number|Long|string)[];

Distribution bucketCounts.

bucketOption

public bucketOption?: ("linearBuckets"|"exponentialBuckets"|"explicitBuckets");

Distribution bucketOption.

count

public count: (number|Long|string);

Distribution count.

exemplars

public exemplars: google.api.Distribution.IExemplar[];

Distribution exemplars.

explicitBuckets

public explicitBuckets?: (google.api.servicecontrol.v1.Distribution.IExplicitBuckets|null);

Distribution explicitBuckets.

exponentialBuckets

public exponentialBuckets?: (google.api.servicecontrol.v1.Distribution.IExponentialBuckets|null);

Distribution exponentialBuckets.

linearBuckets

public linearBuckets?: (google.api.servicecontrol.v1.Distribution.ILinearBuckets|null);

Distribution linearBuckets.

maximum

public maximum: number;

Distribution maximum.

mean

public mean: number;

Distribution mean.

minimum

public minimum: number;

Distribution minimum.

sumOfSquaredDeviation

public sumOfSquaredDeviation: number;

Distribution sumOfSquaredDeviation.

Methods

create(properties)

public static create(properties?: google.api.servicecontrol.v1.IDistribution): google.api.servicecontrol.v1.Distribution;

Creates a new Distribution instance using the specified properties.

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

Returns
Type	Description
`Distribution`	Distribution instance

decode(reader, length)

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

Decodes a Distribution 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
`Distribution`	Distribution

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Distribution`	Distribution

encode(message, writer)

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

Encodes the specified Distribution message. Does not implicitly messages.

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

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

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

Creates a Distribution 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
`Distribution`	Distribution

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Distribution

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`Distribution` Distribution
`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 Distribution 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