Represents a SearchVehiclesRequest.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.ISearchVehiclesRequest);Constructs a new SearchVehiclesRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISearchVehiclesRequest
Properties to set |
Properties
count
public count: number;SearchVehiclesRequest count.
currentTripsPresent
public currentTripsPresent: (maps.fleetengine.v1.SearchVehiclesRequest.CurrentTripsPresent|keyof typeof maps.fleetengine.v1.SearchVehiclesRequest.CurrentTripsPresent);SearchVehiclesRequest currentTripsPresent.
dropoffPoint
public dropoffPoint?: (maps.fleetengine.v1.ITerminalLocation|null);SearchVehiclesRequest dropoffPoint.
filter
public filter: string;SearchVehiclesRequest filter.
header
public header?: (maps.fleetengine.v1.IRequestHeader|null);SearchVehiclesRequest header.
includeBackToBack
public includeBackToBack: boolean;SearchVehiclesRequest includeBackToBack.
maximumStaleness
public maximumStaleness?: (google.protobuf.IDuration|null);SearchVehiclesRequest maximumStaleness.
minimumCapacity
public minimumCapacity: number;SearchVehiclesRequest minimumCapacity.
orderBy
public orderBy: (maps.fleetengine.v1.SearchVehiclesRequest.VehicleMatchOrder|keyof typeof maps.fleetengine.v1.SearchVehiclesRequest.VehicleMatchOrder);SearchVehiclesRequest orderBy.
parent
public parent: string;SearchVehiclesRequest parent.
pickupPoint
public pickupPoint?: (maps.fleetengine.v1.ITerminalLocation|null);SearchVehiclesRequest pickupPoint.
pickupRadiusMeters
public pickupRadiusMeters: number;SearchVehiclesRequest pickupRadiusMeters.
requiredAttributes
public requiredAttributes: maps.fleetengine.v1.IVehicleAttribute[];SearchVehiclesRequest requiredAttributes.
requiredOneOfAttributes
public requiredOneOfAttributes: maps.fleetengine.v1.IVehicleAttributeList[];SearchVehiclesRequest requiredOneOfAttributes.
requiredOneOfAttributeSets
public requiredOneOfAttributeSets: maps.fleetengine.v1.IVehicleAttributeList[];SearchVehiclesRequest requiredOneOfAttributeSets.
tripId
public tripId: string;SearchVehiclesRequest tripId.
tripTypes
public tripTypes: maps.fleetengine.v1.TripType[];SearchVehiclesRequest tripTypes.
vehicleTypes
public vehicleTypes: maps.fleetengine.v1.Vehicle.IVehicleType[];SearchVehiclesRequest vehicleTypes.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.ISearchVehiclesRequest): maps.fleetengine.v1.SearchVehiclesRequest;Creates a new SearchVehiclesRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISearchVehiclesRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
SearchVehiclesRequest |
SearchVehiclesRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.SearchVehiclesRequest;Decodes a SearchVehiclesRequest 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 |
SearchVehiclesRequest |
SearchVehiclesRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.SearchVehiclesRequest;Decodes a SearchVehiclesRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
SearchVehiclesRequest |
SearchVehiclesRequest |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.ISearchVehiclesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SearchVehiclesRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISearchVehiclesRequest
SearchVehiclesRequest 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.ISearchVehiclesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SearchVehiclesRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISearchVehiclesRequest
SearchVehiclesRequest 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.SearchVehiclesRequest;Creates a SearchVehiclesRequest 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 |
SearchVehiclesRequest |
SearchVehiclesRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SearchVehiclesRequest
| 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 SearchVehiclesRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.SearchVehiclesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SearchVehiclesRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
SearchVehiclesRequest
SearchVehiclesRequest |
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 SearchVehiclesRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|