Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / websecurityscanner_v1beta.projects.scanConfigs.scanRuns.crawledUrls.html
blob: bd337bff0ff4e660d8c6c97199ae84def42e894d [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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="websecurityscanner_v1beta.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1beta.projects.html">projects</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html">scanRuns</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.crawledUrls.html">crawledUrls</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]78 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">List CrawledUrls under a given ScanRun.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]85 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <pre>List CrawledUrls under a given ScanRun.
87
88Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]89 parent: string, Required. The parent resource name, which should be a scan run resource name in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91&#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 pageSize: integer, The maximum number of CrawledUrls to return, can be limited by server.
93If not specified or not positive, the implementation will select a
94reasonable value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]95 pageToken: string, A token identifying a page of results to be returned. This should be a
96`next_page_token` value returned from a previous List request.
97If unspecified, the first page of results is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102
103Returns:
104 An object of the form:
105
106 { # Response for the `ListCrawledUrls` method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]107 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
108 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;crawledUrls&quot;: [ # The list of CrawledUrls returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 { # A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web
111 # Security Scanner Service crawls the web applications, following all links
112 # within the scope of sites, to find the URLs to test against.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 &quot;body&quot;: &quot;A String&quot;, # The body of the request that was used to visit the URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;httpMethod&quot;: &quot;A String&quot;, # The http method of the request that was used to visit the URL, in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 # uppercase.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;url&quot;: &quot;A String&quot;, # The URL that was crawled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 },
118 ],
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
124 <pre>Retrieves the next page of results.
125
126Args:
127 previous_request: The request for the previous page. (required)
128 previous_response: The response from the request for the previous page. (required)
129
130Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 page. Returns None if there are no more items in the collection.
133 </pre>
134</div>
135
136</body></html>