Google Maps FleetEngine Delivery V1 Client - Class ListDeliveryVehiclesRequest (0.1.1)

Reference documentation and code samples for the Google Maps FleetEngine Delivery V1 Client class ListDeliveryVehiclesRequest.

The ListDeliveryVehicles request message.

Generated from protobuf message maps.fleetengine.delivery.v1.ListDeliveryVehiclesRequest

Namespace

Google \ Maps \ FleetEngine \ Delivery \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ header Google\Maps\FleetEngine\Delivery\V1\DeliveryRequestHeader

Optional. The standard Delivery API request header.
↳ parent string

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

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.
↳ page_token string

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.
↳ filter string

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.
↳ viewport Google\Geo\Type\Viewport

Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.

getHeader

Optional. The standard Delivery API request header.

Returns
Type Description
Google\Maps\FleetEngine\Delivery\V1\DeliveryRequestHeader|null

hasHeader

clearHeader

setHeader

Optional. The standard Delivery API request header.

Parameter
Name Description
var Google\Maps\FleetEngine\Delivery\V1\DeliveryRequestHeader
Returns
Type Description
$this

getParent

Required. Must be in the format providers/{provider}.

The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Returns
Type Description
string

setParent

Required. Must be in the format providers/{provider}.

The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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.

Returns
Type Description
string

setFilter

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getViewport

Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.

Returns
Type Description
Google\Geo\Type\Viewport|null

hasViewport

clearViewport

setViewport

Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.

Parameter
Name Description
var Google\Geo\Type\Viewport
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project. Please see Google\Maps\FleetEngine\Delivery\V1\DeliveryServiceClient::providerName() for help formatting this field.
Returns
Type Description
Google\Maps\FleetEngine\Delivery\V1\ListDeliveryVehiclesRequest