- Requête HTTP
- Paramètres du chemin
- Paramètres de requête
- Corps de la demande
- Corps de réponse
- Portées des autorisations
- Image
- Vignette
- Statut
- Essayez-le !
Répertorie les miniatures des images attachées à une étape.
Peut renvoyer l'un des codes d'erreur canoniques suivants : - PERMISSION_DENIED - si l'utilisateur n'est pas autorisé à lire le projet ou l'une des images - INVALID_ARGUMENT - si la requête est mal formée - NOT_FOUND - si l'étape n'existe pas, ou si l'une des images n'existe pas
Requête HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
L'URL utilise la syntaxe de transcodage gRPC .
Paramètres du chemin
Paramètres | |
---|---|
projectId | Un identifiant de projet. Requis. |
historyId | Un identifiant d'historique. Requis. |
executionId | Un identifiant d’exécution. Requis. |
stepId | Un identifiant d'étape. Requis. |
Paramètres de requête
Paramètres | |
---|---|
pageToken | Un jeton de continuation pour reprendre la requête à l'élément suivant. Facultatif. |
pageSize | Le nombre maximum de vignettes à récupérer. Valeur par défaut : 50. Le serveur utilisera cette valeur par défaut si le champ n'est pas défini ou a une valeur de 0. Facultatif. |
Corps de la demande
Le corps de la requête doit être vide.
Corps de réponse
Une réponse contenant les vignettes d’une étape.
En cas de succès, le corps de la réponse contient des données avec la structure suivante :
Représentation JSON |
---|
{
"thumbnails": [
{
object ( |
Des champs | |
---|---|
thumbnails[] | Une liste de données d'image. Les images sont renvoyées dans un ordre déterministe ; ils sont classés selon ces facteurs, par ordre d'importance : * Premièrement, par leur scénario de test associé. Les images sans scénario de test sont considérées comme supérieures aux images avec un. * Deuxièmement, par leur heure de création. Les images sans temps de création sont plus grandes que les images avec un temps de création. * Troisièmement, par l'ordre dans lequel ils ont été ajoutés à l'étape (par des appels à steps.create ou steps.patch). |
nextPageToken | Un jeton de continuation pour reprendre la requête à l'élément suivant. S'il est défini, indique qu'il y a d'autres vignettes à lire, en appelant à nouveau list avec cette valeur dans le champ pageToken. |
Portées des autorisations
Nécessite le champ d'application OAuth suivant :
-
https://www.googleapis.com/auth/cloud-platform
Pour plus d'informations, consultez la Présentation de l'authentification .
Image
Une image, avec un lien vers l'image principale et une vignette.
Représentation JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
Des champs | |
---|---|
stepId | L'étape à laquelle l'image est attachée. Toujours réglé. |
sourceImage | Une référence à l’image originale en taille réelle. C'est la même chose que l'entrée toolOutputs pour l'image sous son étape. Toujours réglé. |
Champ d'union thumbnail_or_error . Soit une miniature de l'image, soit une erreur expliquant pourquoi la miniature n'a pas pu être rendue. thumbnail_or_error ne peut être que l'un des éléments suivants : | |
thumbnail | La vignette. |
error | Une erreur expliquant pourquoi la vignette n'a pas pu être rendue. |
Vignette
Une seule vignette, avec sa taille et son format.
Représentation JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Des champs | |
---|---|
contentType | Le type de contenu de la vignette, c'est-à-dire "image/png". Toujours réglé. |
heightPx | La hauteur de la vignette, en pixels. Toujours réglé. |
widthPx | La largeur de la vignette, en pixels. Toujours réglé. |
data | Le fichier miniature lui-même. Autrement dit, les octets ici sont précisément les octets qui constituent le fichier miniature ; ils peuvent être servis sous forme d'image tels quels (avec le type de contenu approprié.) Toujours réglé. Une chaîne codée en base64. |
Statut
Le type Status
définit un modèle d'erreur logique adapté à différents environnements de programmation, notamment les API REST et les API RPC. Il est utilisé par gRPC . Chaque message Status
contient trois éléments de données : le code d'erreur, le message d'erreur et les détails de l'erreur.
Vous pouvez en savoir plus sur ce modèle d'erreur et comment l'utiliser dans le Guide de conception d'API .
Représentation JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Des champs | |
---|---|
code | Le code d'état, qui doit être une valeur énumérée de |
message | Un message d'erreur destiné aux développeurs, qui doit être en anglais. Tout message d'erreur destiné à l'utilisateur doit être localisé et envoyé dans le champ |
details[] | Une liste de messages contenant les détails de l'erreur. Il existe un ensemble commun de types de messages que les API peuvent utiliser. Un objet contenant des champs d'un type arbitraire. Un champ supplémentaire |