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

blob: 2c73b6d4d34f4f74fdc3f2b6ea220a94975d3ce4 [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_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.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 the specified scan configuration.</p>
				80	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -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 the specified 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="#update">update(name, body=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 specified scan configuration.</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 the specified scan configuration.
				93
				94	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	95	name: string, Required. The name of the scan configuration in the form of
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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	{ # A scan configuration specifies whether Cloud components in a project have a
				106	# particular type of analysis being run. For example, it can configure whether
				107	# vulnerability scanning is being done on Docker images or not.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	108	"updateTime": "A String", # Output only. The time this scan config was last updated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	109	"description": "A String", # Output only. A human-readable description of what the scan configuration
				110	# does.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	111	"name": "A String", # Output only. The name of the scan configuration in the form of
				112	# `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	"enabled": True or False, # Whether the scan is enabled.
				114	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	115	}</pre>
				116	</div>
				117
				118	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	119	<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]	120	<pre>Lists scan configurations for the specified project.
				121
				122	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	123	parent: string, Required. The name of the project to list scan configurations for in the form of
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	`projects/[PROJECT_ID]`. (required)
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	125	filter: string, Required. The filter expression.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	126	pageToken: string, Token to provide to skip to a particular spot in the list.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	127	pageSize: integer, The number of scan configs to return in the list.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132
				133	Returns:
				134	An object of the form:
				135
				136	{ # Response for listing scan configurations.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	"scanConfigs": [ # The scan configurations requested.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	138	{ # A scan configuration specifies whether Cloud components in a project have a
				139	# particular type of analysis being run. For example, it can configure whether
				140	# vulnerability scanning is being done on Docker images or not.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	141	"updateTime": "A String", # Output only. The time this scan config was last updated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	"description": "A String", # Output only. A human-readable description of what the scan configuration
				143	# does.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	144	"name": "A String", # Output only. The name of the scan configuration in the form of
				145	# `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	146	"enabled": True or False, # Whether the scan is enabled.
				147	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148	},
				149	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	150	"nextPageToken": "A String", # The next pagination token in the list response. It should be used as
				151	# `page_token` for the following request. An empty value means no more
				152	# results.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	153	}</pre>
				154	</div>
				155
				156	<div class="method">
				157	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				158	<pre>Retrieves the next page of results.
				159
				160	Args:
				161	previous_request: The request for the previous page. (required)
				162	previous_response: The response from the request for the previous page. (required)
				163
				164	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	165	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]	166	page. Returns None if there are no more items in the collection.
				167	</pre>
				168	</div>
				169
				170	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	171	<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	<pre>Updates the specified scan configuration.
				173
				174	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	175	name: string, Required. The name of the scan configuration in the form of
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	176	`projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	177	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	178	The object takes the form of:
				179
				180	{ # A scan configuration specifies whether Cloud components in a project have a
				181	# particular type of analysis being run. For example, it can configure whether
				182	# vulnerability scanning is being done on Docker images or not.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	183	"updateTime": "A String", # Output only. The time this scan config was last updated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	184	"description": "A String", # Output only. A human-readable description of what the scan configuration
				185	# does.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	186	"name": "A String", # Output only. The name of the scan configuration in the form of
				187	# `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	188	"enabled": True or False, # Whether the scan is enabled.
				189	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	190	}
				191
				192	x__xgafv: string, V1 error format.
				193	Allowed values
				194	1 - v1 error format
				195	2 - v2 error format
				196
				197	Returns:
				198	An object of the form:
				199
				200	{ # A scan configuration specifies whether Cloud components in a project have a
				201	# particular type of analysis being run. For example, it can configure whether
				202	# vulnerability scanning is being done on Docker images or not.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	203	"updateTime": "A String", # Output only. The time this scan config was last updated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	"description": "A String", # Output only. A human-readable description of what the scan configuration
				205	# does.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	206	"name": "A String", # Output only. The name of the scan configuration in the form of
				207	# `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	"enabled": True or False, # Whether the scan is enabled.
				209	"createTime": "A String", # Output only. The time this scan config was created.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	210	}</pre>
				211	</div>
				212
				213	</body></html>