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

列出附加到步骤的图像的缩略图。

可能返回以下任何规范错误代码: - PERMISSION_DENIED - 如果用户无权从项目或任何图像中读取 - INVALID_ARGUMENT - 如果请求格式错误 - NOT_FOUND - 如果步骤不存在,或者如果任何图像不存在

HTTP请求

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

URL 使用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 字段中的该值再次调用 list。

授权范围

需要以下 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 )

对全尺寸原始图像的参考。

这与其步骤下图像的 toolOutputs 条目相同。

始终设置。

联合字段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" }