MetricUpdate

google.dataflow.v1beta3. MetricUpdate

Represents a MetricUpdate.

Constructor

new MetricUpdate(propertiesopt)

Constructs a new MetricUpdate.

Parameters:
Name Type Attributes Description
properties google.dataflow.v1beta3.IMetricUpdate <optional>

Properties to set

Implements:
  • IMetricUpdate

Members

cumulative

MetricUpdate cumulative.

distribution

MetricUpdate distribution.

gauge

MetricUpdate gauge.

internal

MetricUpdate internal.

kind

MetricUpdate kind.

meanCount

MetricUpdate meanCount.

meanSum

MetricUpdate meanSum.

name

MetricUpdate name.

scalar

MetricUpdate scalar.

set

MetricUpdate set.

updateTime

MetricUpdate updateTime.

Methods

toJSON() → {Object.<string, *>}

Converts this MetricUpdate to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.dataflow.v1beta3.MetricUpdate}

Creates a new MetricUpdate instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.dataflow.v1beta3.IMetricUpdate <optional>

Properties to set

Returns:
Type Description
google.dataflow.v1beta3.MetricUpdate

MetricUpdate instance

(static) decode(reader, lengthopt) → {google.dataflow.v1beta3.MetricUpdate}

Decodes a MetricUpdate message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.dataflow.v1beta3.MetricUpdate

MetricUpdate

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.dataflow.v1beta3.MetricUpdate}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.dataflow.v1beta3.MetricUpdate

MetricUpdate

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified MetricUpdate message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.IMetricUpdate

MetricUpdate message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.IMetricUpdate

MetricUpdate message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.dataflow.v1beta3.MetricUpdate}

Creates a MetricUpdate message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.dataflow.v1beta3.MetricUpdate

MetricUpdate

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for MetricUpdate

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.MetricUpdate

MetricUpdate

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a MetricUpdate message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not