Google Maps FleetEngine Delivery V1 Client - Class ListTasksResponse (0.1.7)

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

The ListTasks response that contains the set of Tasks that meet the filter criteria in the ListTasksRequest.

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

Namespace

Google \ Maps \ FleetEngine \ Delivery \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ tasks array<Task>

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

↳ next_page_token string

Pass this token in the ListTasksRequest to continue to list results. If all results have been returned, then this field is either an empty string, or it doesn't appear in the response.

↳ total_size int|string

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

getTasks

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTasks

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

Parameter
Name Description
var array<Task>
Returns
Type Description
$this

getNextPageToken

Pass this token in the ListTasksRequest to continue to list results.

If all results have been returned, then this field is either an empty string, or it doesn't appear in the response.

Returns
Type Description
string

setNextPageToken

Pass this token in the ListTasksRequest to continue to list results.

If all results have been returned, then this field is either an empty string, or it doesn't appear in the response.

Parameter
Name Description
var string
Returns
Type Description
$this

getTotalSize

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

Returns
Type Description
int|string

setTotalSize

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

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