blob: c9caf0321c126debf7ba00b8bddd46c5a3d3808e [file] [edit]
<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.resourceValueConfigs.html">resourceValueConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.</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="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a ResourceValueConfig.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a ResourceValueConfig.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all ResourceValueConfigs.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing ResourceValueConfigs with new rules.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
<pre>Creates a ResourceValueConfig for an organization. Maps user&#x27;s tags to difference resource values for use by the attack path simulation.
Args:
parent: string, Required. Resource name of the new ResourceValueConfig&#x27;s parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message to create multiple resource value configs
&quot;requests&quot;: [ # Required. The resource value configs to be created.
{ # Request message to create single resource value config
&quot;parent&quot;: &quot;A String&quot;, # Required. Resource name of the new ResourceValueConfig&#x27;s parent.
&quot;resourceValueConfig&quot;: { # A resource value config (RVC) is a mapping configuration of user&#x27;s resources to resource values. Used in Attack path simulations. # Required. The resource value config being created.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was created.
&quot;description&quot;: &quot;A String&quot;, # Description of the resource value config.
&quot;name&quot;: &quot;A String&quot;, # Name for the resource value config
&quot;resourceLabelsSelector&quot;: { # List of resource labels to search for, evaluated with AND. E.g. &quot;resource_labels_selector&quot;: {&quot;key&quot;: &quot;value&quot;, &quot;env&quot;: &quot;prod&quot;} will match resources with labels &quot;key&quot;: &quot;value&quot; AND &quot;env&quot;: &quot;prod&quot; https://cloud.google.com/resource-manager/docs/creating-managing-labels
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;resourceType&quot;: &quot;A String&quot;, # Apply resource_value only to resources that match resource_type. resource_type will be checked with &quot;AND&quot; of other resources. E.g. &quot;storage.googleapis.com/Bucket&quot; with resource_value &quot;HIGH&quot; will apply &quot;HIGH&quot; value only to &quot;storage.googleapis.com/Bucket&quot; resources.
&quot;resourceValue&quot;: &quot;A String&quot;, # Required. Resource value level this expression represents
&quot;scope&quot;: &quot;A String&quot;, # Project or folder to scope this config to. For example, &quot;project/456&quot; would apply this config only to resources in &quot;project/456&quot; scope will be checked with &quot;AND&quot; of other resources.
&quot;tagValues&quot;: [ # Required. Tag values combined with AND to check against. Values in the form &quot;tagValues/123&quot; E.g. [ &quot;tagValues/123&quot;, &quot;tagValues/456&quot;, &quot;tagValues/789&quot; ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was last updated.
},
},
],
}
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 BatchCreateResourceValueConfigs
&quot;resourceValueConfigs&quot;: [ # The resource value configs created
{ # A resource value config (RVC) is a mapping configuration of user&#x27;s resources to resource values. Used in Attack path simulations.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was created.
&quot;description&quot;: &quot;A String&quot;, # Description of the resource value config.
&quot;name&quot;: &quot;A String&quot;, # Name for the resource value config
&quot;resourceLabelsSelector&quot;: { # List of resource labels to search for, evaluated with AND. E.g. &quot;resource_labels_selector&quot;: {&quot;key&quot;: &quot;value&quot;, &quot;env&quot;: &quot;prod&quot;} will match resources with labels &quot;key&quot;: &quot;value&quot; AND &quot;env&quot;: &quot;prod&quot; https://cloud.google.com/resource-manager/docs/creating-managing-labels
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;resourceType&quot;: &quot;A String&quot;, # Apply resource_value only to resources that match resource_type. resource_type will be checked with &quot;AND&quot; of other resources. E.g. &quot;storage.googleapis.com/Bucket&quot; with resource_value &quot;HIGH&quot; will apply &quot;HIGH&quot; value only to &quot;storage.googleapis.com/Bucket&quot; resources.
&quot;resourceValue&quot;: &quot;A String&quot;, # Required. Resource value level this expression represents
&quot;scope&quot;: &quot;A String&quot;, # Project or folder to scope this config to. For example, &quot;project/456&quot; would apply this config only to resources in &quot;project/456&quot; scope will be checked with &quot;AND&quot; of other resources.
&quot;tagValues&quot;: [ # Required. Tag values combined with AND to check against. Values in the form &quot;tagValues/123&quot; E.g. [ &quot;tagValues/123&quot;, &quot;tagValues/456&quot;, &quot;tagValues/789&quot; ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a ResourceValueConfig.
Args:
name: string, Required. Name of the ResourceValueConfig to delete (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a ResourceValueConfig.
Args:
name: string, Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{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:
{ # A resource value config (RVC) is a mapping configuration of user&#x27;s resources to resource values. Used in Attack path simulations.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was created.
&quot;description&quot;: &quot;A String&quot;, # Description of the resource value config.
&quot;name&quot;: &quot;A String&quot;, # Name for the resource value config
&quot;resourceLabelsSelector&quot;: { # List of resource labels to search for, evaluated with AND. E.g. &quot;resource_labels_selector&quot;: {&quot;key&quot;: &quot;value&quot;, &quot;env&quot;: &quot;prod&quot;} will match resources with labels &quot;key&quot;: &quot;value&quot; AND &quot;env&quot;: &quot;prod&quot; https://cloud.google.com/resource-manager/docs/creating-managing-labels
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;resourceType&quot;: &quot;A String&quot;, # Apply resource_value only to resources that match resource_type. resource_type will be checked with &quot;AND&quot; of other resources. E.g. &quot;storage.googleapis.com/Bucket&quot; with resource_value &quot;HIGH&quot; will apply &quot;HIGH&quot; value only to &quot;storage.googleapis.com/Bucket&quot; resources.
&quot;resourceValue&quot;: &quot;A String&quot;, # Required. Resource value level this expression represents
&quot;scope&quot;: &quot;A String&quot;, # Project or folder to scope this config to. For example, &quot;project/456&quot; would apply this config only to resources in &quot;project/456&quot; scope will be checked with &quot;AND&quot; of other resources.
&quot;tagValues&quot;: [ # Required. Tag values combined with AND to check against. Values in the form &quot;tagValues/123&quot; E.g. [ &quot;tagValues/123&quot;, &quot;tagValues/456&quot;, &quot;tagValues/789&quot; ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all ResourceValueConfigs.
Args:
parent: string, Required. The parent, which owns the collection of resource value configs. Its format is &quot;organizations/[organization_id]&quot; (required)
pageSize: integer, The number of results to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListResourceValueConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceValueConfigs` must match the call that provided the page token. page_size can be specified, and the new page_size will be used.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message to list resource value configs
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
&quot;resourceValueConfigs&quot;: [ # The resource value configs from the specified parent.
{ # A resource value config (RVC) is a mapping configuration of user&#x27;s resources to resource values. Used in Attack path simulations.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was created.
&quot;description&quot;: &quot;A String&quot;, # Description of the resource value config.
&quot;name&quot;: &quot;A String&quot;, # Name for the resource value config
&quot;resourceLabelsSelector&quot;: { # List of resource labels to search for, evaluated with AND. E.g. &quot;resource_labels_selector&quot;: {&quot;key&quot;: &quot;value&quot;, &quot;env&quot;: &quot;prod&quot;} will match resources with labels &quot;key&quot;: &quot;value&quot; AND &quot;env&quot;: &quot;prod&quot; https://cloud.google.com/resource-manager/docs/creating-managing-labels
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;resourceType&quot;: &quot;A String&quot;, # Apply resource_value only to resources that match resource_type. resource_type will be checked with &quot;AND&quot; of other resources. E.g. &quot;storage.googleapis.com/Bucket&quot; with resource_value &quot;HIGH&quot; will apply &quot;HIGH&quot; value only to &quot;storage.googleapis.com/Bucket&quot; resources.
&quot;resourceValue&quot;: &quot;A String&quot;, # Required. Resource value level this expression represents
&quot;scope&quot;: &quot;A String&quot;, # Project or folder to scope this config to. For example, &quot;project/456&quot; would apply this config only to resources in &quot;project/456&quot; scope will be checked with &quot;AND&quot; of other resources.
&quot;tagValues&quot;: [ # Required. Tag values combined with AND to check against. Values in the form &quot;tagValues/123&quot; E.g. [ &quot;tagValues/123&quot;, &quot;tagValues/456&quot;, &quot;tagValues/789&quot; ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was last updated.
},
],
}</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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing ResourceValueConfigs with new rules.
Args:
name: string, Name for the resource value config (required)
body: object, The request body.
The object takes the form of:
{ # A resource value config (RVC) is a mapping configuration of user&#x27;s resources to resource values. Used in Attack path simulations.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was created.
&quot;description&quot;: &quot;A String&quot;, # Description of the resource value config.
&quot;name&quot;: &quot;A String&quot;, # Name for the resource value config
&quot;resourceLabelsSelector&quot;: { # List of resource labels to search for, evaluated with AND. E.g. &quot;resource_labels_selector&quot;: {&quot;key&quot;: &quot;value&quot;, &quot;env&quot;: &quot;prod&quot;} will match resources with labels &quot;key&quot;: &quot;value&quot; AND &quot;env&quot;: &quot;prod&quot; https://cloud.google.com/resource-manager/docs/creating-managing-labels
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;resourceType&quot;: &quot;A String&quot;, # Apply resource_value only to resources that match resource_type. resource_type will be checked with &quot;AND&quot; of other resources. E.g. &quot;storage.googleapis.com/Bucket&quot; with resource_value &quot;HIGH&quot; will apply &quot;HIGH&quot; value only to &quot;storage.googleapis.com/Bucket&quot; resources.
&quot;resourceValue&quot;: &quot;A String&quot;, # Required. Resource value level this expression represents
&quot;scope&quot;: &quot;A String&quot;, # Project or folder to scope this config to. For example, &quot;project/456&quot; would apply this config only to resources in &quot;project/456&quot; scope will be checked with &quot;AND&quot; of other resources.
&quot;tagValues&quot;: [ # Required. Tag values combined with AND to check against. Values in the form &quot;tagValues/123&quot; E.g. [ &quot;tagValues/123&quot;, &quot;tagValues/456&quot;, &quot;tagValues/789&quot; ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was last updated.
}
updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource value config (RVC) is a mapping configuration of user&#x27;s resources to resource values. Used in Attack path simulations.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was created.
&quot;description&quot;: &quot;A String&quot;, # Description of the resource value config.
&quot;name&quot;: &quot;A String&quot;, # Name for the resource value config
&quot;resourceLabelsSelector&quot;: { # List of resource labels to search for, evaluated with AND. E.g. &quot;resource_labels_selector&quot;: {&quot;key&quot;: &quot;value&quot;, &quot;env&quot;: &quot;prod&quot;} will match resources with labels &quot;key&quot;: &quot;value&quot; AND &quot;env&quot;: &quot;prod&quot; https://cloud.google.com/resource-manager/docs/creating-managing-labels
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;resourceType&quot;: &quot;A String&quot;, # Apply resource_value only to resources that match resource_type. resource_type will be checked with &quot;AND&quot; of other resources. E.g. &quot;storage.googleapis.com/Bucket&quot; with resource_value &quot;HIGH&quot; will apply &quot;HIGH&quot; value only to &quot;storage.googleapis.com/Bucket&quot; resources.
&quot;resourceValue&quot;: &quot;A String&quot;, # Required. Resource value level this expression represents
&quot;scope&quot;: &quot;A String&quot;, # Project or folder to scope this config to. For example, &quot;project/456&quot; would apply this config only to resources in &quot;project/456&quot; scope will be checked with &quot;AND&quot; of other resources.
&quot;tagValues&quot;: [ # Required. Tag values combined with AND to check against. Values in the form &quot;tagValues/123&quot; E.g. [ &quot;tagValues/123&quot;, &quot;tagValues/456&quot;, &quot;tagValues/789&quot; ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
&quot;A String&quot;,
],
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp this resource value config was last updated.
}</pre>
</div>
</body></html>