Represents an AggregatedMetrics.
Package
@googlemaps/routeoptimizationConstructors
(constructor)(properties)
constructor(properties?: google.maps.routeoptimization.v1.IAggregatedMetrics);Constructs a new AggregatedMetrics.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAggregatedMetrics
Properties to set |
Properties
breakDuration
public breakDuration?: (google.protobuf.IDuration|null);AggregatedMetrics breakDuration.
delayDuration
public delayDuration?: (google.protobuf.IDuration|null);AggregatedMetrics delayDuration.
maxLoads
public maxLoads: { [k: string]: google.maps.routeoptimization.v1.ShipmentRoute.IVehicleLoad };AggregatedMetrics maxLoads.
performedShipmentCount
public performedShipmentCount: number;AggregatedMetrics performedShipmentCount.
totalDuration
public totalDuration?: (google.protobuf.IDuration|null);AggregatedMetrics totalDuration.
travelDistanceMeters
public travelDistanceMeters: number;AggregatedMetrics travelDistanceMeters.
travelDuration
public travelDuration?: (google.protobuf.IDuration|null);AggregatedMetrics travelDuration.
visitDuration
public visitDuration?: (google.protobuf.IDuration|null);AggregatedMetrics visitDuration.
waitDuration
public waitDuration?: (google.protobuf.IDuration|null);AggregatedMetrics waitDuration.
Methods
create(properties)
public static create(properties?: google.maps.routeoptimization.v1.IAggregatedMetrics): google.maps.routeoptimization.v1.AggregatedMetrics;Creates a new AggregatedMetrics instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAggregatedMetrics
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AggregatedMetrics |
AggregatedMetrics instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routeoptimization.v1.AggregatedMetrics;Decodes an AggregatedMetrics 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 |
AggregatedMetrics |
AggregatedMetrics |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routeoptimization.v1.AggregatedMetrics;Decodes an AggregatedMetrics message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AggregatedMetrics |
AggregatedMetrics |
encode(message, writer)
public static encode(message: google.maps.routeoptimization.v1.IAggregatedMetrics, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AggregatedMetrics message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAggregatedMetrics
AggregatedMetrics 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.maps.routeoptimization.v1.IAggregatedMetrics, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AggregatedMetrics message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAggregatedMetrics
AggregatedMetrics 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.maps.routeoptimization.v1.AggregatedMetrics;Creates an AggregatedMetrics 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 |
AggregatedMetrics |
AggregatedMetrics |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AggregatedMetrics
| 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 AggregatedMetrics to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.routeoptimization.v1.AggregatedMetrics, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AggregatedMetrics message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AggregatedMetrics
AggregatedMetrics |
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 AggregatedMetrics message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|