1. class
  2. Google
  3. \
  4. Service
  5. \
  6. SecurityCommandCenter
  7. \
  8. Resource
  9. \
  10. ProjectsSecurityHealthAnalyticsSettingsCustomModules

ProjectsSecurityHealthAnalyticsSettingsCustomModules

class ProjectsSecurityHealthAnalyticsSettingsCustomModules extends Resource (View source)

The "customModules" collection of methods.

Typical usage is:

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

Methods

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

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default. (customModules.create)

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

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules. (customModules.delete)

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

Retrieves a SecurityHealthAnalyticsCustomModule. (customModules.get)

ListSecurityHealthAnalyticsCustomModulesResponse
listProjectsSecurityHealthAnalyticsSettingsCustomModules(string $parent, array $optParams = [])

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

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

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

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

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only. (customModules.patch)

SimulateSecurityHealthAnalyticsCustomModuleResponse
simulate(string $parent, SimulateSecurityHealthAnalyticsCustomModuleRequest $postBody, array $optParams = [])

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

Details

at line 53
GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule create(string $parent, GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule $postBody, array $optParams = [])

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default. (customModules.create)

Parameters

string $parent

Required. Resource name of the new custom module's parent. Its format is organizations/{organization}/securityHealthAnalyticsSettings, folders/{folder}/securityHealthAnalyticsSettings, or projects/{project}/securityHealthAnalyticsSettings
GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule

Exceptions

Exception

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

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM 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}/securityHealthAnalyticsSettings/customModule s/{customModule}, folders/{folder}/securityHealthAnalyticsSettings/customMo dules/{customModule}, or projects/{project}/securityHealthAnalyticsSettings /customModules/{customModule}
array $optParams

Optional parameters.

Return Value

SecuritycenterEmpty

Exceptions

Exception

at line 91
GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule get(string $name, array $optParams = [])

Retrieves a SecurityHealthAnalyticsCustomModule. (customModules.get)

Parameters

string $name

Required. Name of the custom module to get. Its format is organizations/{organization}/securityHealthAnalyticsSettings/customModules/{ customModule}, folders/{folder}/securityHealthAnalyticsSettings/customModul es/{customModule}, or projects/{project}/securityHealthAnalyticsSettings/cu stomModules/{customModule}
array $optParams

Optional parameters.

Return Value

GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule

Exceptions

Exception

at line 116
ListSecurityHealthAnalyticsCustomModulesResponse listProjectsSecurityHealthAnalyticsSettingsCustomModules(string $parent, array $optParams = [])

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

(customModules.listProjectsSecurityHealthAnalyticsSettingsCustomModules)

Parameters

string $parent

Required. Name of parent to list custom modules. Its format is organizations/{organization}/securityHealthAnalyticsSettings, folders/{folder}/securityHealthAnalyticsSettings, or projects/{project}/securityHealthAnalyticsSettings
array $optParams

Optional parameters.

Return Value

ListSecurityHealthAnalyticsCustomModulesResponse

Exceptions

Exception

at line 141
ListDescendantSecurityHealthAnalyticsCustomModulesResponse listDescendant(string $parent, array $optParams = [])

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

(customModules.listDescendant)

Parameters

string $parent

Required. Name of parent to list descendant custom modules. Its format is organizations/{organization}/securityHealthAnalyticsSettings, folders/{folder}/securityHealthAnalyticsSettings, or projects/{project}/securityHealthAnalyticsSettings
array $optParams

Optional parameters.

Return Value

ListDescendantSecurityHealthAnalyticsCustomModulesResponse

Exceptions

Exception

at line 171
GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule patch(string $name, GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule $postBody, array $optParams = [])

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only. (customModules.patch)

Parameters

string $name

Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/custo mModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSetting s/customModules/{customModule}", or "projects/{project}/securityHealthAnalyti csSettings/customModules/{customModule}" The id {customModule} is server- generated and is not user settable. It will be a numeric id containing 1-20 digits.
GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule

Exceptions

Exception

at line 191
SimulateSecurityHealthAnalyticsCustomModuleResponse simulate(string $parent, SimulateSecurityHealthAnalyticsCustomModuleRequest $postBody, array $optParams = [])

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

(customModules.simulate)

Parameters

string $parent

Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see Relative Resource Name Example: organizations/{organization_id}
SimulateSecurityHealthAnalyticsCustomModuleRequest $postBody
array $optParams

Optional parameters.

Return Value

SimulateSecurityHealthAnalyticsCustomModuleResponse

Exceptions

Exception