Google Cloud Security Center Management V1 Client - Class DeleteSecurityHealthAnalyticsCustomModuleRequest (0.2.7)

Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class DeleteSecurityHealthAnalyticsCustomModuleRequest.

Message for deleting a SecurityHealthAnalyticsCustomModule

Generated from protobuf message google.cloud.securitycentermanagement.v1.DeleteSecurityHealthAnalyticsCustomModuleRequest

Namespace

Google \ Cloud \ SecurityCenterManagement \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name of the SHA custom module. Its format is: * "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}". * "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}". * "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
↳ validate_only bool

Optional. When set to true, only validations (including IAM checks) will done for the request (module will not be deleted). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually delete the module could still fail because 1. the state could have changed (e.g. IAM permission lost) or 2. A failure occurred while trying to delete the module.

getName

Required. The resource name of the SHA custom module.

Its format is:

  • "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
  • "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
  • "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
Returns
Type Description
string

setName

Required. The resource name of the SHA custom module.

Its format is:

  • "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
  • "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
  • "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. When set to true, only validations (including IAM checks) will done for the request (module will not be deleted). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually delete the module could still fail because 1. the state could have changed (e.g. IAM permission lost) or

  1. A failure occurred while trying to delete the module.
Returns
Type Description
bool

setValidateOnly

Optional. When set to true, only validations (including IAM checks) will done for the request (module will not be deleted). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually delete the module could still fail because 1. the state could have changed (e.g. IAM permission lost) or

  1. A failure occurred while trying to delete the module.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the SHA custom module.

Its format is:

  • "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
  • "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
  • "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}". Please see Google\Cloud\SecurityCenterManagement\V1\SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName() for help formatting this field.
Returns
Type Description
Google\Cloud\SecurityCenterManagement\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest