blob: b7ae94a1efd92081675e5a8c61ffa796991138e3 [file] [log] [blame]
<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="securitycenter_v1.html">Security Command Center API</a> . <a href="securitycenter_v1.organizations.html">organizations</a> . <a href="securitycenter_v1.organizations.simulations.html">simulations</a> . <a href="securitycenter_v1.organizations.simulations.valuedResources.html">valuedResources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="securitycenter_v1.organizations.simulations.valuedResources.attackPaths.html">attackPaths()</a></code>
</p>
<p class="firstline">Returns the attackPaths Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get the valued resource by name</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the valued resources for a set of simulation results and filter.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get the valued resource by name
Args:
name: string, Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource that is determined to have value to a user&#x27;s system
&quot;displayName&quot;: &quot;A String&quot;, # Human-readable name of the valued resource.
&quot;exposedScore&quot;: 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.
&quot;name&quot;: &quot;A String&quot;, # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789`
&quot;resource&quot;: &quot;A String&quot;, # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource.
&quot;resourceType&quot;: &quot;A String&quot;, # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource.
&quot;resourceValue&quot;: &quot;A String&quot;, # How valuable this resource is.
&quot;resourceValueConfigsUsed&quot;: [ # List of resource value configurations&#x27; metadata used to determine the value of this resource. Maximum of 100.
{ # Metadata about a ResourceValueConfig. For example, id and name.
&quot;name&quot;: &quot;A String&quot;, # Resource value config name
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the valued resources for a set of simulation results and filter.
Args:
parent: string, Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` (required)
filter: string, The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =
orderBy: string, Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.
pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
pageToken: string, The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing the valued resources for a given simulation.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results.
&quot;totalSize&quot;: 42, # The estimated total number of results matching the query.
&quot;valuedResources&quot;: [ # The valued resources that the attack path simulation identified.
{ # A resource that is determined to have value to a user&#x27;s system
&quot;displayName&quot;: &quot;A String&quot;, # Human-readable name of the valued resource.
&quot;exposedScore&quot;: 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.
&quot;name&quot;: &quot;A String&quot;, # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789`
&quot;resource&quot;: &quot;A String&quot;, # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource.
&quot;resourceType&quot;: &quot;A String&quot;, # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource.
&quot;resourceValue&quot;: &quot;A String&quot;, # How valuable this resource is.
&quot;resourceValueConfigsUsed&quot;: [ # List of resource value configurations&#x27; metadata used to determine the value of this resource. Maximum of 100.
{ # Metadata about a ResourceValueConfig. For example, id and name.
&quot;name&quot;: &quot;A String&quot;, # Resource value config name
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>