Method: providers.tasks.list

הפונקציה מקבלת את כל הפריטים מסוג 'Task' שעומדים בקריטריונים לסינון שצוינו.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. חייב להיות בפורמט providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

פרמטרים של שאילתה

פרמטרים
header

object (DeliveryRequestHeader)

זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API.

pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של Tasks שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא מציינים את הערך הזה, השרת קובע את מספר התוצאות שיוחזרו.

pageToken

string

זה שינוי אופציונלי. אסימון דף שהתקבל משיחת tasks.list קודמת. ניתן לספק זאת כדי לאחזר את הדף הבא.

במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל-tasks.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.

filter

string

זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמציגים רשימה של Tasks. בכתובת http://aip.dev/160 תוכלו לראות דוגמאות לתחביר של מסננים. אם לא תציינו ערך, או אם בחרתם לסנן לפי מחרוזת ריקה, כל המשימות יוחזרו. מידע נוסף על המאפיינים של משימות שאפשר לסנן לפיהם מופיע במאמר הצגת רשימת המשימות.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

התשובה tasks.list שמכילה את קבוצת המשימות שעומדות בקריטריוני הסינון של ListTasksRequest.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
שדות
tasks[]

object (Task)

קבוצת המשימות שעומדות בקריטריונים לסינון הנדרשים. אם לא מוגדר מסנן, הבקשה מחזירה את כל המשימות. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו משימות שתואמות לקריטריוני הסינון המבוקשים.

nextPageToken

string

צריך להעביר את האסימון הזה ב-ListTasksRequest כדי להמשיך להצגת התוצאות. אם כל התוצאות הוחזרו, השדה הזה הוא מחרוזת ריקה או שהוא לא מופיע בתשובה.

totalSize

string (int64 format)

המספר הכולל של משימות שתואמות לקריטריוני הבקשה, בכל הדפים.