Class ListVehiclesRequest
ListVehicles request message.
Implements
Namespace: Google.Maps.FleetEngine.V1
Assembly: Google.Maps.FleetEngine.V1.dll
Syntax
public sealed class ListVehiclesRequest : IMessage<ListVehiclesRequest>, IEquatable<ListVehiclesRequest>, IDeepCloneable<ListVehiclesRequest>, IBufferMessage, IMessage, IPageRequest
Constructors
ListVehiclesRequest()
Declaration
public ListVehiclesRequest()
ListVehiclesRequest(ListVehiclesRequest)
Declaration
public ListVehiclesRequest(ListVehiclesRequest other)
Parameters
| Type | Name | Description |
|---|---|---|
| ListVehiclesRequest | other |
Properties
Filter
Optional. A filter query to apply when listing vehicles. See http://aip.dev/160 for examples of the filter syntax.
This field is designed to replace the required_attributes,
required_one_of_attributes, and required_one_of_attributes_sets fields.
If a non-empty value is specified here, the following fields must be empty:
required_attributes, required_one_of_attributes, and
required_one_of_attributes_sets.
This filter functions as an AND clause with other constraints,
such as vehicle_state or on_trip_only.
Note that the only queries supported are on vehicle attributes (for
example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). The maximum number of restrictions allowed
in a filter query is 50.
Also, all attributes are stored as strings, so the only supported
comparisons against attributes are string comparisons. In order to compare
against number or boolean values, the values must be explicitly quoted to
be treated as strings (for example, attributes.<key> = "10" or
attributes.<key> = "true").
Declaration
public string Filter { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Header
The standard Fleet Engine request header.
Declaration
public RequestHeader Header { get; set; }
Property Value
| Type | Description |
|---|---|
| RequestHeader |
MaximumStaleness
Restricts the response to vehicles that have sent location updates to Fleet Engine within the specified duration. Stationary vehicles still transmitting their locations are not considered stale. If present, must be a valid positive duration.
Declaration
public Duration MaximumStaleness { get; set; }
Property Value
| Type | Description |
|---|---|
| Duration |
MinimumCapacity
Specifies the required minimum capacity of the vehicle. All vehicles
returned will have a maximum_capacity greater than or equal to this
value. If set, must be greater or equal to 0.
Declaration
public int? MinimumCapacity { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
OnTripOnly
Only return the vehicles with current trip(s).
Declaration
public bool OnTripOnly { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
PageSize
The maximum number of vehicles to return. Default value: 100.
Declaration
public int PageSize { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Implements
PageToken
The value of the next_page_token provided by a previous call to
ListVehicles so that you can paginate through groups of vehicles. The
value is undefined if the filter criteria of the request is not the same as
the filter criteria for the previous call to ListVehicles.
Declaration
public string PageToken { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Implements
Parent
Required. Must be in the format providers/{provider}.
The provider must be the Project ID (for example, sample-cloud-project)
of the Google Cloud Project of which the service account making
this call is a member.
Declaration
public string Parent { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
RequiredAttributes
Callers can form complex logical operations using any combination of the
required_attributes, required_one_of_attributes, and
required_one_of_attribute_sets fields.
required_attributes is a list; required_one_of_attributes uses a
message which allows a list of lists. In combination, the two fields allow
the composition of this expression:
(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)
Restricts the response to vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 required_attributes is allowed. This matches the maximum number of attributes allowed on a vehicle. Each repeated string should be of the format "key:value".
Declaration
public RepeatedField<string> RequiredAttributes { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<string> |
RequiredOneOfAttributeSets
required_one_of_attribute_sets provides additional functionality.
Similar to required_one_of_attributes, required_one_of_attribute_sets
uses a message which allows a list of lists, allowing expressions such as
this one:
(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
(required_one_of_attribute_sets[0][0] AND
required_one_of_attribute_sets[0][1] AND
...)
OR
(required_one_of_attribute_sets[1][0] AND
required_one_of_attribute_sets[1][1] AND
...)
)
Restricts the response to vehicles that match all the attributes in a
VehicleAttributeList. Within each list, a vehicle must match all of the
attributes. This field is a conjunction/AND operation in each
VehicleAttributeList and inclusive disjunction/OR operation across the
collection of VehicleAttributeList. Each repeated string should be of the
format "key1:value1|key2:value2|key3:value3".
Declaration
public RepeatedField<string> RequiredOneOfAttributeSets { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<string> |
RequiredOneOfAttributes
Restricts the response to vehicles with at least one of the specified
attributes in each VehicleAttributeList. Within each list, a vehicle must
match at least one of the attributes. This field is an inclusive
disjunction/OR operation in each VehicleAttributeList and a
conjunction/AND operation across the collection of VehicleAttributeList.
Each repeated string should be of the format
"key1:value1|key2:value2|key3:value3".
Declaration
public RepeatedField<string> RequiredOneOfAttributes { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<string> |
TripTypes
Restricts the response to vehicles that support at least one of the specified trip types.
Declaration
public RepeatedField<TripType> TripTypes { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<TripType> |
VehicleState
Restricts the response to vehicles that have this vehicle state.
Declaration
public VehicleState VehicleState { get; set; }
Property Value
| Type | Description |
|---|---|
| VehicleState |
VehicleTypeCategories
Required. Restricts the response to vehicles with one of the specified type
categories. UNKNOWN is not allowed.
Declaration
public RepeatedField<Vehicle.Types.VehicleType.Types.Category> VehicleTypeCategories { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<Vehicle.Types.VehicleType.Types.Category> |
Viewport
Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.
Declaration
public Viewport Viewport { get; set; }
Property Value
| Type | Description |
|---|---|
| Viewport |