Method: providers.tasks.list

  • Retrieves all Tasks that meet specified filtering criteria using a GET request.

  • Allows filtering by various parameters such as header, pageSize, pageToken, and filter.

  • Request body should be empty, with response containing a list of Task objects, nextPageToken, and totalSize.

  • Uses gRPC Transcoding syntax for the request URL, with parent path parameter specifying the provider.

  • If successful, response includes an array of Task objects matching the filter, potentially empty if no tasks match.

Gets all Tasks that meet the specified filtering criteria.

HTTP request

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
header

object (DeliveryRequestHeader)

Optional. The standard Delivery API request header.
pageSize

integer

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.
pageToken

string

Optional. A page token received from a previous tasks.list call. You can provide this to retrieve the subsequent page.

When paginating, all other parameters provided to tasks.list 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.

Request body

The request body must be empty.

Response body

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

If successful, the response body contains data with the following structure:

JSON representation 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Fields
tasks[]

object (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.
nextPageToken

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.
totalSize

string (int64 format)

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