Google Maps FleetEngine Delivery V1 Client - Class ListTasksRequest (0.1.5)

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

The ListTasks request message.

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

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 Tasks to return. The service may return fewer than this value. If you don't specify this value, then the server determines the number of results to return.
`↳ page_token`	`string` Optional. A page token received from a previous `ListTasks` call. You can provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTasks` must match the call that provided the page token.
`↳ filter`	`string` Optional. A filter query to apply when listing Tasks. See http://aip.dev/160 for examples of filter syntax. If you don't specify a value, or if you filter on an empty string, then all Tasks are returned. For information about the Task properties that you can filter on, see List tasks.

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 Tasks to return. The service may return fewer than this value. If you don't specify this value, then the server determines the number of results to return.

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of Tasks to return. The service may return fewer than this value. If you don't specify this value, 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 ListTasks call.

You can provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTasks must match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

Optional. A page token received from a previous ListTasks call.

You can provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTasks 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 Tasks. See http://aip.dev/160 for examples of filter syntax. If you don't specify a value, or if you filter on an empty string, then all Tasks are returned.

For information about the Task properties that you can filter on, see List tasks.

Returns
Type	Description
`string`

setFilter

For information about the Task properties that you can filter on, see List tasks.

Parameter
Name	Description
`var`	`string`

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\ListTasksRequest`