Represents a ListVehiclesRequest.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.IListVehiclesRequest);Constructs a new ListVehiclesRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IListVehiclesRequest
Properties to set |
Properties
filter
public filter: string;ListVehiclesRequest filter.
header
public header?: (maps.fleetengine.v1.IRequestHeader|null);ListVehiclesRequest header.
maximumStaleness
public maximumStaleness?: (google.protobuf.IDuration|null);ListVehiclesRequest maximumStaleness.
minimumCapacity
public minimumCapacity?: (google.protobuf.IInt32Value|null);ListVehiclesRequest minimumCapacity.
onTripOnly
public onTripOnly: boolean;ListVehiclesRequest onTripOnly.
pageSize
public pageSize: number;ListVehiclesRequest pageSize.
pageToken
public pageToken: string;ListVehiclesRequest pageToken.
parent
public parent: string;ListVehiclesRequest parent.
requiredAttributes
public requiredAttributes: string[];ListVehiclesRequest requiredAttributes.
requiredOneOfAttributes
public requiredOneOfAttributes: string[];ListVehiclesRequest requiredOneOfAttributes.
requiredOneOfAttributeSets
public requiredOneOfAttributeSets: string[];ListVehiclesRequest requiredOneOfAttributeSets.
tripTypes
public tripTypes: maps.fleetengine.v1.TripType[];ListVehiclesRequest tripTypes.
vehicleState
public vehicleState: (maps.fleetengine.v1.VehicleState|keyof typeof maps.fleetengine.v1.VehicleState);ListVehiclesRequest vehicleState.
vehicleTypeCategories
public vehicleTypeCategories: maps.fleetengine.v1.Vehicle.VehicleType.Category[];ListVehiclesRequest vehicleTypeCategories.
viewport
public viewport?: (google.geo.type.IViewport|null);ListVehiclesRequest viewport.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.IListVehiclesRequest): maps.fleetengine.v1.ListVehiclesRequest;Creates a new ListVehiclesRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IListVehiclesRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ListVehiclesRequest |
ListVehiclesRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.ListVehiclesRequest;Decodes a ListVehiclesRequest 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 |
ListVehiclesRequest |
ListVehiclesRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.ListVehiclesRequest;Decodes a ListVehiclesRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ListVehiclesRequest |
ListVehiclesRequest |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.IListVehiclesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ListVehiclesRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IListVehiclesRequest
ListVehiclesRequest 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.IListVehiclesRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ListVehiclesRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IListVehiclesRequest
ListVehiclesRequest 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.ListVehiclesRequest;Creates a ListVehiclesRequest 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 |
ListVehiclesRequest |
ListVehiclesRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ListVehiclesRequest
| 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 ListVehiclesRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.ListVehiclesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ListVehiclesRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ListVehiclesRequest
ListVehiclesRequest |
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 ListVehiclesRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|