blob: 82bc8513191cfd270dd8385a8aeb50e689c393ae [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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.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, x__xgafv=None)</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, x__xgafv=None)</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, x__xgafv=None)</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 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 {
110 &quot;activity&quot;: &quot;A String&quot;, # A string that describes the activity of every screen in the cluster.
111 &quot;screens&quot;: [ # Full list of screens.
112 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 &quot;locale&quot;: &quot;A String&quot;, # Locale of the device that the screenshot was taken on.
114 # Required.
115 &quot;fileReference&quot;: &quot;A String&quot;, # File reference of the png file.
116 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700117 &quot;model&quot;: &quot;A String&quot;, # Model of the device that the screenshot was taken on.
118 # Required.
119 &quot;version&quot;: &quot;A String&quot;, # OS version of the device that the screenshot was taken on.
120 # Required.
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 },
122 ],
123 &quot;keyScreen&quot;: { # A singular screen that represents the cluster as a whole. This screen will
124 # act as the &quot;cover&quot; of the entire cluster. When users look at the clusters,
125 # only the key screen from each cluster will be shown. Which screen is the
126 # key screen is determined by the ClusteringAlgorithm
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;locale&quot;: &quot;A String&quot;, # Locale of the device that the screenshot was taken on.
128 # Required.
129 &quot;fileReference&quot;: &quot;A String&quot;, # File reference of the png file.
130 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700131 &quot;model&quot;: &quot;A String&quot;, # Model of the device that the screenshot was taken on.
132 # Required.
133 &quot;version&quot;: &quot;A String&quot;, # OS version of the device that the screenshot was taken on.
134 # Required.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 },
136 &quot;clusterId&quot;: &quot;A String&quot;, # A unique identifier for the cluster.
137 # @OutputOnly
138 }</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="list">list(projectId, historyId, executionId, x__xgafv=None)</code>
143 <pre>Lists Screenshot Clusters
144
145Returns the list of screenshot clusters corresponding to an execution.
146Screenshot clusters are created after the execution is finished.
147Clusters are created from a set of screenshots. Between any two
148screenshots, a matching score is calculated based off their metadata
149that determines how similar they are. Screenshots are placed
150in the cluster that has screens which have the highest matching
151scores.
152
153Args:
154 projectId: string, A Project id.
155
156Required. (required)
157 historyId: string, A History id.
158
159Required. (required)
160 executionId: string, An Execution id.
161
162Required. (required)
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
171 {
172 &quot;clusters&quot;: [ # The set of clusters associated with an execution
173 # Always set
174 {
175 &quot;activity&quot;: &quot;A String&quot;, # A string that describes the activity of every screen in the cluster.
176 &quot;screens&quot;: [ # Full list of screens.
177 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 &quot;locale&quot;: &quot;A String&quot;, # Locale of the device that the screenshot was taken on.
179 # Required.
180 &quot;fileReference&quot;: &quot;A String&quot;, # File reference of the png file.
181 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700182 &quot;model&quot;: &quot;A String&quot;, # Model of the device that the screenshot was taken on.
183 # Required.
184 &quot;version&quot;: &quot;A String&quot;, # OS version of the device that the screenshot was taken on.
185 # Required.
Bu Sun Kim65020912020-05-20 12:08:20 -0700186 },
187 ],
188 &quot;keyScreen&quot;: { # A singular screen that represents the cluster as a whole. This screen will
189 # act as the &quot;cover&quot; of the entire cluster. When users look at the clusters,
190 # only the key screen from each cluster will be shown. Which screen is the
191 # key screen is determined by the ClusteringAlgorithm
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 &quot;locale&quot;: &quot;A String&quot;, # Locale of the device that the screenshot was taken on.
193 # Required.
194 &quot;fileReference&quot;: &quot;A String&quot;, # File reference of the png file.
195 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700196 &quot;model&quot;: &quot;A String&quot;, # Model of the device that the screenshot was taken on.
197 # Required.
198 &quot;version&quot;: &quot;A String&quot;, # OS version of the device that the screenshot was taken on.
199 # Required.
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 },
201 &quot;clusterId&quot;: &quot;A String&quot;, # A unique identifier for the cluster.
202 # @OutputOnly
203 },
204 ],
205 }</pre>
206</div>
207
208</body></html>