Blame - docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html - platform/external/python/google-api-python-client

blob: 352aabce3e328b62ccf20e27a6737c0defe219df [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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_v1alpha.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1alpha.projects.html">projects</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html">scanRuns</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.crawledUrls.html">crawledUrls()</a></code>
				79	</p>
				80	<p class="firstline">Returns the crawledUrls Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findingTypeStats.html">findingTypeStats()</a></code>
				84	</p>
				85	<p class="firstline">Returns the findingTypeStats Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html">findings()</a></code>
				89	</p>
				90	<p class="firstline">Returns the findings Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Gets a ScanRun.</p>
				95	<p class="toc_element">
				96	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun</p>
				98	<p class="toc_element">
				99	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				100	<p class="firstline">Retrieves the next page of results.</p>
				101	<p class="toc_element">
				102	<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
				103	<p class="firstline">Stops a ScanRun. The stopped ScanRun is returned.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
				106	<code class="details" id="get">get(name, x__xgafv=None)</code>
				107	<pre>Gets a ScanRun.
				108
				109	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	110	name: string, Required. The resource name of the ScanRun to be returned. The name follows the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	format of
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	112	'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	x__xgafv: string, V1 error format.
				114	Allowed values
				115	1 - v1 error format
				116	2 - v2 error format
				117
				118	Returns:
				119	An object of the form:
				120
				121	{ # A ScanRun is a output-only resource representing an actual run of the scan.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	122	"progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	123	# If the scan is in queue, the value is 0.
				124	# If the scan is running, the value ranges from 0 to 100.
				125	# If the scan is finished, the value is 100.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	126	"executionState": "A String", # The execution state of the ScanRun.
				127	"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	128	# is either finished or stopped by user.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	129	"startTime": "A String", # The time at which the ScanRun started.
				130	"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
				131	# the value represents the number of URLs crawled up to now.
				132	"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
				133	"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
				134	# the value represents the number of URLs tested up to now. The number of
				135	# URLs tested is usually larger than the number URLS crawled because
				136	# typically a crawled URL is tested with multiple test payloads.
				137	"resultState": "A String", # The result state of the ScanRun. This field is only available after the
				138	# execution state reaches "FINISHED".
				139	"name": "A String", # The resource name of the ScanRun. The name follows the format of
				140	# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
				141	# The ScanRun IDs are generated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	142	}</pre>
				143	</div>
				144
				145	<div class="method">
				146	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
				147	<pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
				148	stop time.
				149
				150	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	151	parent: string, Required. The parent resource name, which should be a scan resource name in the
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	152	format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	153	pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
				154	If not specified or not positive, the implementation will select a
				155	reasonable value.
				156	pageToken: string, A token identifying a page of results to be returned. This should be a
				157	`next_page_token` value returned from a previous List request.
				158	If unspecified, the first page of results is returned.
				159	x__xgafv: string, V1 error format.
				160	Allowed values
				161	1 - v1 error format
				162	2 - v2 error format
				163
				164	Returns:
				165	An object of the form:
				166
				167	{ # Response for the `ListScanRuns` method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	169	# more results in the list.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	"scanRuns": [ # The list of ScanRuns returned.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	171	{ # A ScanRun is a output-only resource representing an actual run of the scan.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	"progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	173	# If the scan is in queue, the value is 0.
				174	# If the scan is running, the value ranges from 0 to 100.
				175	# If the scan is finished, the value is 100.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	176	"executionState": "A String", # The execution state of the ScanRun.
				177	"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	178	# is either finished or stopped by user.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	179	"startTime": "A String", # The time at which the ScanRun started.
				180	"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
				181	# the value represents the number of URLs crawled up to now.
				182	"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
				183	"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
				184	# the value represents the number of URLs tested up to now. The number of
				185	# URLs tested is usually larger than the number URLS crawled because
				186	# typically a crawled URL is tested with multiple test payloads.
				187	"resultState": "A String", # The result state of the ScanRun. This field is only available after the
				188	# execution state reaches "FINISHED".
				189	"name": "A String", # The resource name of the ScanRun. The name follows the format of
				190	# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
				191	# The ScanRun IDs are generated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	192	},
				193	],
				194	}</pre>
				195	</div>
				196
				197	<div class="method">
				198	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				199	<pre>Retrieves the next page of results.
				200
				201	Args:
				202	previous_request: The request for the previous page. (required)
				203	previous_response: The response from the request for the previous page. (required)
				204
				205	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	207	page. Returns None if there are no more items in the collection.
				208	</pre>
				209	</div>
				210
				211	<div class="method">
				212	<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
				213	<pre>Stops a ScanRun. The stopped ScanRun is returned.
				214
				215	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	216	name: string, Required. The resource name of the ScanRun to be stopped. The name follows the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	217	format of
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	218	'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	219	body: object, The request body.
				220	The object takes the form of:
				221
				222	{ # Request for the `StopScanRun` method.
				223	}
				224
				225	x__xgafv: string, V1 error format.
				226	Allowed values
				227	1 - v1 error format
				228	2 - v2 error format
				229
				230	Returns:
				231	An object of the form:
				232
				233	{ # A ScanRun is a output-only resource representing an actual run of the scan.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	234	"progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	235	# If the scan is in queue, the value is 0.
				236	# If the scan is running, the value ranges from 0 to 100.
				237	# If the scan is finished, the value is 100.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	238	"executionState": "A String", # The execution state of the ScanRun.
				239	"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	240	# is either finished or stopped by user.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	241	"startTime": "A String", # The time at which the ScanRun started.
				242	"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
				243	# the value represents the number of URLs crawled up to now.
				244	"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
				245	"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
				246	# the value represents the number of URLs tested up to now. The number of
				247	# URLs tested is usually larger than the number URLS crawled because
				248	# typically a crawled URL is tested with multiple test payloads.
				249	"resultState": "A String", # The result state of the ScanRun. This field is only available after the
				250	# execution state reaches "FINISHED".
				251	"name": "A String", # The resource name of the ScanRun. The name follows the format of
				252	# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
				253	# The ScanRun IDs are generated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	254	}</pre>
				255	</div>
				256
				257	</body></html>