class FoldersEventThreatDetectionSettingsCustomModules extends Resource (View source)

The "customModules" collection of methods.

Typical usage is:

 $securitycenterService = new Google\Service\SecurityCommandCenter(...);
 $customModules = $securitycenterService->folders_eventThreatDetectionSettings_customModules;

Methods

create(string $parent, EventThreatDetectionCustomModule $postBody, array $optParams = [])

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(string $name, array $optParams = [])

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. (customModules.delete)

get(string $name, array $optParams = [])

Gets an Event Threat Detection custom module. (customModules.get)

listFoldersEventThreatDetectionSettingsCustomModules(string $parent, array $optParams = [])

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(string $parent, array $optParams = [])

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

patch(string $name, EventThreatDetectionCustomModule $postBody, array $optParams = [])

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. (customModules.patch)

Details

EventThreatDetectionCustomModule create(string $parent, EventThreatDetectionCustomModule $postBody, array $optParams = [])

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.

(customModules.create)

Parameters

string $parent

Required. The new custom module's parent. Its format is: organizations/{organization}/eventThreatDetectionSettings. folders/{folder}/eventThreatDetectionSettings. * projects/{project}/eventThreatDetectionSettings.

EventThreatDetectionCustomModule $postBody
array $optParams

Optional parameters.

Return Value

EventThreatDetectionCustomModule

Exceptions

Exception

SecuritycenterEmpty delete(string $name, array $optParams = [])

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. (customModules.delete)

Parameters

string $name

Required. Name of the custom module to delete. Its format is: organizations/{organization}/eventThreatDetectionSettings/customModule s/{module}. folders/{folder}/eventThreatDetectionSettings/customModules/{module}. * projects/{project}/eventThreatDetectionSettings/customModules/{module}.

array $optParams

Optional parameters.

Return Value

SecuritycenterEmpty

Exceptions

Exception

EventThreatDetectionCustomModule get(string $name, array $optParams = [])

Gets an Event Threat Detection custom module. (customModules.get)

Parameters

string $name

Required. Name of the custom module to get. Its format is: organizations/{organization}/eventThreatDetectionSettings/customModule s/{module}. folders/{folder}/eventThreatDetectionSettings/customModules/{module}. * projects/{project}/eventThreatDetectionSettings/customModules/{module}.

array $optParams

Optional parameters.

Return Value

EventThreatDetectionCustomModule

Exceptions

Exception

ListEventThreatDetectionCustomModulesResponse listFoldersEventThreatDetectionSettingsCustomModules(string $parent, array $optParams = [])

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.

(customModules.listFoldersEventThreatDetectionSettingsCustomModules)

Parameters

string $parent

Required. Name of the parent to list custom modules under. Its format is: organizations/{organization}/eventThreatDetectionSettings. folders/{folder}/eventThreatDetectionSettings. * projects/{project}/eventThreatDetectionSettings.

array $optParams

Optional parameters.

Return Value

ListEventThreatDetectionCustomModulesResponse

Exceptions

Exception

ListDescendantEventThreatDetectionCustomModulesResponse listDescendant(string $parent, array $optParams = [])

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

Parameters

string $parent

Required. Name of the parent to list custom modules under. Its format is: organizations/{organization}/eventThreatDetectionSettings. folders/{folder}/eventThreatDetectionSettings. * projects/{project}/eventThreatDetectionSettings.

array $optParams

Optional parameters.

Return Value

ListDescendantEventThreatDetectionCustomModulesResponse

Exceptions

Exception

EventThreatDetectionCustomModule patch(string $name, EventThreatDetectionCustomModule $postBody, array $optParams = [])

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. (customModules.patch)

Parameters

string $name

Immutable. The resource name of the Event Threat Detection custom module. Its format is: organizations/{organization}/event ThreatDetectionSettings/customModules/{module}. folders/{folder}/eventThreatDetectionSettings/customModules/{module}. * projects/{project}/eventThreatDetectionSettings/customModules/{module}.

EventThreatDetectionCustomModule $postBody
array $optParams

Optional parameters.

Return Value

EventThreatDetectionCustomModule

Exceptions

Exception