- Solicitud HTTP
- Parámetros de ruta
- Parámetros de consulta
- cuerpo de la solicitud
- Cuerpo de respuesta
- Ámbitos de autorización
- Imagen
- Miniatura
- Estado
- ¡Intentalo!
Enumera miniaturas de imágenes adjuntas a un paso.
Puede devolver cualquiera de los siguientes códigos de error canónicos: - PERMISSION_DENIED - si el usuario no está autorizado para leer del proyecto o de cualquiera de las imágenes - INVALID_ARGUMENT - si la solicitud tiene un formato incorrecto - NOT_FOUND - si el paso no existe, o si alguna de las imagenes no existe
Solicitud HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
La URL usa la sintaxis de transcodificación de gRPC .
Parámetros de ruta
Parámetros | |
---|---|
projectId | Una identificación del proyecto. Requerido. |
historyId | Una identificación de historial. Requerido. |
executionId | Una identificación de ejecución. Requerido. |
stepId | Una identificación de paso. Requerido. |
Parámetros de consulta
Parámetros | |
---|---|
pageToken | Un token de continuación para reanudar la consulta en el siguiente elemento. Opcional. |
pageSize | El número máximo de miniaturas para obtener. Valor predeterminado: 50. El servidor utilizará este valor predeterminado si el campo no está configurado o tiene un valor de 0. Opcional. |
cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de respuesta
Una respuesta que contiene las miniaturas en un paso.
Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"thumbnails": [
{
object ( |
Campos | |
---|---|
thumbnails[] | Una lista de datos de imagen. Las imágenes se devuelven en un orden determinista; están ordenados por estos factores, en orden de importancia: * Primero, por su caso de prueba asociado. Las imágenes sin un caso de prueba se consideran mayores que las imágenes con uno. * Segundo, por su tiempo de creación. Las imágenes sin un tiempo de creación son más grandes que las imágenes con uno. * Tercero, por el orden en que se agregaron al paso (mediante llamadas a steps.create o steps.patch). |
nextPageToken | Un token de continuación para reanudar la consulta en el siguiente elemento. Si se establece, indica que hay más miniaturas para leer, llamando a la lista nuevamente con este valor en el campo pageToken. |
Ámbitos de autorización
Requiere el siguiente alcance de OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulte Descripción general de la autenticación .
Imagen
Una imagen, con un enlace a la imagen principal y una miniatura.
Representación JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
Campos | |
---|---|
stepId | El paso al que se adjunta la imagen. Siempre listo. |
sourceImage | Una referencia a la imagen original de tamaño completo. Esto es lo mismo que la entrada toolOutputs para la imagen en su Paso. Siempre listo. |
Campo de unión thumbnail_or_error . Una miniatura de la imagen o un error que explica por qué no se pudo representar la miniatura. thumbnail_or_error solo puede ser uno de los siguientes: | |
thumbnail | La miniatura. |
error | Un error que explica por qué no se pudo procesar la miniatura. |
Miniatura
Una sola miniatura, con su tamaño y formato.
Representación JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Campos | |
---|---|
contentType | El tipo de contenido de la miniatura, es decir, "imagen/png". Siempre listo. |
heightPx | La altura de la miniatura, en píxeles. Siempre listo. |
widthPx | El ancho de la miniatura, en píxeles. Siempre listo. |
data | El archivo de miniaturas en sí. Es decir, los bytes aquí son precisamente los bytes que componen el archivo de miniaturas; se pueden servir como una imagen tal cual (con el tipo de contenido adecuado). Siempre listo. Una cadena codificada en base64. |
Estado
El tipo Status
define un modelo de error lógico que es adecuado para diferentes entornos de programación, incluidas las API REST y las API RPC. Es utilizado por gRPC . Cada mensaje Status
contiene tres datos: código de error, mensaje de error y detalles del error.
Puede obtener más información sobre este modelo de error y cómo trabajar con él en la Guía de diseño de API .
Representación JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campos | |
---|---|
code | El código de estado, que debe ser un valor de enumeración de |
message | Un mensaje de error para el desarrollador, que debe estar en inglés. Cualquier mensaje de error que vea el usuario debe localizarse y enviarse en el campo |
details[] | Una lista de mensajes que llevan los detalles del error. Existe un conjunto común de tipos de mensajes para que los utilicen las API. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |