Skip to content

Commit

Permalink
feat(securitycenter): update the api
Browse files Browse the repository at this point in the history
#### securitycenter:v1

The following keys were added:
- resources.folders.resources.eventThreatDetectionSettings.methods.validateCustomModule (Total Keys: 12)
- resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.create (Total Keys: 12)
- resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.delete (Total Keys: 11)
- resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.get (Total Keys: 11)
- resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.list (Total Keys: 32)
- resources.folders.resources.eventThreatDetectionSettings.resources.customModules.methods.patch (Total Keys: 15)
- resources.folders.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.get (Total Keys: 11)
- resources.folders.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.list (Total Keys: 16)
- resources.organizations.resources.eventThreatDetectionSettings.resources.customModules.methods.listDescendant (Total Keys: 16)
- resources.organizations.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.get (Total Keys: 11)
- resources.organizations.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.list (Total Keys: 16)
- resources.projects.resources.eventThreatDetectionSettings.methods.validateCustomModule (Total Keys: 12)
- resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.create (Total Keys: 12)
- resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.delete (Total Keys: 11)
- resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.get (Total Keys: 11)
- resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.list (Total Keys: 32)
- resources.projects.resources.eventThreatDetectionSettings.resources.customModules.methods.patch (Total Keys: 15)
- resources.projects.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.get (Total Keys: 11)
- resources.projects.resources.eventThreatDetectionSettings.resources.effectiveCustomModules.methods.list (Total Keys: 16)
- schemas.EffectiveEventThreatDetectionCustomModule (Total Keys: 13)
- schemas.EventThreatDetectionCustomModule.properties.ancestorModule (Total Keys: 2)
- schemas.ListDescendantEventThreatDetectionCustomModulesResponse (Total Keys: 5)
- schemas.ListEffectiveEventThreatDetectionCustomModulesResponse (Total Keys: 5)
  • Loading branch information
yoshi-automation committed Dec 12, 2023
1 parent a2c6f6f commit 9d79a68
Show file tree
Hide file tree
Showing 17 changed files with 1,617 additions and 133 deletions.

Large diffs are not rendered by default.

@@ -0,0 +1,168 @@
<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.folders.html">folders</a> . <a href="securitycenter_v1.folders.eventThreatDetectionSettings.html">eventThreatDetectionSettings</a> . <a href="securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html">effectiveCustomModules</a></h1>
<h2>Instance Methods</h2>
<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">Gets an effective Event Threat Detection custom module at the given level.</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 effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.</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>Gets an effective Event Threat Detection custom module at the given level.

Args:
name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * &quot;organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. * &quot;folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. * &quot;projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only.
&quot;config&quot;: { # Output only. Config for the effective module.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;description&quot;: &quot;A String&quot;, # Output only. The description for the module.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The human readable name to be displayed for the module.
&quot;enablementState&quot;: &quot;A String&quot;, # Output only. The effective state of enablement for the module at the given level of the hierarchy.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the effective ETD custom module. Its format is: * &quot;organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. * &quot;folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. * &quot;projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;.
&quot;type&quot;: &quot;A String&quot;, # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
}</pre>
</div>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

Args:
parent: string, Required. Name of the parent to list custom modules for. Its format is: * &quot;organizations/{organization}/eventThreatDetectionSettings&quot;. * &quot;folders/{folder}/eventThreatDetectionSettings&quot;. * &quot;projects/{project}/eventThreatDetectionSettings&quot;. (required)
pageSize: integer, The maximum number of modules 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 `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response for listing EffectiveEventThreatDetectionCustomModules.
&quot;effectiveEventThreatDetectionCustomModules&quot;: [ # Effective custom modules belonging to the requested parent.
{ # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only.
&quot;config&quot;: { # Output only. Config for the effective module.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;description&quot;: &quot;A String&quot;, # Output only. The description for the module.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The human readable name to be displayed for the module.
&quot;enablementState&quot;: &quot;A String&quot;, # Output only. The effective state of enablement for the module at the given level of the hierarchy.
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the effective ETD custom module. Its format is: * &quot;organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. * &quot;folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;. * &quot;projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}&quot;.
&quot;type&quot;: &quot;A String&quot;, # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
},
],
&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 omitted, there are no subsequent pages.
}</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>
Expand Up @@ -79,12 +79,17 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the customModules Resource.</p>

<p class="toc_element">
<code><a href="securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html">effectiveCustomModules()</a></code>
</p>
<p class="firstline">Returns the effectiveCustomModules 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="#validateCustomModule">validateCustomModule(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Validates the given Event Threat Detection Custom Module.</p>
<p class="firstline">Validates the given Event Threat Detection custom module.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
Expand All @@ -93,14 +98,14 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="validateCustomModule">validateCustomModule(parent, body=None, x__xgafv=None)</code>
<pre>Validates the given Event Threat Detection Custom Module.
<pre>Validates the given Event Threat Detection custom module.

Args:
parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * &quot;organizations/{organization}/eventThreatDetectionSettings&quot;. * &quot;folders/{folder}/eventThreatDetectionSettings&quot;. * &quot;projects/{project}/eventThreatDetectionSettings&quot;. (required)
body: object, The request body.
The object takes the form of:

{ # Request to validate an EventThreatDetectionCustomModule.
{ # Request to validate an Event Threat Detection custom module.
&quot;rawText&quot;: &quot;A String&quot;, # Required. The raw text of the module&#x27;s contents. Used to generate error messages.
&quot;type&quot;: &quot;A String&quot;, # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
}
Expand All @@ -113,7 +118,7 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # Response to validating an Event Threat Detection Custom Module.
{ # Response to validating an Event Threat Detection custom module.
&quot;errors&quot;: { # A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. # A list of errors returned by the validator. If the list is empty, there were no errors.
&quot;errors&quot;: [
{ # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.
Expand Down
5 changes: 5 additions & 0 deletions docs/dyn/securitycenter_v1.folders.html
Expand Up @@ -84,6 +84,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the bigQueryExports Resource.</p>

<p class="toc_element">
<code><a href="securitycenter_v1.folders.eventThreatDetectionSettings.html">eventThreatDetectionSettings()</a></code>
</p>
<p class="firstline">Returns the eventThreatDetectionSettings Resource.</p>

<p class="toc_element">
<code><a href="securitycenter_v1.folders.findings.html">findings()</a></code>
</p>
Expand Down
Expand Up @@ -470,7 +470,7 @@ <h3>Method Details</h3>
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which the custom module was last updated.
}

updateMask: string, The list of fields to update.
updateMask: string, The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down

0 comments on commit 9d79a68

Please sign in to comment.