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