Class protos.maps.fleetengine.delivery.v1.VehicleJourneySegment (0.1.0)

Represents a VehicleJourneySegment.

Package

@googlemaps/fleetengine-delivery

Constructors

(constructor)(properties)

constructor(properties?: maps.fleetengine.delivery.v1.IVehicleJourneySegment);

Constructs a new VehicleJourneySegment.

Parameter
Name Description
properties IVehicleJourneySegment

Properties to set

Properties

drivingDistanceMeters

public drivingDistanceMeters?: (google.protobuf.IInt32Value|null);

VehicleJourneySegment drivingDistanceMeters.

drivingDuration

public drivingDuration?: (google.protobuf.IDuration|null);

VehicleJourneySegment drivingDuration.

path

public path: google.type.ILatLng[];

VehicleJourneySegment path.

stop

public stop?: (maps.fleetengine.delivery.v1.IVehicleStop|null);

VehicleJourneySegment stop.

Methods

create(properties)

public static create(properties?: maps.fleetengine.delivery.v1.IVehicleJourneySegment): maps.fleetengine.delivery.v1.VehicleJourneySegment;

Creates a new VehicleJourneySegment instance using the specified properties.

Parameter
Name Description
properties IVehicleJourneySegment

Properties to set

Returns
Type Description
VehicleJourneySegment

VehicleJourneySegment instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.delivery.v1.VehicleJourneySegment;

Decodes a VehicleJourneySegment 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
VehicleJourneySegment

VehicleJourneySegment

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.delivery.v1.VehicleJourneySegment;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
VehicleJourneySegment

VehicleJourneySegment

encode(message, writer)

public static encode(message: maps.fleetengine.delivery.v1.IVehicleJourneySegment, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VehicleJourneySegment message. Does not implicitly messages.

Parameters
Name Description
message IVehicleJourneySegment

VehicleJourneySegment 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.delivery.v1.IVehicleJourneySegment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IVehicleJourneySegment

VehicleJourneySegment 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.delivery.v1.VehicleJourneySegment;

Creates a VehicleJourneySegment 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
VehicleJourneySegment

VehicleJourneySegment

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for VehicleJourneySegment

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 VehicleJourneySegment to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: maps.fleetengine.delivery.v1.VehicleJourneySegment, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message VehicleJourneySegment

VehicleJourneySegment

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 VehicleJourneySegment message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not