Method: providers.tasks.list

指定したフィルタ条件を満たすすべての Task を取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。providers/{provider} の形式で指定してください。provider には、Google Cloud プロジェクト ID を指定する必要があります。例: sample-cloud-project

クエリ パラメータ

パラメータ
header

object (DeliveryRequestHeader)

省略可。標準の Delivery API リクエスト ヘッダー。
pageSize

integer

省略可。返されるタスクの最大数。サービスはこの値より少ない値を返すことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。
pageToken

string

省略可。前回の tasks.list 呼び出しで受け取ったページトークン。これを指定して後続のページを取得できます。

ページ分割を行う場合、tasks.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

省略可。タスクを一覧表示するときに適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。値を指定しない場合、または空の文字列でフィルタした場合は、すべてのタスクが返されます。フィルタできるタスク プロパティの詳細については、タスクの一覧表示をご覧ください。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ListTasksRequest のフィルタ条件を満たすタスクのセットを含む tasks.list レスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
フィールド
tasks[]

object (Task)

リクエストされたフィルタ条件を満たすタスクのセット。フィルタが指定されていない場合、リクエストはすべてのタスクを返します。正常なレスポンスは空にすることもできます。空のレスポンスは、リクエストされたフィルタ条件に一致するタスクが見つからなかったことを示します。
nextPageToken

string

結果の一覧表示を続行するには、このトークンを ListTasksRequest に渡します。すべての結果が返された場合、このフィールドは空の文字列になるか、レスポンスに表示されません。
totalSize

string (int64 format)

すべてのページにおける、リクエスト条件に一致するタスクの合計数。