- solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- corpo da 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 do projeto ou de qualquer uma das imagens - INVALID_ARGUMENT - se a solicitação for 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 a sintaxe de transcodificação gRPC .
Parâmetros de caminho
Parâmetros | |
---|---|
projectId | Um ID de projeto. Obrigatório. |
historyId | Uma identificação de história. 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. |
Corpo da solicitação
O corpo da solicitação deve estar vazio.
corpo da resposta
Uma resposta contendo as miniaturas em uma etapa.
Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:
representação JSON |
---|
{
"thumbnails": [
{
object ( |
Campos | |
---|---|
thumbnails[] | Uma lista de dados de imagem. As imagens são retornadas em uma ordem determinística; eles são ordenados por estes fatores, em ordem de importância: * Primeiro, por seu caso de teste associado. As imagens sem um caso de teste são consideradas maiores do que as imagens com um. * Em segundo lugar, por seu tempo de criação. As imagens sem tempo de criação são maiores do que as imagens com um. * Em terceiro lugar, 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 esse 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 um 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. Isso é 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 precisamente os bytes que compõem o arquivo de miniatura; eles podem ser exibidos como uma imagem no estado em que se encontram (com o tipo de conteúdo apropriado). Sempre definido. Uma string codificada em base64. |
Status
O tipo Status
define um modelo lógico de erro 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 saber 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 para o desenvolvedor, que deve estar em inglês. Qualquer mensagem de erro voltada para o usuário deve ser localizada e enviada no campo |
details[] | Uma lista de mensagens que carregam os detalhes do erro. Há um conjunto comum de tipos de mensagens para APIs usarem. Um objeto que contém campos de um tipo arbitrário. Um campo adicional |