1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="checks_v1alpha.html">Checks API</a> . <a href="checks_v1alpha.accounts.html">accounts</a> . <a href="checks_v1alpha.accounts.repos.html">repos</a> . <a href="checks_v1alpha.accounts.repos.scans.html">scans</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#generate">generate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists repo scans for the specified repo.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="generate">generate(parent, body=None, x__xgafv=None)</code>
<pre>Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.
Args:
parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
body: object, The request body.
The object takes the form of:
{ # The request message for RepoScanService.GenerateScan.
"cliAnalysis": { # The results of a Code Compliance CLI analysis. # Required. CLI analysis results.
"codeScans": [ # Optional. Requested code scans resulting from preliminary CLI analysis.
{ # A requested analysis of source code. Contains the source code and processing state.
"dataTypeClassifications": [ # Optional. Data type classification requests.
{ # A request to classify data types.
"dataType": "A String", # Required. Candidate data type.
"lineNumber": 42, # Required. Line number (1-based).
},
],
"sourceCode": { # Contains source code from a repo. # Required. Source code to analyze.
"code": "A String", # Required. Source code.
"endLine": 42, # Required. End line number (1-based).
"path": "A String", # Required. Path of the file.
"startLine": 42, # Required. Start line number (1-based).
},
},
],
"sources": [ # Optional. Data sources detected in the scan.
{ # Represents a data source finding.
"codeAttribution": { # Source code attribution. # Optional. Source code attribution for the finding.
"codeExcerpt": "A String", # Optional. Code excerpt where the source was detected along with surrounding code.
"lineNumber": 42, # Required. Line number (1-based).
"path": "A String", # Required. Path of the file.
"startLineNumber": 42, # Optional. Start line number of the code excerpt (1-based).
},
"dataType": "A String", # Required. Data type.
"falsePositive": True or False, # Optional. Whether the finding was marked as a false positive.
},
],
},
"cliVersion": "A String", # Required. CLI version.
"localScanPath": "A String", # Required. Local scan path.
"scmMetadata": { # SCM metadata. # Required. SCM metadata.
"branch": "A String", # Required. Branch name.
"pullRequest": { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
"baseBranch": "A String", # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
"prNumber": "A String", # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
},
"remoteUri": "A String", # Required. Git remote URL.
"revisionId": "A String", # Required. Revision ID, e.g. Git commit hash.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.
Args:
name: string, Required. Resource name of the repo scan. Example: `accounts/123/repos/456/scans/789` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Repo scan.
"cliVersion": "A String", # CLI version.
"localScanPath": "A String", # Local scan path.
"name": "A String", # Identifier. Resource name of the scan.
"resultsUri": "A String", # A URL to view results.
"scmMetadata": { # SCM metadata. # SCM metadata.
"branch": "A String", # Required. Branch name.
"pullRequest": { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
"baseBranch": "A String", # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
"prNumber": "A String", # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
},
"remoteUri": "A String", # Required. Git remote URL.
"revisionId": "A String", # Required. Revision ID, e.g. Git commit hash.
},
"sources": [ # Data sources detected.
{ # Represents a data source finding.
"codeAttribution": { # Source code attribution. # Optional. Source code attribution for the finding.
"codeExcerpt": "A String", # Optional. Code excerpt where the source was detected along with surrounding code.
"lineNumber": 42, # Required. Line number (1-based).
"path": "A String", # Required. Path of the file.
"startLineNumber": 42, # Optional. Start line number of the code excerpt (1-based).
},
"dataType": "A String", # Required. Data type.
"falsePositive": True or False, # Optional. Whether the finding was marked as a false positive.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists repo scans for the specified repo.
Args:
parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter repo scans. Example: `scmMetadata.branch = main`
pageSize: integer, Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken: string, Optional. A page token received from a previous `ListRepoScans` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepoScans` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for RepoScanService.ListRepoScans.
"nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"repoScans": [ # The repo scans for the specified app.
{ # Repo scan.
"cliVersion": "A String", # CLI version.
"localScanPath": "A String", # Local scan path.
"name": "A String", # Identifier. Resource name of the scan.
"resultsUri": "A String", # A URL to view results.
"scmMetadata": { # SCM metadata. # SCM metadata.
"branch": "A String", # Required. Branch name.
"pullRequest": { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
"baseBranch": "A String", # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
"prNumber": "A String", # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
},
"remoteUri": "A String", # Required. Git remote URL.
"revisionId": "A String", # Required. Revision ID, e.g. Git commit hash.
},
"sources": [ # Data sources detected.
{ # Represents a data source finding.
"codeAttribution": { # Source code attribution. # Optional. Source code attribution for the finding.
"codeExcerpt": "A String", # Optional. Code excerpt where the source was detected along with surrounding code.
"lineNumber": 42, # Required. Line number (1-based).
"path": "A String", # Required. Path of the file.
"startLineNumber": 42, # Optional. Start line number of the code excerpt (1-based).
},
"dataType": "A String", # Required. Data type.
"falsePositive": True or False, # Optional. Whether the finding was marked as a false positive.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
