AggregatedMetrics

google.cloud.optimization.v1. AggregatedMetrics

Represents an AggregatedMetrics.

Constructor

new AggregatedMetrics(propertiesopt)

Constructs a new AggregatedMetrics.

Parameters:
Name Type Attributes Description
properties google.cloud.optimization.v1.IAggregatedMetrics <optional>

Properties to set

Implements:
  • IAggregatedMetrics

Members

breakDuration

AggregatedMetrics breakDuration.

costs

AggregatedMetrics costs.

delayDuration

AggregatedMetrics delayDuration.

maxLoads

AggregatedMetrics maxLoads.

performedShipmentCount

AggregatedMetrics performedShipmentCount.

totalCost

AggregatedMetrics totalCost.

totalDuration

AggregatedMetrics totalDuration.

travelDistanceMeters

AggregatedMetrics travelDistanceMeters.

travelDuration

AggregatedMetrics travelDuration.

visitDuration

AggregatedMetrics visitDuration.

waitDuration

AggregatedMetrics waitDuration.

Methods

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

Converts this AggregatedMetrics to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.optimization.v1.AggregatedMetrics}

Creates a new AggregatedMetrics instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.optimization.v1.IAggregatedMetrics <optional>

Properties to set

Returns:
Type Description
google.cloud.optimization.v1.AggregatedMetrics

AggregatedMetrics instance

(static) decode(reader, lengthopt) → {google.cloud.optimization.v1.AggregatedMetrics}

Decodes an AggregatedMetrics 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.cloud.optimization.v1.AggregatedMetrics

AggregatedMetrics

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.cloud.optimization.v1.AggregatedMetrics}

Decodes an AggregatedMetrics 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.cloud.optimization.v1.AggregatedMetrics

AggregatedMetrics

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 AggregatedMetrics message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.optimization.v1.IAggregatedMetrics

AggregatedMetrics 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 AggregatedMetrics message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.optimization.v1.IAggregatedMetrics

AggregatedMetrics message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.optimization.v1.AggregatedMetrics}

Creates an AggregatedMetrics 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.cloud.optimization.v1.AggregatedMetrics

AggregatedMetrics

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AggregatedMetrics

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 an AggregatedMetrics message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.optimization.v1.AggregatedMetrics

AggregatedMetrics

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an AggregatedMetrics 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