Class ListDeliveryVehiclesRequest

The ListDeliveryVehicles request message.

Inheritance

object

ListDeliveryVehiclesRequest

Implements

IMessage<ListDeliveryVehiclesRequest>

IEquatable<ListDeliveryVehiclesRequest>

IDeepCloneable<ListDeliveryVehiclesRequest>

IBufferMessage

IMessage

IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Maps.FleetEngine.Delivery.V1

Assembly: Google.Maps.FleetEngine.Delivery.V1.dll

Syntax

public sealed class ListDeliveryVehiclesRequest : IMessage<ListDeliveryVehiclesRequest>, IEquatable<ListDeliveryVehiclesRequest>, IDeepCloneable<ListDeliveryVehiclesRequest>, IBufferMessage, IMessage, IPageRequest

Constructors

ListDeliveryVehiclesRequest()

Declaration

public ListDeliveryVehiclesRequest()

ListDeliveryVehiclesRequest(ListDeliveryVehiclesRequest)

Declaration

public ListDeliveryVehiclesRequest(ListDeliveryVehiclesRequest other)

Parameters

Type	Name	Description
ListDeliveryVehiclesRequest	other

Properties

Filter

Optional. A filter query to apply when listing delivery vehicles. See http://aip.dev/160 for examples of the filter syntax. If you don't specify a value, or if you specify an empty string for the filter, then all delivery vehicles are returned.

Note that the only queries supported for ListDeliveryVehicles are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). 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").

The maximum number of restrictions allowed in a filter query is 50. A restriction is a part of the query of the form attribute.<KEY> <COMPARATOR> <VALUE>, for example attributes.foo = bar is 1 restriction.

Declaration

public string Filter { get; set; }

Property Value

Type	Description
string

Header

Optional. The standard Delivery API request header.

Declaration

public DeliveryRequestHeader Header { get; set; }

Property Value

Type	Description
DeliveryRequestHeader

PageSize

Optional. The maximum number of vehicles to return. The service may return fewer than this number. If you don't specify this number, then the server determines the number of results to return.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
int

Implements

IPageRequest.PageSize

PageToken

Optional. A page token, received from a previous ListDeliveryVehicles call. You must provide this in order to retrieve the subsequent page.

When paginating, all other parameters provided to ListDeliveryVehicles must match the call that provided the page token.

Declaration

public string PageToken { get; set; }

Property Value

Type	Description
string

Implements

IPageRequest.PageToken

Parent

Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Declaration

public string Parent { get; set; }

Property Value

Type	Description
string

ParentAsProviderName

ProviderName-typed view over the Parent resource name property.

Declaration

public ProviderName ParentAsProviderName { get; set; }

Property Value

Type	Description
ProviderName

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