docs/dyn/containeranalysis_v1alpha1.projects.scanConfigs.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <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>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets a specific scan configuration for a project.</p>
 <p class="toc_element">
   <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
 <p class="firstline">Lists scan configurations for a project.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <p class="toc_element">
   <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Updates the scan configuration to a new value.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>Gets a specific scan configuration for a project.

 Args:
   name: string, The name of the ScanConfig in the form
 projects/{project_id}/scanConfigs/{scan_config_id} (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Indicates various scans and whether they are turned on or off.
       "updateTime": "A String", # Output only. The time this scan config was last updated.
       "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
       "enabled": True or False, # Indicates whether the Scan is enabled.
       "createTime": "A String", # Output only. The time this scan config was created.
       "name": "A String", # Output only. The name of the ScanConfig in the form
           # “projects/{project_id}/scanConfigs/{scan_config_id}".
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
   <pre>Lists scan configurations for a project.

 Args:
   parent: string, This containers the project Id i.e.: projects/{project_id} (required)
   pageSize: integer, The number of items to return.
   pageToken: string, The page token to use for the next request.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
   filter: string, The filter expression.

 Returns:
   An object of the form:

     { # A list of scan configs for the project.
     "nextPageToken": "A String", # A page token to pass in order to get more scan configs.
     "scanConfigs": [ # The set of scan configs.
       { # Indicates various scans and whether they are turned on or off.
           "updateTime": "A String", # Output only. The time this scan config was last updated.
           "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
           "enabled": True or False, # Indicates whether the Scan is enabled.
           "createTime": "A String", # Output only. The time this scan config was created.
           "name": "A String", # Output only. The name of the ScanConfig in the form
               # “projects/{project_id}/scanConfigs/{scan_config_id}".
         },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 <div class="method">
     <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
   <pre>Updates the scan configuration to a new value.

 Args:
   name: string, The scan config to update of the form
 projects/{project_id}/scanConfigs/{scan_config_id}. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Indicates various scans and whether they are turned on or off.
     "updateTime": "A String", # Output only. The time this scan config was last updated.
     "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
     "enabled": True or False, # Indicates whether the Scan is enabled.
     "createTime": "A String", # Output only. The time this scan config was created.
     "name": "A String", # Output only. The name of the ScanConfig in the form
         # “projects/{project_id}/scanConfigs/{scan_config_id}".
   }

   updateMask: string, The fields to update.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Indicates various scans and whether they are turned on or off.
       "updateTime": "A String", # Output only. The time this scan config was last updated.
       "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
       "enabled": True or False, # Indicates whether the Scan is enabled.
       "createTime": "A String", # Output only. The time this scan config was created.
       "name": "A String", # Output only. The name of the ScanConfig in the form
           # “projects/{project_id}/scanConfigs/{scan_config_id}".
     }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<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>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Gets a specific scan configuration for a project.</p>
	<p class="toc_element">
	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
	<p class="firstline">Lists scan configurations for a project.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<p class="toc_element">
	<code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Updates the scan configuration to a new value.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="get">get(name, x__xgafv=None)</code>
	<pre>Gets a specific scan configuration for a project.

	Args:
	name: string, The name of the ScanConfig in the form
	projects/{project_id}/scanConfigs/{scan_config_id} (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Indicates various scans and whether they are turned on or off.
	"updateTime": "A String", # Output only. The time this scan config was last updated.
	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
	"enabled": True or False, # Indicates whether the Scan is enabled.
	"createTime": "A String", # Output only. The time this scan config was created.
	"name": "A String", # Output only. The name of the ScanConfig in the form
	# “projects/{project_id}/scanConfigs/{scan_config_id}".
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
	<pre>Lists scan configurations for a project.

	Args:
	parent: string, This containers the project Id i.e.: projects/{project_id} (required)
	pageSize: integer, The number of items to return.
	pageToken: string, The page token to use for the next request.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format
	filter: string, The filter expression.

	Returns:
	An object of the form:

	{ # A list of scan configs for the project.
	"nextPageToken": "A String", # A page token to pass in order to get more scan configs.
	"scanConfigs": [ # The set of scan configs.
	{ # Indicates various scans and whether they are turned on or off.
	"updateTime": "A String", # Output only. The time this scan config was last updated.
	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
	"enabled": True or False, # Indicates whether the Scan is enabled.
	"createTime": "A String", # Output only. The time this scan config was created.
	"name": "A String", # Output only. The name of the ScanConfig in the form
	# “projects/{project_id}/scanConfigs/{scan_config_id}".
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>Retrieves the next page of results.

	Args:
	previous_request: The request for the previous page. (required)
	previous_response: The response from the request for the previous page. (required)

	Returns:
	A request object that you can call 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	<div class="method">
	<code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
	<pre>Updates the scan configuration to a new value.

	Args:
	name: string, The scan config to update of the form
	projects/{project_id}/scanConfigs/{scan_config_id}. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Indicates various scans and whether they are turned on or off.
	"updateTime": "A String", # Output only. The time this scan config was last updated.
	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
	"enabled": True or False, # Indicates whether the Scan is enabled.
	"createTime": "A String", # Output only. The time this scan config was created.
	"name": "A String", # Output only. The name of the ScanConfig in the form
	# “projects/{project_id}/scanConfigs/{scan_config_id}".
	}

	updateMask: string, The fields to update.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Indicates various scans and whether they are turned on or off.
	"updateTime": "A String", # Output only. The time this scan config was last updated.
	"description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
	"enabled": True or False, # Indicates whether the Scan is enabled.
	"createTime": "A String", # Output only. The time this scan config was created.
	"name": "A String", # Output only. The name of the ScanConfig in the form
	# “projects/{project_id}/scanConfigs/{scan_config_id}".
	}</pre>
	</div>

	</body></html>