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

网址采用 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)

对完整尺寸原始图片的引用。

这与图片 Step 下的 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" }