- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Solicitar corpo
- Corpo de resposta
- Escopos de autorização
- Imagem
- Miniatura
- Status
- Tente!
Lista miniaturas de imagens anexadas a uma etapa.
Pode retornar qualquer um dos seguintes códigos de erro canônicos: - PERMISSION_DENIED - se o usuário não estiver autorizado a ler o projeto ou qualquer uma das imagens - INVALID_ARGUMENT - se a solicitação estiver malformada - NOT_FOUND - se a etapa não existir, ou se alguma das imagens não existir
Solicitação HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
A URL usa sintaxe de transcodificação gRPC .
Parâmetros de caminho
Parâmetros | |
---|---|
projectId | Um ID do projeto. Obrigatório. |
historyId | Uma identificação de histórico. Obrigatório. |
executionId | Um ID de execução. Obrigatório. |
stepId | Um ID de etapa. Obrigatório. |
Parâmetros de consulta
Parâmetros | |
---|---|
pageToken | Um token de continuação para retomar a consulta no próximo item. Opcional. |
pageSize | O número máximo de miniaturas a serem buscadas. Valor padrão: 50. O servidor usará esse padrão se o campo não estiver definido ou tiver o valor 0. Opcional. |
Solicitar corpo
O corpo da solicitação deve estar vazio.
Corpo de resposta
Uma resposta contendo as miniaturas de uma etapa.
Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:
Representação JSON |
---|
{
"thumbnails": [
{
object ( |
Campos | |
---|---|
thumbnails[] | Uma lista de dados de imagem. As imagens são retornadas em ordem determinística; eles são ordenados por estes fatores, em ordem de importância: * Primeiro, pelo caso de teste associado. Imagens sem caso de teste são consideradas maiores do que imagens com caso de teste. * Segundo, pela época de criação. Imagens sem tempo de criação são maiores do que imagens com tempo de criação. * Terceiro, pela ordem em que foram adicionados à etapa (por chamadas para steps.create ou steps.patch). |
nextPageToken | Um token de continuação para retomar a consulta no próximo item. Se definido, indica que há mais miniaturas para ler, chamando list novamente com este valor no campo pageToken. |
Escopos de autorização
Requer o seguinte escopo OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Para obter mais informações, consulte Visão geral da autenticação .
Imagem
Uma imagem, com link para a imagem principal e uma miniatura.
Representação JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
Campos | |
---|---|
stepId | A etapa à qual a imagem está anexada. Sempre definido. |
sourceImage | Uma referência à imagem original em tamanho real. É o mesmo que a entrada toolOutputs para a imagem em sua Etapa. Sempre definido. |
Campo de união thumbnail_or_error . Uma miniatura da imagem ou um erro explicando por que a miniatura não pôde ser renderizada. thumbnail_or_error pode ser apenas um dos seguintes: | |
thumbnail | A miniatura. |
error | Um erro explicando por que a miniatura não pôde ser renderizada. |
Miniatura
Uma única miniatura, com seu tamanho e formato.
Representação JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Campos | |
---|---|
contentType | O tipo de conteúdo da miniatura, ou seja, "imagem/png". Sempre definido. |
heightPx | A altura da miniatura, em pixels. Sempre definido. |
widthPx | A largura da miniatura, em pixels. Sempre definido. |
data | O próprio arquivo de miniatura. Ou seja, os bytes aqui são justamente os bytes que compõem o arquivo de miniatura; eles podem ser exibidos como uma imagem como estão (com o tipo de conteúdo apropriado). Sempre definido. Uma string codificada em base64. |
Status
O tipo Status
define um modelo de erro lógico adequado para diferentes ambientes de programação, incluindo APIs REST e APIs RPC. É usado pelo gRPC . Cada mensagem Status
contém três dados: código de erro, mensagem de erro e detalhes do erro.
Você pode descobrir mais sobre esse modelo de erro e como trabalhar com ele no API Design Guide .
Representação JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campos | |
---|---|
code | O código de status, que deve ser um valor enum de |
message | Uma mensagem de erro voltada ao desenvolvedor, que deve estar em inglês. Qualquer mensagem de erro voltada ao usuário deve ser localizada e enviada no campo |
details[] | Uma lista de mensagens que contêm os detalhes do erro. Há um conjunto comum de tipos de mensagens para uso pelas APIs. Um objeto que contém campos de tipo arbitrário. Um campo adicional |