Represents a TripWaypoint.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.ITripWaypoint);Constructs a new TripWaypoint.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITripWaypoint
Properties to set |
Properties
distanceMeters
public distanceMeters?: (google.protobuf.IInt32Value|null);TripWaypoint distanceMeters.
duration
public duration?: (google.protobuf.IDuration|null);TripWaypoint duration.
encodedPathToWaypoint
public encodedPathToWaypoint: string;TripWaypoint encodedPathToWaypoint.
eta
public eta?: (google.protobuf.ITimestamp|null);TripWaypoint eta.
location
public location?: (maps.fleetengine.v1.ITerminalLocation|null);TripWaypoint location.
pathToWaypoint
public pathToWaypoint: google.type.ILatLng[];TripWaypoint pathToWaypoint.
trafficToWaypoint
public trafficToWaypoint?: (maps.fleetengine.v1.IConsumableTrafficPolyline|null);TripWaypoint trafficToWaypoint.
tripId
public tripId: string;TripWaypoint tripId.
waypointType
public waypointType: (maps.fleetengine.v1.WaypointType|keyof typeof maps.fleetengine.v1.WaypointType);TripWaypoint waypointType.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.ITripWaypoint): maps.fleetengine.v1.TripWaypoint;Creates a new TripWaypoint instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITripWaypoint
Properties to set |
| Returns | |
|---|---|
| Type | Description |
TripWaypoint |
TripWaypoint instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.TripWaypoint;Decodes a TripWaypoint 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 |
TripWaypoint |
TripWaypoint |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.TripWaypoint;Decodes a TripWaypoint message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
TripWaypoint |
TripWaypoint |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.ITripWaypoint, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TripWaypoint message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITripWaypoint
TripWaypoint 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: maps.fleetengine.v1.ITripWaypoint, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TripWaypoint message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITripWaypoint
TripWaypoint 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 }): maps.fleetengine.v1.TripWaypoint;Creates a TripWaypoint 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 |
TripWaypoint |
TripWaypoint |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TripWaypoint
| 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 TripWaypoint to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.TripWaypoint, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a TripWaypoint message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
TripWaypoint
TripWaypoint |
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 TripWaypoint message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|