Method: projects.histories.executions.steps.thumbnails.list

列出步驟附加的圖片縮圖。

可能會傳回下列任一標準錯誤代碼:- PERMISSION_DENIED - 如果使用者未獲授權,無法讀取專案或任何映像檔 (如果要求格式錯誤,則為 NOT_FOUND - 如果步驟不存在,或是任何映像檔不存在)

HTTP 要求

GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
projectId

string

專案 ID。

必填。

historyId

string

記錄 ID。

必填。

executionId

string

執行作業 ID。

必填。

stepId

string

步驟 ID。

必填。

查詢參數

參數
pageToken

string

可在下一個項目繼續查詢的接續權杖。

選填。

pageSize

integer

要擷取的縮圖數量上限。

預設值為 50。如果未設定欄位或欄位的值為 0,伺服器就會使用這個預設值。

選填。

要求主體

要求主體必須為空白。

回應主體

包含步驟中縮圖的回應。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "thumbnails": [
    {
      object (Image)
    }
  ],
  "nextPageToken": string
}
欄位
thumbnails[]

object (Image)

圖片資料清單。

圖片會以決定順序傳回;因此,這些因素按照重要程度排序:* 第一是按照相關的測試案例排序。沒有測試案例的圖片會視為大於含有一個圖片的圖片。* 第二是按建立時間列出。沒有建立時間的圖片會大於含有建立時間的圖片。* 第三,按照步驟加入步驟的順序 (透過呼叫 steps.create 或 steps.patch 加入)。

nextPageToken

string

可在下一個項目繼續查詢的接續權杖。

如果設定此值,就表示 pageToken 欄位設有此值,再次呼叫清單,表示還有更多可讀取的縮圖。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱驗證總覽一文。

圖片

圖片,包含主要圖片連結和縮圖。

JSON 表示法
{
  "stepId": string,
  "sourceImage": {
    object (ToolOutputReference)
  },

  // Union field thumbnail_or_error can be only one of the following:
  "thumbnail": {
    object (Thumbnail)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field thumbnail_or_error.
}
欄位
stepId

string

圖片附加的步驟。

一律設定。

sourceImage

object (ToolOutputReference)

原尺寸原始圖片的參照。

這與其「步驟」中圖片的 toolsOutputs 項目相同。

一律設定。

聯集欄位 thumbnail_or_error。圖片縮圖或縮圖無法顯示的原因錯誤。thumbnail_or_error 只能採用下列其中一種設定:
thumbnail

object (Thumbnail)

縮圖。

error

object (Status)

說明縮圖無法顯示原因的錯誤。

縮圖

單一縮圖,其大小和格式。

JSON 表示法
{
  "contentType": string,
  "heightPx": integer,
  "widthPx": integer,
  "data": string
}
欄位
contentType

string

縮圖的內容類型,例如「image/png」。

一律設定。

heightPx

integer

縮圖的高度 (以像素為單位)。

一律設定。

widthPx

integer

縮圖的寬度 (以像素為單位)。

一律設定。

data

string (bytes format)

縮圖檔案本身。

換句話說,這裡的位元組就是縮圖檔案的位元組。並以圖片原樣 (搭配合適的內容類型) 提供。

一律設定。

Base64 編碼字串。

狀態

Status 類型會定義適用於不同程式設計環境 (包含 REST API 和遠端程序呼叫 (RPC) API) 的邏輯錯誤模型。gRPC 會使用這個模型。每個 Status 訊息包含三部分的資料:錯誤代碼、錯誤訊息和錯誤詳細資料。

如要進一步瞭解這個錯誤模型,以及如何使用這個錯誤模型,請參閱 API 設計指南

JSON 表示法
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
欄位
code

integer

狀態碼,應為 google.rpc.Code 的列舉值。

message

string

向開發人員顯示的錯誤訊息,應以英文呈現。凡是向使用者顯示的錯誤訊息,都應透過 google.rpc.Status.details 欄位進行本地化並傳送,或由用戶端進行本地化。

details[]

object

附有錯誤詳細資料的訊息清單。這是供 API 使用的一組常用訊息類型。

包含任意類型欄位的物件。額外的 "@type" 欄位則包含能辨識類型的 URI。範例:{ "id": 1234, "@type": "types.example.com/standard/id" }