Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9d79a68

Browse files
committedDec 12, 2023
feat(securitycenter): update the api
#### 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)
1 parent a2c6f6f commit 9d79a68

17 files changed

+1617
-133
lines changed
 

‎docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html

+80-18
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<html><body>
2+
<style>
3+
4+
body, 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+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, 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="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>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Gets an effective Event Threat Detection custom module at the given level.</p>
83+
<p class="toc_element">
84+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85+
<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>
86+
<p class="toc_element">
87+
<code><a href="#list_next">list_next()</a></code></p>
88+
<p class="firstline">Retrieves the next page of results.</p>
89+
<h3>Method Details</h3>
90+
<div class="method">
91+
<code class="details" id="close">close()</code>
92+
<pre>Close httplib2 connections.</pre>
93+
</div>
94+
95+
<div class="method">
96+
<code class="details" id="get">get(name, x__xgafv=None)</code>
97+
<pre>Gets an effective Event Threat Detection custom module at the given level.
98+
99+
Args:
100+
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)
101+
x__xgafv: string, V1 error format.
102+
Allowed values
103+
1 - v1 error format
104+
2 - v2 error format
105+
106+
Returns:
107+
An object of the form:
108+
109+
{ # 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.
110+
&quot;config&quot;: { # Output only. Config for the effective module.
111+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
112+
},
113+
&quot;description&quot;: &quot;A String&quot;, # Output only. The description for the module.
114+
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The human readable name to be displayed for the module.
115+
&quot;enablementState&quot;: &quot;A String&quot;, # Output only. The effective state of enablement for the module at the given level of the hierarchy.
116+
&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;.
117+
&quot;type&quot;: &quot;A String&quot;, # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
118+
}</pre>
119+
</div>
120+
121+
<div class="method">
122+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
123+
<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.
124+
125+
Args:
126+
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)
127+
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.
128+
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.
129+
x__xgafv: string, V1 error format.
130+
Allowed values
131+
1 - v1 error format
132+
2 - v2 error format
133+
134+
Returns:
135+
An object of the form:
136+
137+
{ # Response for listing EffectiveEventThreatDetectionCustomModules.
138+
&quot;effectiveEventThreatDetectionCustomModules&quot;: [ # Effective custom modules belonging to the requested parent.
139+
{ # 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.
140+
&quot;config&quot;: { # Output only. Config for the effective module.
141+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
142+
},
143+
&quot;description&quot;: &quot;A String&quot;, # Output only. The description for the module.
144+
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The human readable name to be displayed for the module.
145+
&quot;enablementState&quot;: &quot;A String&quot;, # Output only. The effective state of enablement for the module at the given level of the hierarchy.
146+
&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;.
147+
&quot;type&quot;: &quot;A String&quot;, # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
148+
},
149+
],
150+
&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.
151+
}</pre>
152+
</div>
153+
154+
<div class="method">
155+
<code class="details" id="list_next">list_next()</code>
156+
<pre>Retrieves the next page of results.
157+
158+
Args:
159+
previous_request: The request for the previous page. (required)
160+
previous_response: The response from the request for the previous page. (required)
161+
162+
Returns:
163+
A request object that you can call &#x27;execute()&#x27; on to request the next
164+
page. Returns None if there are no more items in the collection.
165+
</pre>
166+
</div>
167+
168+
</body></html>

‎docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html

+9-4
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,17 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the customModules Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html">effectiveCustomModules()</a></code>
84+
</p>
85+
<p class="firstline">Returns the effectiveCustomModules Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="#close">close()</a></code></p>
8489
<p class="firstline">Close httplib2 connections.</p>
8590
<p class="toc_element">
8691
<code><a href="#validateCustomModule">validateCustomModule(parent, body=None, x__xgafv=None)</a></code></p>
87-
<p class="firstline">Validates the given Event Threat Detection Custom Module.</p>
92+
<p class="firstline">Validates the given Event Threat Detection custom module.</p>
8893
<h3>Method Details</h3>
8994
<div class="method">
9095
<code class="details" id="close">close()</code>
@@ -93,14 +98,14 @@ <h3>Method Details</h3>
9398

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

98103
Args:
99104
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)
100105
body: object, The request body.
101106
The object takes the form of:
102107

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

116-
{ # Response to validating an Event Threat Detection Custom Module.
121+
{ # Response to validating an Event Threat Detection custom module.
117122
&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.
118123
&quot;errors&quot;: [
119124
{ # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.

‎docs/dyn/securitycenter_v1.folders.html

+5
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ <h2>Instance Methods</h2>
8484
</p>
8585
<p class="firstline">Returns the bigQueryExports Resource.</p>
8686

87+
<p class="toc_element">
88+
<code><a href="securitycenter_v1.folders.eventThreatDetectionSettings.html">eventThreatDetectionSettings()</a></code>
89+
</p>
90+
<p class="firstline">Returns the eventThreatDetectionSettings Resource.</p>
91+
8792
<p class="toc_element">
8893
<code><a href="securitycenter_v1.folders.findings.html">findings()</a></code>
8994
</p>

‎docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ <h3>Method Details</h3>
470470
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which the custom module was last updated.
471471
}
472472

473-
updateMask: string, The list of fields to update.
473+
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.
474474
x__xgafv: string, V1 error format.
475475
Allowed values
476476
1 - v1 error format

0 commit comments

Comments
 (0)
Please sign in to comment.