• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="toolresults_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.projects.html">projects</a> . <a href="toolresults_v1beta3.projects.histories.html">histories</a> . <a href="toolresults_v1beta3.projects.histories.executions.html">executions</a> . <a href="toolresults_v1beta3.projects.histories.executions.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(projectId, historyId, executionId, clusterId)</a></code></p>
79<p class="firstline">Retrieves a single screenshot cluster by its ID</p>
80<p class="toc_element">
81  <code><a href="#list">list(projectId, historyId, executionId)</a></code></p>
82<p class="firstline">Lists Screenshot Clusters</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="get">get(projectId, historyId, executionId, clusterId)</code>
86  <pre>Retrieves a single screenshot cluster by its ID
87
88Args:
89  projectId: string, A Project id.
90
91Required. (required)
92  historyId: string, A History id.
93
94Required. (required)
95  executionId: string, An Execution id.
96
97Required. (required)
98  clusterId: string, A Cluster id
99
100Required. (required)
101
102Returns:
103  An object of the form:
104
105    {
106    "keyScreen": { # A singular screen that represents the cluster as a whole. This screen will act as the "cover" of the entire cluster. When users look at the clusters, only the key screen from each cluster will be shown. Which screen is the key screen is determined by the ClusteringAlgorithm
107      "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
108      "model": "A String", # Model of the device that the screenshot was taken on. Required.
109      "version": "A String", # OS version of the device that the screenshot was taken on. Required.
110      "fileReference": "A String", # File reference of the png file. Required.
111    },
112    "screens": [ # Full list of screens.
113      {
114        "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
115        "model": "A String", # Model of the device that the screenshot was taken on. Required.
116        "version": "A String", # OS version of the device that the screenshot was taken on. Required.
117        "fileReference": "A String", # File reference of the png file. Required.
118      },
119    ],
120    "clusterId": "A String", # A unique identifier for the cluster.
121    "activity": "A String", # A string that describes the activity of every screen in the cluster.
122  }</pre>
123</div>
124
125<div class="method">
126    <code class="details" id="list">list(projectId, historyId, executionId)</code>
127  <pre>Lists Screenshot Clusters
128
129Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.
130
131Args:
132  projectId: string, A Project id.
133
134Required. (required)
135  historyId: string, A History id.
136
137Required. (required)
138  executionId: string, An Execution id.
139
140Required. (required)
141
142Returns:
143  An object of the form:
144
145    {
146    "clusters": [ # The set of clusters associated with an execution Always set
147      {
148        "keyScreen": { # A singular screen that represents the cluster as a whole. This screen will act as the "cover" of the entire cluster. When users look at the clusters, only the key screen from each cluster will be shown. Which screen is the key screen is determined by the ClusteringAlgorithm
149          "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
150          "model": "A String", # Model of the device that the screenshot was taken on. Required.
151          "version": "A String", # OS version of the device that the screenshot was taken on. Required.
152          "fileReference": "A String", # File reference of the png file. Required.
153        },
154        "screens": [ # Full list of screens.
155          {
156            "locale": "A String", # Locale of the device that the screenshot was taken on. Required.
157            "model": "A String", # Model of the device that the screenshot was taken on. Required.
158            "version": "A String", # OS version of the device that the screenshot was taken on. Required.
159            "fileReference": "A String", # File reference of the png file. Required.
160          },
161        ],
162        "clusterId": "A String", # A unique identifier for the cluster.
163        "activity": "A String", # A string that describes the activity of every screen in the cluster.
164      },
165    ],
166  }</pre>
167</div>
168
169</body></html>