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

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

The ListDeliveryVehicles response message.

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

Namespace

Google \ Maps \ FleetEngine \ Delivery \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ delivery_vehicles array<Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle>

The set of delivery vehicles that meet the requested filtering criteria. When no filter is specified, the request returns all delivery vehicles. A successful response can also be empty. An empty response indicates that no delivery vehicles were found meeting the requested filter criteria.

↳ next_page_token string

You can pass this token in the ListDeliveryVehiclesRequest to continue to list results. When all of the results are returned, this field won't be in the response, or it will be an empty string.

↳ total_size int|string

The total number of delivery vehicles that match the request criteria, across all pages.

getDeliveryVehicles

The set of delivery vehicles that meet the requested filtering criteria.

When no filter is specified, the request returns all delivery vehicles. A successful response can also be empty. An empty response indicates that no delivery vehicles were found meeting the requested filter criteria.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDeliveryVehicles

The set of delivery vehicles that meet the requested filtering criteria.

When no filter is specified, the request returns all delivery vehicles. A successful response can also be empty. An empty response indicates that no delivery vehicles were found meeting the requested filter criteria.

Parameter
Name Description
var array<Google\Maps\FleetEngine\Delivery\V1\DeliveryVehicle>
Returns
Type Description
$this

getNextPageToken

You can pass this token in the ListDeliveryVehiclesRequest to continue to list results. When all of the results are returned, this field won't be in the response, or it will be an empty string.

Returns
Type Description
string

setNextPageToken

You can pass this token in the ListDeliveryVehiclesRequest to continue to list results. When all of the results are returned, this field won't be in the response, or it will be an empty string.

Parameter
Name Description
var string
Returns
Type Description
$this

getTotalSize

The total number of delivery vehicles that match the request criteria, across all pages.

Returns
Type Description
int|string

setTotalSize

The total number of delivery vehicles that match the request criteria, across all pages.

Parameter
Name Description
var int|string
Returns
Type Description
$this