Represents an Aggregation.
Package
@google-cloud/monitoring-dashboards!Constructors
(constructor)(properties)
constructor(properties?: google.monitoring.dashboard.v1.IAggregation);Constructs a new Aggregation.
| Type | Name | Description |
|---|---|---|
| IAggregation | properties |
Properties to set |
Properties
alignmentPeriod
public alignmentPeriod?: (google.protobuf.IDuration|null);Aggregation alignmentPeriod.
| Type | Description |
|---|---|
| (google.protobuf.IDuration|null) |
crossSeriesReducer
public crossSeriesReducer: (google.monitoring.dashboard.v1.Aggregation.Reducer|keyof typeof google.monitoring.dashboard.v1.Aggregation.Reducer);Aggregation crossSeriesReducer.
| Type | Description |
|---|---|
| (google.monitoring.dashboard.v1.Aggregation.Reducer|keyof typeof google.monitoring.dashboard.v1.Aggregation.Reducer) |
groupByFields
public groupByFields: string[];Aggregation groupByFields.
| Type | Description |
|---|---|
| string[] |
perSeriesAligner
public perSeriesAligner: (google.monitoring.dashboard.v1.Aggregation.Aligner|keyof typeof google.monitoring.dashboard.v1.Aggregation.Aligner);Aggregation perSeriesAligner.
| Type | Description |
|---|---|
| (google.monitoring.dashboard.v1.Aggregation.Aligner|keyof typeof google.monitoring.dashboard.v1.Aggregation.Aligner) |
Methods
create(properties)
public static create(properties?: google.monitoring.dashboard.v1.IAggregation): google.monitoring.dashboard.v1.Aggregation;Creates a new Aggregation instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| IAggregation | properties |
Properties to set |
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Aggregation | Aggregation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.Aggregation;Decodes an Aggregation message from the specified reader or buffer.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Aggregation | Aggregation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.Aggregation;Decodes an Aggregation message from the specified reader or buffer, length delimited.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Aggregation | Aggregation |
encode(message, writer)
public static encode(message: google.monitoring.dashboard.v1.IAggregation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Aggregation message. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IAggregation | message |
Aggregation message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.monitoring.dashboard.v1.IAggregation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Aggregation message, length delimited. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IAggregation | message |
Aggregation message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.Aggregation;Creates an Aggregation message from a plain object. Also converts values to their respective internal types.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.monitoring.dashboard.v1.Aggregation | Aggregation |
toJSON()
public toJSON(): { [k: string]: any };Converts this Aggregation to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.dashboard.v1.Aggregation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Aggregation message. Also converts values to other types if specified.
| Type | Name | Description |
|---|---|---|
| google.monitoring.dashboard.v1.Aggregation | message |
Aggregation |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Aggregation message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|