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

blob: bd055ebf680bc5f631af16fee48fbfde290aaea2 [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="containeranalysis_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.projects.html">projects</a> . <a href="containeranalysis_v1alpha1.projects.scanConfigs.html">scanConfigs</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Gets a specific scan configuration for a project.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Lists scan configurations for a project.</p>
				83	<p class="toc_element">
				84	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Updates the scan configuration to a new value.</p>
				89	<h3>Method Details</h3>
				90	<div class="method">
				91	<code class="details" id="get">get(name, x__xgafv=None)</code>
				92	<pre>Gets a specific scan configuration for a project.
				93
				94	Args:
				95	name: string, The name of the ScanConfig in the form
				96	projects/{project_id}/scanConfigs/{scan_config_id} (required)
				97	x__xgafv: string, V1 error format.
				98	Allowed values
				99	1 - v1 error format
				100	2 - v2 error format
				101
				102	Returns:
				103	An object of the form:
				104
				105	{ # Indicates various scans and whether they are turned on or off.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	"name": "A String", # Output only. The name of the ScanConfig in the form
				107	# “projects/{project_id}/scanConfigs/{scan_config_id}".
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	108	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	109	"updateTime": "A String", # Output only. The time this scan config was last updated.
				110	"enabled": True or False, # Indicates whether the Scan is enabled.
				111	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	112	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	</div>
				114
				115	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	116	<code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	<pre>Lists scan configurations for a project.
				118
				119	Args:
				120	parent: string, This containers the project Id i.e.: projects/{project_id} (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	121	filter: string, The filter expression.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	pageToken: string, The page token to use for the next request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	123	pageSize: integer, The number of items to return.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	x__xgafv: string, V1 error format.
				125	Allowed values
				126	1 - v1 error format
				127	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	128
				129	Returns:
				130	An object of the form:
				131
				132	{ # A list of scan configs for the project.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	133	"scanConfigs": [ # The set of scan configs.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	134	{ # Indicates various scans and whether they are turned on or off.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	135	"name": "A String", # Output only. The name of the ScanConfig in the form
				136	# “projects/{project_id}/scanConfigs/{scan_config_id}".
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	138	"updateTime": "A String", # Output only. The time this scan config was last updated.
				139	"enabled": True or False, # Indicates whether the Scan is enabled.
				140	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	142	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	143	"nextPageToken": "A String", # A page token to pass in order to get more scan configs.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	144	}</pre>
				145	</div>
				146
				147	<div class="method">
				148	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				149	<pre>Retrieves the next page of results.
				150
				151	Args:
				152	previous_request: The request for the previous page. (required)
				153	previous_response: The response from the request for the previous page. (required)
				154
				155	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	156	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]	157	page. Returns None if there are no more items in the collection.
				158	</pre>
				159	</div>
				160
				161	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	162	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	163	<pre>Updates the scan configuration to a new value.
				164
				165	Args:
				166	name: string, The scan config to update of the form
				167	projects/{project_id}/scanConfigs/{scan_config_id}. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	168	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	169	The object takes the form of:
				170
				171	{ # Indicates various scans and whether they are turned on or off.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	"name": "A String", # Output only. The name of the ScanConfig in the form
				173	# “projects/{project_id}/scanConfigs/{scan_config_id}".
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	174	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	175	"updateTime": "A String", # Output only. The time this scan config was last updated.
				176	"enabled": True or False, # Indicates whether the Scan is enabled.
				177	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	179
				180	updateMask: string, The fields to update.
				181	x__xgafv: string, V1 error format.
				182	Allowed values
				183	1 - v1 error format
				184	2 - v2 error format
				185
				186	Returns:
				187	An object of the form:
				188
				189	{ # Indicates various scans and whether they are turned on or off.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	190	"name": "A String", # Output only. The name of the ScanConfig in the form
				191	# “projects/{project_id}/scanConfigs/{scan_config_id}".
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	192	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	193	"updateTime": "A String", # Output only. The time this scan config was last updated.
				194	"enabled": True or False, # Indicates whether the Scan is enabled.
				195	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	196	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	197	</div>
				198
				199	</body></html>