From 9d79a685e826b937ca8f4aa5e83fac3c940976c0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 12 Dec 2023 16:41:56 +0000 Subject: [PATCH] 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) --- ...ThreatDetectionSettings.customModules.html | 98 +- ...ectionSettings.effectiveCustomModules.html | 168 ++++ ....folders.eventThreatDetectionSettings.html | 13 +- docs/dyn/securitycenter_v1.folders.html | 5 + ...HealthAnalyticsSettings.customModules.html | 2 +- ...ThreatDetectionSettings.customModules.html | 98 +- ...ectionSettings.effectiveCustomModules.html | 168 ++++ ...izations.eventThreatDetectionSettings.html | 7 +- ...HealthAnalyticsSettings.customModules.html | 2 +- ...ThreatDetectionSettings.customModules.html | 98 +- ...ectionSettings.effectiveCustomModules.html | 168 ++++ ...projects.eventThreatDetectionSettings.html | 13 +- docs/dyn/securitycenter_v1.projects.html | 5 + ...HealthAnalyticsSettings.customModules.html | 2 +- .../documents/securitycenter.v1.json | 899 ++++++++++++++++-- .../documents/securitycenter.v1beta1.json | 2 +- .../documents/securitycenter.v1beta2.json | 2 +- 17 files changed, 1617 insertions(+), 133 deletions(-) create mode 100644 docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html create mode 100644 docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html create mode 100644 docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html index 55e14c82c0c..f50ce61f4ac 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html @@ -79,22 +79,28 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.

+

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

delete(name, x__xgafv=None)

-

Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.

+

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

get(name, x__xgafv=None)

-

Gets an ETD custom module. Retrieves the module at the given level.

+

Gets an Event Threat Detection custom module.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).

+

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

+

+ listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

+

+ listDescendant_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.

+

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

Method Details

close() @@ -103,14 +109,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.
+  
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
   parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
+{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
   "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
     "a_key": "", # Properties of the object.
   },
@@ -131,7 +138,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -147,7 +155,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.
+  
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
   name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
@@ -165,7 +173,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets an ETD custom module. Retrieves the module at the given level.
+  
Gets an Event Threat Detection custom module.
 
 Args:
   name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
