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

blob: cbb984ed8dc0b368d5fa7e4a5c29aef023d05a86 [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_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></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="websecurityscanner_v1beta.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_v1beta.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_v1beta.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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	93	<code><a href="#close">close()</a></code></p>
				94	<p class="firstline">Close httplib2 connections.</p>
				95	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	96	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Gets a ScanRun.</p>
				98	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	99	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101	<p class="toc_element">
				102	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				103	<p class="firstline">Retrieves the next page of results.</p>
				104	<p class="toc_element">
				105	<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
				106	<p class="firstline">Stops a ScanRun. The stopped ScanRun is returned.</p>
				107	<h3>Method Details</h3>
				108	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<code class="details" id="close">close()</code>
				110	<pre>Close httplib2 connections.</pre>
				111	</div>
				112
				113	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	<code class="details" id="get">get(name, x__xgafv=None)</code>
				115	<pre>Gets a ScanRun.
				116
				117	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	118	name: string, Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	119	x__xgafv: string, V1 error format.
				120	Allowed values
				121	1 - v1 error format
				122	2 - v2 error format
				123
				124	Returns:
				125	An object of the form:
				126
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	127	{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	128	"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	129	"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
				130	"startTime": "A String", # The time at which the ScanRun started.
				131	"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	132	"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	133	"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
				134	"executionState": "A String", # The execution state of the ScanRun.
				135	"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
				136	"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
				137	"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
				138	"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
				139	"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
				140	"code": "A String", # Indicates the reason code for a configuration failure.
				141	},
				142	"code": "A String", # Indicates the error reason code.
				143	"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
				144	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	145	"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	146	{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	147	"code": "A String", # Indicates the warning code.
				148	},
				149	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	150	}</pre>
				151	</div>
				152
				153	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	154	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	155	<pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	156
				157	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	158	parent: string, Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	159	pageSize: integer, The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	160	pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	x__xgafv: string, V1 error format.
				162	Allowed values
				163	1 - v1 error format
				164	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	165
				166	Returns:
				167	An object of the form:
				168
				169	{ # Response for the `ListScanRuns` method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	"scanRuns": [ # The list of ScanRuns returned.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	171	{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	172	"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	173	"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
				174	"startTime": "A String", # The time at which the ScanRun started.
				175	"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	176	"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	177	"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
				178	"executionState": "A String", # The execution state of the ScanRun.
				179	"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
				180	"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
				181	"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
				182	"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
				183	"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
				184	"code": "A String", # Indicates the reason code for a configuration failure.
				185	},
				186	"code": "A String", # Indicates the error reason code.
				187	"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
				188	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	189	"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	190	{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	191	"code": "A String", # Indicates the warning code.
				192	},
				193	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	194	},
				195	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	196	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	197	}</pre>
				198	</div>
				199
				200	<div class="method">
				201	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				202	<pre>Retrieves the next page of results.
				203
				204	Args:
				205	previous_request: The request for the previous page. (required)
				206	previous_response: The response from the request for the previous page. (required)
				207
				208	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	209	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]	210	page. Returns None if there are no more items in the collection.
				211	</pre>
				212	</div>
				213
				214	<div class="method">
				215	<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
				216	<pre>Stops a ScanRun. The stopped ScanRun is returned.
				217
				218	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	219	name: string, Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	220	body: object, The request body.
				221	The object takes the form of:
				222
				223	{ # Request for the `StopScanRun` method.
				224	}
				225
				226	x__xgafv: string, V1 error format.
				227	Allowed values
				228	1 - v1 error format
				229	2 - v2 error format
				230
				231	Returns:
				232	An object of the form:
				233
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	234	{ # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	235	"urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	236	"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
				237	"startTime": "A String", # The time at which the ScanRun started.
				238	"name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	239	"progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	240	"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
				241	"executionState": "A String", # The execution state of the ScanRun.
				242	"urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
				243	"resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
				244	"errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
				245	"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
				246	"fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
				247	"code": "A String", # Indicates the reason code for a configuration failure.
				248	},
				249	"code": "A String", # Indicates the error reason code.
				250	"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
				251	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	252	"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	253	{ # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	254	"code": "A String", # Indicates the warning code.
				255	},
				256	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	257	}</pre>
				258	</div>
				259
				260	</body></html>