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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="toolresults_v1beta3.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="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(projectId, body=None, requestId=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - 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</p> 88<p class="toc_element"> 89 <code><a href="#get">get(projectId, historyId, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets a History. May return any of the following canonical error codes: - 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</p> 91<p class="toc_element"> 92 <code><a href="#list">list(projectId, filterByName=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Lists Histories for a given Project. The 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. May return any of the following canonical error codes: - 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</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<h3>Method Details</h3> 98<div class="method"> 99 <code class="details" id="close">close()</code> 100 <pre>Close httplib2 connections.</pre> 101</div> 102 103<div class="method"> 104 <code class="details" id="create">create(projectId, body=None, requestId=None, x__xgafv=None)</code> 105 <pre>Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - 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 106 107Args: 108 projectId: string, A Project id. Required. (required) 109 body: object, The request body. 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. 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. 113 "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional 114 "historyId": "A String", # A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set 115 "name": "A String", # A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set 116 "testPlatform": "A String", # The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown. 117} 118 119 requestId: string, A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124 125Returns: 126 An object of the form: 127 128 { # 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. 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. 129 "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional 130 "historyId": "A String", # A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set 131 "name": "A String", # A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set 132 "testPlatform": "A String", # The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown. 133}</pre> 134</div> 135 136<div class="method"> 137 <code class="details" id="get">get(projectId, historyId, x__xgafv=None)</code> 138 <pre>Gets a History. May return any of the following canonical error codes: - 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 139 140Args: 141 projectId: string, A Project id. Required. (required) 142 historyId: string, A History id. Required. (required) 143 x__xgafv: string, V1 error format. 144 Allowed values 145 1 - v1 error format 146 2 - v2 error format 147 148Returns: 149 An object of the form: 150 151 { # 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. 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. 152 "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional 153 "historyId": "A String", # A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set 154 "name": "A String", # A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set 155 "testPlatform": "A String", # The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown. 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="list">list(projectId, filterByName=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 161 <pre>Lists Histories for a given Project. The 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. May return any of the following canonical error codes: - 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 162 163Args: 164 projectId: string, A Project id. Required. (required) 165 filterByName: string, If set, only return histories with the given name. Optional. 166 pageSize: integer, The maximum number of Histories to fetch. Default 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. Optional. 167 pageToken: string, A continuation token to resume the query at the next item. Optional. 168 x__xgafv: string, V1 error format. 169 Allowed values 170 1 - v1 error format 171 2 - v2 error format 172 173Returns: 174 An object of the form: 175 176 { # Response message for HistoryService.List 177 "histories": [ # Histories. 178 { # 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. 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. 179 "displayName": "A String", # A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional 180 "historyId": "A String", # A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set 181 "name": "A String", # A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set 182 "testPlatform": "A String", # The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown. 183 }, 184 ], 185 "nextPageToken": "A String", # A continuation token to resume the query at the next item. Will only be set if there are more histories to fetch. 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. 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 191 <pre>Retrieves the next page of results. 192 193Args: 194 previous_request: The request for the previous page. (required) 195 previous_response: The response from the request for the previous page. (required) 196 197Returns: 198 A request object that you can call 'execute()' on to request the next 199 page. Returns None if there are no more items in the collection. 200 </pre> 201</div> 202 203</body></html>