@@ -177,7 +185,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -193,10 +202,10 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).
+  
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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 `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -207,9 +216,10 @@ 

Method Details

Returns: An object of the form: - { # Response for listing EventThreatDetectionCustomModules. + { # Response for listing Event Threat Detection custom modules. "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -226,6 +236,56 @@

Method Details

}
+
+ listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
+
+Args:
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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 `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` 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 current and descendant resident Event Threat Detection custom modules.
+  "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent.
+    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+      "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
+      "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+        "a_key": "", # Properties of the object.
+      },
+      "description": "A String", # The description for the module.
+      "displayName": "A String", # The human readable name to be displayed for the module.
+      "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
+      "lastEditor": "A String", # Output only. The editor the module was last updated by.
+      "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
+      "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
+      "updateTime": "A String", # Output only. The time the module was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listDescendant_next() +
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.
+        
+
+
list_next()
Retrieves the next page of results.
@@ -242,14 +302,15 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.
+  
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
 
 Args:
   name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
+{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
   "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
     "a_key": "", # Properties of the object.
   },
@@ -271,7 +332,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html new file mode 100644 index 00000000000..70c9e653298 --- /dev/null +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html @@ -0,0 +1,168 @@ + + + +

Security Command Center API . folders . eventThreatDetectionSettings . effectiveCustomModules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an effective Event Threat Detection custom module at the given level.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

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.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
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: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (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.
+  "config": { # Output only. Config for the effective module.
+    "a_key": "", # Properties of the object.
+  },
+  "description": "A String", # Output only. The description for the module.
+  "displayName": "A String", # Output only. The human readable name to be displayed for the module.
+  "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
+  "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
+  "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
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: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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.
+  "effectiveEventThreatDetectionCustomModules": [ # 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.
+      "config": { # Output only. Config for the effective module.
+        "a_key": "", # Properties of the object.
+      },
+      "description": "A String", # Output only. The description for the module.
+      "displayName": "A String", # Output only. The human readable name to be displayed for the module.
+      "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
+      "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
+      "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html index ab1a44e06e8..84325a9b542 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html @@ -79,12 +79,17 @@

Instance Methods

Returns the customModules Resource.

+

+ effectiveCustomModules() +

+

Returns the effectiveCustomModules Resource.

+

close()

Close httplib2 connections.

validateCustomModule(parent, body=None, x__xgafv=None)

-

Validates the given Event Threat Detection Custom Module.

+

Validates the given Event Threat Detection custom module.

Method Details

close() @@ -93,14 +98,14 @@

Method Details

validateCustomModule(parent, body=None, x__xgafv=None) -
Validates the given Event Threat Detection Custom Module.
+  
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: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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.
   "rawText": "A String", # Required. The raw text of the module's contents. Used to generate error messages.
   "type": "A String", # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
 }
@@ -113,7 +118,7 @@ 

Method Details

Returns: An object of the form: - { # Response to validating an Event Threat Detection Custom Module. + { # Response to validating an Event Threat Detection custom module. "errors": { # 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. "errors": [ { # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. diff --git a/docs/dyn/securitycenter_v1.folders.html b/docs/dyn/securitycenter_v1.folders.html index 858ea06e05d..24097c887b1 100644 --- a/docs/dyn/securitycenter_v1.folders.html +++ b/docs/dyn/securitycenter_v1.folders.html @@ -84,6 +84,11 @@

Instance Methods

Returns the bigQueryExports Resource.

+

+ eventThreatDetectionSettings() +

+

Returns the eventThreatDetectionSettings Resource.

+

findings()

diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index d25ee2e0c52..894c69b3225 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -470,7 +470,7 @@

Method Details

"updateTime": "A String", # 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 diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html index 8ef01278038..20e191522ae 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html @@ -79,22 +79,28 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates an Event Threat Detection custom module.

+

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

delete(name, x__xgafv=None)

-

Deletes an Event Threat Detection custom module.

+

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

get(name, x__xgafv=None)

Gets an Event Threat Detection custom module.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists Event Threat Detection custom modules.

+

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

+

+ listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

+

+ listDescendant_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates an Event Threat Detection custom module.

+

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

Method Details

close() @@ -103,14 +109,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an Event Threat Detection custom module.
+  
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
+{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
   "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
     "a_key": "", # Properties of the object.
   },
@@ -131,7 +138,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -147,10 +155,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an Event Threat Detection custom module.
+  
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -168,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -177,7 +185,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -193,10 +202,10 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists Event Threat Detection custom modules.
+  
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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 `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -209,7 +218,8 @@ 

Method Details

{ # Response for listing Event Threat Detection custom modules. "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -226,6 +236,56 @@

Method Details

}
+
+ listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
+
+Args:
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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 `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` 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 current and descendant resident Event Threat Detection custom modules.
+  "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent.
+    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+      "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
+      "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+        "a_key": "", # Properties of the object.
+      },
+      "description": "A String", # The description for the module.
+      "displayName": "A String", # The human readable name to be displayed for the module.
+      "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
+      "lastEditor": "A String", # Output only. The editor the module was last updated by.
+      "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
+      "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
+      "updateTime": "A String", # Output only. The time the module was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listDescendant_next() +
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.
+        
+
+
list_next()
Retrieves the next page of results.
@@ -242,14 +302,15 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an Event Threat Detection custom module.
+  
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
 
 Args:
   name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
+{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
   "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
     "a_key": "", # Properties of the object.
   },
@@ -271,7 +332,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html new file mode 100644 index 00000000000..56105527016 --- /dev/null +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html @@ -0,0 +1,168 @@ + + + +

