Class protos.google.cloud.migrationcenter.v1.AggregationResult (2.1.0)
Stay organized with collections Save and categorize content based on your preferences.

Represents an AggregationResult.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.migrationcenter.v1.IAggregationResult);

Constructs a new AggregationResult.

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

Properties

count

public count?: (google.cloud.migrationcenter.v1.AggregationResult.ICount|null);

AggregationResult count.

field

public field: string;

AggregationResult field.

frequency

public frequency?: (google.cloud.migrationcenter.v1.AggregationResult.IFrequency|null);

AggregationResult frequency.

histogram

public histogram?: (google.cloud.migrationcenter.v1.AggregationResult.IHistogram|null);

AggregationResult histogram.

result

public result?: ("count"|"sum"|"histogram"|"frequency");

AggregationResult result.

sum

public sum?: (google.cloud.migrationcenter.v1.AggregationResult.ISum|null);

AggregationResult sum.

Methods

create(properties)

public static create(properties?: google.cloud.migrationcenter.v1.IAggregationResult): google.cloud.migrationcenter.v1.AggregationResult;

Creates a new AggregationResult instance using the specified properties.

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

Returns
Type	Description
`AggregationResult`	AggregationResult instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.migrationcenter.v1.AggregationResult;

Decodes an AggregationResult 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
`AggregationResult`	AggregationResult

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.migrationcenter.v1.AggregationResult;

Decodes an AggregationResult message from the specified reader or buffer, length delimited.

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

Returns
Type	Description
`AggregationResult`	AggregationResult

encode(message, writer)

public static encode(message: google.cloud.migrationcenter.v1.IAggregationResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AggregationResult message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IAggregationResult` AggregationResult 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.migrationcenter.v1.IAggregationResult, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IAggregationResult` AggregationResult 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.migrationcenter.v1.AggregationResult;

Creates an AggregationResult 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
`AggregationResult`	AggregationResult

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AggregationResult

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

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

toObject(message, options)

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

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

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

Class protos.google.cloud.migrationcenter.v1.AggregationResult (2.1.0) Stay organized with collections Save and categorize content based on your preferences.