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_v1beta3firstparty.html">Cloud Tool Results firstparty API</a> . <a href="toolresults_v1beta3firstparty.projects.html">projects</a> . <a href="toolresults_v1beta3firstparty.projects.histories.html">histories</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="toolresults_v1beta3firstparty.projects.histories.executions.html">executions()</a></code>
79</p>
80<p class="firstline">Returns the executions Resource.</p>
81
82<p class="toc_element">
83  <code><a href="#create">create(projectId, body, requestId=None)</a></code></p>
84<p class="firstline">Creates a History.</p>
85<p class="toc_element">
86  <code><a href="#get">get(projectId, historyId)</a></code></p>
87<p class="firstline">Gets a History.</p>
88<p class="toc_element">
89  <code><a href="#list">list(projectId, pageToken=None, pageSize=None, filterByName=None)</a></code></p>
90<p class="firstline">Lists Histories for a given Project.</p>
91<p class="toc_element">
92  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
96    <code class="details" id="create">create(projectId, body, requestId=None)</code>
97  <pre>Creates a History.
98
99The returned History will have the id set.
100
101May return any of the following canonical error codes:
102
103- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist
104
105Args:
106  projectId: string, A Project id.
107
108Required. (required)
109  body: object, The request body. (required)
110    The object takes the form of:
111
112{ # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
113      #
114      # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
115    "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
116        #
117        # - In response: present if set during create. - In create request: optional
118    "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
119        #
120        # - In response always set - In create request: always set
121    "historyId": "A String", # A unique identifier within a project for this History.
122        #
123        # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
124        #
125        # - In response always set - In create request: never set
126  }
127
128  requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID.
129
130Optional, but strongly recommended.
131
132Returns:
133  An object of the form:
134
135    { # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
136        #
137        # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
138      "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
139          #
140          # - In response: present if set during create. - In create request: optional
141      "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
142          #
143          # - In response always set - In create request: always set
144      "historyId": "A String", # A unique identifier within a project for this History.
145          #
146          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
147          #
148          # - In response always set - In create request: never set
149    }</pre>
150</div>
151
152<div class="method">
153    <code class="details" id="get">get(projectId, historyId)</code>
154  <pre>Gets a History.
155
156May return any of the following canonical error codes:
157
158- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist
159
160Args:
161  projectId: string, A Project id.
162
163Required. (required)
164  historyId: string, A History id.
165
166Required. (required)
167
168Returns:
169  An object of the form:
170
171    { # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
172        #
173        # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
174      "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
175          #
176          # - In response: present if set during create. - In create request: optional
177      "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
178          #
179          # - In response always set - In create request: always set
180      "historyId": "A String", # A unique identifier within a project for this History.
181          #
182          # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
183          #
184          # - In response always set - In create request: never set
185    }</pre>
186</div>
187
188<div class="method">
189    <code class="details" id="list">list(projectId, pageToken=None, pageSize=None, filterByName=None)</code>
190  <pre>Lists Histories for a given Project.
191
192The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time.
193
194May return any of the following canonical error codes:
195
196- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist
197
198Args:
199  projectId: string, A Project id.
200
201Required. (required)
202  pageToken: string, A continuation token to resume the query at the next item.
203
204Optional.
205  pageSize: integer, The maximum number of Histories to fetch.
206
207Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100.
208
209Optional.
210  filterByName: string, If set, only return histories with the given name.
211
212Optional.
213
214Returns:
215  An object of the form:
216
217    { # Response message for HistoryService.List
218    "nextPageToken": "A String", # A continuation token to resume the query at the next item.
219        #
220        # Will only be set if there are more histories to fetch.
221        #
222        # Tokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes.
223    "histories": [ # Histories.
224      { # A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build.
225            #
226            # Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.
227          "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters.
228              #
229              # - In response: present if set during create. - In create request: optional
230          "name": "A String", # A name to uniquely identify a history within a project. Maximum of 100 characters.
231              #
232              # - In response always set - In create request: always set
233          "historyId": "A String", # A unique identifier within a project for this History.
234              #
235              # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
236              #
237              # - In response always set - In create request: never set
238        },
239    ],
240  }</pre>
241</div>
242
243<div class="method">
244    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
245  <pre>Retrieves the next page of results.
246
247Args:
248  previous_request: The request for the previous page. (required)
249  previous_response: The response from the request for the previous page. (required)
250
251Returns:
252  A request object that you can call 'execute()' on to request the next
253  page. Returns None if there are no more items in the collection.
254    </pre>
255</div>
256
257</body></html>