Security Command Center API . organizations . eventThreatDetectionSettings . effectiveCustomModules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an effective Event Threat Detection custom module at the given level.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

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.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
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: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (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.
+  "config": { # Output only. Config for the effective module.
+    "a_key": "", # Properties of the object.
+  },
+  "description": "A String", # Output only. The description for the module.
+  "displayName": "A String", # Output only. The human readable name to be displayed for the module.
+  "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
+  "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
+  "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
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: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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.
+  "effectiveEventThreatDetectionCustomModules": [ # 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.
+      "config": { # Output only. Config for the effective module.
+        "a_key": "", # Properties of the object.
+      },
+      "description": "A String", # Output only. The description for the module.
+      "displayName": "A String", # Output only. The human readable name to be displayed for the module.
+      "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
+      "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
+      "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html index 2dafb60eab1..707f785b4ac 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html @@ -79,6 +79,11 @@

Instance Methods

Returns the customModules Resource.

+

+ effectiveCustomModules() +

+

Returns the effectiveCustomModules Resource.

+

close()

Close httplib2 connections.

@@ -96,7 +101,7 @@

Method Details

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: * "organizations/{organization}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html
index 4ebb637d5c8..cd1809e96c1 100644
--- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html
+++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html
@@ -470,7 +470,7 @@ 

Method Details

"updateTime": "A String", # 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 diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html index 47b82227cca..242871023fb 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html @@ -79,22 +79,28 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.

+

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

delete(name, x__xgafv=None)

-

Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.

+

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

get(name, x__xgafv=None)

-

Gets an ETD custom module. Retrieves the module at the given level.

+

Gets an Event Threat Detection custom module.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).

+

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

+

+ listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

+

+ listDescendant_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.

+

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

Method Details

close() @@ -103,14 +109,15 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an ETD custom module at the given level. Creating a module has a side-effect of creating modules at all descendants.
+  
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
   parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
+{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
   "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
     "a_key": "", # Properties of the object.
   },
@@ -131,7 +138,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -147,7 +155,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an ETD custom module. Deletion at resident level also deletes modules at all descendants. Deletion at any other level is not supported.
+  
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
   name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
@@ -165,7 +173,7 @@ 

Method Details

get(name, x__xgafv=None) -
Gets an ETD custom module. Retrieves the module at the given level.
+  
Gets an Event Threat Detection custom module.
 
 Args:
   name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
@@ -177,7 +185,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -193,10 +202,10 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists ETD custom modules. Retrieve all resident and inherited modules at the given level (no descendants).
+  
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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 `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -207,9 +216,10 @@ 

Method Details

Returns: An object of the form: - { # Response for listing EventThreatDetectionCustomModules. + { # Response for listing Event Threat Detection custom modules. "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, @@ -226,6 +236,56 @@

Method Details

}
+
+ listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
+
+Args:
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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 `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` 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 current and descendant resident Event Threat Detection custom modules.
+  "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent.
+    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+      "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
+      "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+        "a_key": "", # Properties of the object.
+      },
+      "description": "A String", # The description for the module.
+      "displayName": "A String", # The human readable name to be displayed for the module.
+      "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
+      "lastEditor": "A String", # Output only. The editor the module was last updated by.
+      "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
+      "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
+      "updateTime": "A String", # Output only. The time the module was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listDescendant_next() +
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.
+        
+
+
list_next()
Retrieves the next page of results.
@@ -242,14 +302,15 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an ETD custom module at the given level. All config fields can be updated when updating the module at resident level. Only enablement state can be updated when updating the module at inherited levels. Updating the module has a side-effect that it updates all descendants that are inherited from this module.
+  
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
 
 Args:
   name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
+{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
+  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
   "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
     "a_key": "", # Properties of the object.
   },
@@ -271,7 +332,8 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only. + { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. + "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html new file mode 100644 index 00000000000..dee9038897e --- /dev/null +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html @@ -0,0 +1,168 @@ + + + +

Security Command Center API . projects . eventThreatDetectionSettings . effectiveCustomModules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an effective Event Threat Detection custom module at the given level.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

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.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
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: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (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.
+  "config": { # Output only. Config for the effective module.
+    "a_key": "", # Properties of the object.
+  },
+  "description": "A String", # Output only. The description for the module.
+  "displayName": "A String", # Output only. The human readable name to be displayed for the module.
+  "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
+  "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
+  "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
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: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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.
+  "effectiveEventThreatDetectionCustomModules": [ # 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.
+      "config": { # Output only. Config for the effective module.
+        "a_key": "", # Properties of the object.
+      },
+      "description": "A String", # Output only. The description for the module.
+      "displayName": "A String", # Output only. The human readable name to be displayed for the module.
+      "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy.
+      "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".
+      "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html index b848a83b9ec..9f6a9590f0a 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html @@ -79,12 +79,17 @@

Instance Methods

Returns the customModules Resource.

+

+ effectiveCustomModules() +

+

Returns the effectiveCustomModules Resource.

+

close()

Close httplib2 connections.

validateCustomModule(parent, body=None, x__xgafv=None)

-

Validates the given Event Threat Detection Custom Module.

+

Validates the given Event Threat Detection custom module.

Method Details

close() @@ -93,14 +98,14 @@

Method Details

validateCustomModule(parent, body=None, x__xgafv=None) -
Validates the given Event Threat Detection Custom Module.
+  
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: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (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.
   "rawText": "A String", # Required. The raw text of the module's contents. Used to generate error messages.
   "type": "A String", # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
 }
@@ -113,7 +118,7 @@ 

Method Details

Returns: An object of the form: - { # Response to validating an Event Threat Detection Custom Module. + { # Response to validating an Event Threat Detection custom module. "errors": { # 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. "errors": [ { # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. diff --git a/docs/dyn/securitycenter_v1.projects.html b/docs/dyn/securitycenter_v1.projects.html index 5cbea666193..b0a42c1135a 100644 --- a/docs/dyn/securitycenter_v1.projects.html +++ b/docs/dyn/securitycenter_v1.projects.html @@ -84,6 +84,11 @@

Instance Methods

Returns the bigQueryExports Resource.

+

+ eventThreatDetectionSettings() +

+

Returns the eventThreatDetectionSettings Resource.

+

findings()

diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index 84b336616bd..bb8b6482360 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -470,7 +470,7 @@

Method Details

"updateTime": "A String", # 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 diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index ddb85507a7f..ef128c26481 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -402,6 +402,293 @@ } } }, + "eventThreatDetectionSettings": { + "methods": { + "validateCustomModule": { + "description": "Validates the given Event Threat Detection custom module.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings:validateCustomModule", + "httpMethod": "POST", + "id": "securitycenter.folders.eventThreatDetectionSettings.validateCustomModule", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:validateCustomModule", + "request": { + "$ref": "ValidateEventThreatDetectionCustomModuleRequest" + }, + "response": { + "$ref": "ValidateEventThreatDetectionCustomModuleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "customModules": { + "methods": { + "create": { + "description": "Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules", + "httpMethod": "POST", + "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules", + "request": { + "$ref": "EventThreatDetectionCustomModule" + }, + "response": { + "$ref": "EventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}", + "httpMethod": "DELETE", + "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Event Threat Detection custom module.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}", + "httpMethod": "GET", + "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules", + "httpMethod": "GET", + "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules", + "response": { + "$ref": "ListEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listDescendant": { + "description": "Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules:listDescendant", + "httpMethod": "GET", + "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.listDescendant", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules:listDescendant", + "response": { + "$ref": "ListDescendantEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}", + "httpMethod": "PATCH", + "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. If empty all mutable fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "EventThreatDetectionCustomModule" + }, + "response": { + "$ref": "EventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "effectiveCustomModules": { + "methods": { + "get": { + "description": "Gets an effective Event Threat Detection custom module at the given level.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}", + "httpMethod": "GET", + "id": "securitycenter.folders.eventThreatDetectionSettings.effectiveCustomModules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EffectiveEventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "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.", + "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules", + "httpMethod": "GET", + "id": "securitycenter.folders.eventThreatDetectionSettings.effectiveCustomModules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/effectiveCustomModules", + "response": { + "$ref": "ListEffectiveEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "findings": { "methods": { "bulkMute": { @@ -1011,7 +1298,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to update.", + "description": "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.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1834,7 +2121,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1857,7 +2144,7 @@ "customModules": { "methods": { "create": { - "description": "Creates an Event Threat Detection custom module.", + "description": "Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules", "httpMethod": "POST", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.create", @@ -1866,7 +2153,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1885,7 +2172,7 @@ ] }, "delete": { - "description": "Deletes an Event Threat Detection custom module.", + "description": "Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.delete", @@ -1894,7 +2181,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -1919,7 +2206,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -1935,7 +2222,7 @@ ] }, "list": { - "description": "Lists Event Threat Detection custom modules.", + "description": "Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.list", @@ -1955,7 +2242,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1970,8 +2257,44 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listDescendant": { + "description": "Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.", + "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules:listDescendant", + "httpMethod": "GET", + "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.listDescendant", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules:listDescendant", + "response": { + "$ref": "ListDescendantEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { - "description": "Updates an Event Threat Detection custom module.", + "description": "Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.patch", @@ -2005,6 +2328,71 @@ ] } } + }, + "effectiveCustomModules": { + "methods": { + "get": { + "description": "Gets an effective Event Threat Detection custom module at the given level.", + "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}", + "httpMethod": "GET", + "id": "securitycenter.organizations.eventThreatDetectionSettings.effectiveCustomModules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "location": "path", + "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EffectiveEventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "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.", + "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules", + "httpMethod": "GET", + "id": "securitycenter.organizations.eventThreatDetectionSettings.effectiveCustomModules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/effectiveCustomModules", + "response": { + "$ref": "ListEffectiveEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -2889,7 +3277,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to update.", + "description": "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.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4044,60 +4432,347 @@ "location": "query", "type": "integer" }, - "pageToken": { - "description": "A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.", - "location": "query", - "type": "string" + "pageToken": { + "description": "A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/bigQueryExports", + "response": { + "$ref": "ListBigQueryExportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a BigQuery export.", + "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", + "httpMethod": "PATCH", + "id": "securitycenter.projects.bigQueryExports.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", + "location": "path", + "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. If empty all mutable fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" + }, + "response": { + "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "eventThreatDetectionSettings": { + "methods": { + "validateCustomModule": { + "description": "Validates the given Event Threat Detection custom module.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings:validateCustomModule", + "httpMethod": "POST", + "id": "securitycenter.projects.eventThreatDetectionSettings.validateCustomModule", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:validateCustomModule", + "request": { + "$ref": "ValidateEventThreatDetectionCustomModuleRequest" + }, + "response": { + "$ref": "ValidateEventThreatDetectionCustomModuleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "customModules": { + "methods": { + "create": { + "description": "Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules", + "httpMethod": "POST", + "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules", + "request": { + "$ref": "EventThreatDetectionCustomModule" + }, + "response": { + "$ref": "EventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}", + "httpMethod": "DELETE", + "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Event Threat Detection custom module.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}", + "httpMethod": "GET", + "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules", + "httpMethod": "GET", + "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules", + "response": { + "$ref": "ListEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listDescendant": { + "description": "Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules:listDescendant", + "httpMethod": "GET", + "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.listDescendant", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customModules:listDescendant", + "response": { + "$ref": "ListDescendantEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" + "patch": { + "description": "Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}", + "httpMethod": "PATCH", + "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. If empty all mutable fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "EventThreatDetectionCustomModule" + }, + "response": { + "$ref": "EventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1/{+parent}/bigQueryExports", - "response": { - "$ref": "ListBigQueryExportsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "patch": { - "description": "Updates a BigQuery export.", - "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", - "httpMethod": "PATCH", - "id": "securitycenter.projects.bigQueryExports.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", - "location": "path", - "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", - "required": true, - "type": "string" + "effectiveCustomModules": { + "methods": { + "get": { + "description": "Gets an effective Event Threat Detection custom module at the given level.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}", + "httpMethod": "GET", + "id": "securitycenter.projects.eventThreatDetectionSettings.effectiveCustomModules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EffectiveEventThreatDetectionCustomModule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "updateMask": { - "description": "The list of fields to be updated. If empty all mutable fields will be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" + "list": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules", + "httpMethod": "GET", + "id": "securitycenter.projects.eventThreatDetectionSettings.effectiveCustomModules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "location": "path", + "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/effectiveCustomModules", + "response": { + "$ref": "ListEffectiveEventThreatDetectionCustomModulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" - }, - "response": { - "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } }, @@ -4710,7 +5385,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to update.", + "description": "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.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5135,7 +5810,7 @@ } } }, - "revision": "20231130", + "revision": "20231208", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6163,6 +6838,57 @@ }, "type": "object" }, + "EffectiveEventThreatDetectionCustomModule": { + "description": "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.", + "id": "EffectiveEventThreatDetectionCustomModule", + "properties": { + "config": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Config for the effective module.", + "readOnly": true, + "type": "object" + }, + "description": { + "description": "Output only. The description for the module.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The human readable name to be displayed for the module.", + "readOnly": true, + "type": "string" + }, + "enablementState": { + "description": "Output only. The effective state of enablement for the module at the given level of the hierarchy.", + "enum": [ + "ENABLEMENT_STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "Unspecified enablement state.", + "The module is enabled at the given level.", + "The module is disabled at the given level." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the effective ETD custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "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); }", "id": "Empty", @@ -6185,9 +6911,14 @@ "type": "object" }, "EventThreatDetectionCustomModule": { - "description": "Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.", + "description": "Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.", "id": "EventThreatDetectionCustomModule", "properties": { + "ancestorModule": { + "description": "Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.", + "readOnly": true, + "type": "string" + }, "config": { "additionalProperties": { "description": "Properties of the object.", @@ -6209,12 +6940,14 @@ "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", - "DISABLED" + "DISABLED", + "INHERITED" ], "enumDescriptions": [ "Unspecified enablement state.", "The module is enabled at the given level.", - "The module is disabled at the given level." + "The module is disabled at the given level.", + "When the enablement state is inherited." ], "type": "string" }, @@ -9882,6 +10615,24 @@ }, "type": "object" }, + "ListDescendantEventThreatDetectionCustomModulesResponse": { + "description": "Response for listing current and descendant resident Event Threat Detection custom modules.", + "id": "ListDescendantEventThreatDetectionCustomModulesResponse", + "properties": { + "eventThreatDetectionCustomModules": { + "description": "Custom modules belonging to the requested parent.", + "items": { + "$ref": "EventThreatDetectionCustomModule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListDescendantSecurityHealthAnalyticsCustomModulesResponse": { "description": "Response message for listing descendant Security Health Analytics custom modules.", "id": "ListDescendantSecurityHealthAnalyticsCustomModulesResponse", @@ -9900,6 +10651,24 @@ }, "type": "object" }, + "ListEffectiveEventThreatDetectionCustomModulesResponse": { + "description": "Response for listing EffectiveEventThreatDetectionCustomModules.", + "id": "ListEffectiveEventThreatDetectionCustomModulesResponse", + "properties": { + "effectiveEventThreatDetectionCustomModules": { + "description": "Effective custom modules belonging to the requested parent.", + "items": { + "$ref": "EffectiveEventThreatDetectionCustomModule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse": { "description": "Response message for listing effective Security Health Analytics custom modules.", "id": "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 9baf657454b..f5234e1dc81 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20231130", + "revision": "20231208", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 2c089e84eef..787de7bede1 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -1906,7 +1906,7 @@ } } }, - "revision": "20231130", + "revision": "20231208", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": {