Represents a MetricUpdate.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IMetricUpdate);Constructs a new MetricUpdate.
| Parameter | |
|---|---|
| Name | Description |
properties |
IMetricUpdate
Properties to set |
Properties
cumulative
public cumulative: boolean;MetricUpdate cumulative.
distribution
public distribution?: (google.protobuf.IValue|null);MetricUpdate distribution.
gauge
public gauge?: (google.protobuf.IValue|null);MetricUpdate gauge.
internal
public internal?: (google.protobuf.IValue|null);MetricUpdate internal.
kind
public kind: string;MetricUpdate kind.
meanCount
public meanCount?: (google.protobuf.IValue|null);MetricUpdate meanCount.
meanSum
public meanSum?: (google.protobuf.IValue|null);MetricUpdate meanSum.
name
public name?: (google.dataflow.v1beta3.IMetricStructuredName|null);MetricUpdate name.
scalar
public scalar?: (google.protobuf.IValue|null);MetricUpdate scalar.
set
public set?: (google.protobuf.IValue|null);MetricUpdate set.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);MetricUpdate updateTime.
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.IMetricUpdate): google.dataflow.v1beta3.MetricUpdate;Creates a new MetricUpdate instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IMetricUpdate
Properties to set |
| Returns | |
|---|---|
| Type | Description |
MetricUpdate | MetricUpdate instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.MetricUpdate;Decodes a MetricUpdate 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 |
MetricUpdate | MetricUpdate |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.MetricUpdate;Decodes a MetricUpdate message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
MetricUpdate | MetricUpdate |
encode(message, writer)
public static encode(message: google.dataflow.v1beta3.IMetricUpdate, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified MetricUpdate message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IMetricUpdate
MetricUpdate 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.dataflow.v1beta3.IMetricUpdate, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified MetricUpdate message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IMetricUpdate
MetricUpdate 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.dataflow.v1beta3.MetricUpdate;Creates a MetricUpdate 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 |
MetricUpdate | MetricUpdate |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for MetricUpdate
| 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 MetricUpdate to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.dataflow.v1beta3.MetricUpdate, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a MetricUpdate message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
MetricUpdate
MetricUpdate |
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 MetricUpdate message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|